5 [Differences versus the previous schema version](apidocs/aai_swagger_v13.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/v13/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/v13/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/v13/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/v13/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/v13/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/v13/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/v13/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/v13/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/v13/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/v13/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/v13/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/v13/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/v13/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/v13/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/v13/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/v13/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/v13/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/v13/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/v13/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/v13/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/v13/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/v13/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/v13/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/v13/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/v13/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/v13/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)
4359 $ref: "#/definitions/tenant"
4362 - CloudInfrastructure
4363 summary: update an existing tenant
4365 Update an existing tenant
4367 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4368 The PUT operation will entirely replace an existing object.
4369 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
4371 Other differences between PUT and PATCH are:
4373 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
4374 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4375 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4376 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
4385 description: Response codes found in [response codes](https://wiki.onap.org/).
4389 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4392 example: __CLOUD-OWNER__
4393 - name: cloud-region-id
4395 description: Identifier used by the vendor for the region. Second part of composite key
4398 example: __CLOUD-REGION-ID__
4401 description: Unique id relative to the cloud-region.
4404 example: __TENANT-ID__
4407 description: tenant object that needs to be updated.
4410 $ref: "#/patchDefinitions/tenant"
4413 - CloudInfrastructure
4414 summary: delete an existing tenant
4415 description: delete an existing tenant
4416 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
4425 description: Response codes found in [response codes](https://wiki.onap.org/).
4429 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4432 example: __CLOUD-OWNER__
4433 - name: cloud-region-id
4435 description: Identifier used by the vendor for the region. Second part of composite key
4438 example: __CLOUD-REGION-ID__
4441 description: Unique id relative to the cloud-region.
4444 example: __TENANT-ID__
4445 - name: resource-version
4447 description: resource-version for concurrency
4450 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants:
4453 - CloudInfrastructure
4454 summary: returns tenants
4455 description: returns tenants
4456 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenants
4462 description: successful operation
4464 $ref: "#/getDefinitions/tenants"
4466 description: Response codes found in [response codes](https://wiki.onap.org/).
4470 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4473 example: __CLOUD-OWNER__
4474 - name: cloud-region-id
4476 description: Identifier used by the vendor for the region. Second part of composite key
4479 example: __CLOUD-REGION-ID__
4490 - name: tenant-context
4495 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship:
4498 - CloudInfrastructure
4499 summary: see node definition for valid relationships
4500 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityRelationshipListRelationship
4509 description: Response codes found in [response codes](https://wiki.onap.org/).
4513 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4516 example: __CLOUD-OWNER__
4517 - name: cloud-region-id
4519 description: Identifier used by the vendor for the region. Second part of composite key
4522 example: __CLOUD-REGION-ID__
4525 description: Flavor id, expected to be unique across cloud-region.
4528 example: __FLAVOR-ID__
4529 - name: hpa-capability-id
4531 description: UUID to uniquely identify a HPA capability
4534 example: __HPA-CAPABILITY-ID__
4537 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json)
4540 $ref: "#/definitions/relationship"
4543 - CloudInfrastructure
4544 summary: delete an existing relationship
4545 description: delete an existing relationship
4546 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityRelationshipListRelationship
4555 description: Response codes found in [response codes](https://wiki.onap.org/).
4559 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4562 example: __CLOUD-OWNER__
4563 - name: cloud-region-id
4565 description: Identifier used by the vendor for the region. Second part of composite key
4568 example: __CLOUD-REGION-ID__
4571 description: Flavor id, expected to be unique across cloud-region.
4574 example: __FLAVOR-ID__
4575 - name: hpa-capability-id
4577 description: UUID to uniquely identify a HPA capability
4580 example: __HPA-CAPABILITY-ID__
4581 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/relationship-list/relationship:
4584 - CloudInfrastructure
4585 summary: see node definition for valid relationships
4586 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship
4595 description: Response codes found in [response codes](https://wiki.onap.org/).
4599 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4602 example: __CLOUD-OWNER__
4603 - name: cloud-region-id
4605 description: Identifier used by the vendor for the region. Second part of composite key
4608 example: __CLOUD-REGION-ID__
4611 description: Flavor id, expected to be unique across cloud-region.
4614 example: __FLAVOR-ID__
4615 - name: hpa-capability-id
4617 description: UUID to uniquely identify a HPA capability
4620 example: __HPA-CAPABILITY-ID__
4621 - name: hpa-attribute-key
4623 description: name of the specific HPA attribute
4626 example: __HPA-ATTRIBUTE-KEY__
4629 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json)
4632 $ref: "#/definitions/relationship"
4635 - CloudInfrastructure
4636 summary: delete an existing relationship
4637 description: delete an existing relationship
4638 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship
4647 description: Response codes found in [response codes](https://wiki.onap.org/).
4651 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4654 example: __CLOUD-OWNER__
4655 - name: cloud-region-id
4657 description: Identifier used by the vendor for the region. Second part of composite key
4660 example: __CLOUD-REGION-ID__
4663 description: Flavor id, expected to be unique across cloud-region.
4666 example: __FLAVOR-ID__
4667 - name: hpa-capability-id
4669 description: UUID to uniquely identify a HPA capability
4672 example: __HPA-CAPABILITY-ID__
4673 - name: hpa-attribute-key
4675 description: name of the specific HPA attribute
4678 example: __HPA-ATTRIBUTE-KEY__
4679 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}:
4682 - CloudInfrastructure
4683 summary: returns hpa-feature-attributes
4684 description: returns hpa-feature-attributes
4685 operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
4691 description: successful operation
4693 $ref: "#/getDefinitions/hpa-feature-attributes"
4695 description: Response codes found in [response codes](https://wiki.onap.org/).
4699 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4702 example: __CLOUD-OWNER__
4703 - name: cloud-region-id
4705 description: Identifier used by the vendor for the region. Second part of composite key
4708 example: __CLOUD-REGION-ID__
4711 description: Flavor id, expected to be unique across cloud-region.
4714 example: __FLAVOR-ID__
4715 - name: hpa-capability-id
4717 description: UUID to uniquely identify a HPA capability
4720 example: __HPA-CAPABILITY-ID__
4721 - name: hpa-attribute-key
4723 description: name of the specific HPA attribute
4726 example: __HPA-ATTRIBUTE-KEY__
4729 - CloudInfrastructure
4730 summary: create or update an existing hpa-feature-attributes
4732 Create or update an existing hpa-feature-attributes.
4734 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
4735 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
4744 description: Response codes found in [response codes](https://wiki.onap.org/).
4748 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4751 example: __CLOUD-OWNER__
4752 - name: cloud-region-id
4754 description: Identifier used by the vendor for the region. Second part of composite key
4757 example: __CLOUD-REGION-ID__
4760 description: Flavor id, expected to be unique across cloud-region.
4763 example: __FLAVOR-ID__
4764 - name: hpa-capability-id
4766 description: UUID to uniquely identify a HPA capability
4769 example: __HPA-CAPABILITY-ID__
4770 - name: hpa-attribute-key
4772 description: name of the specific HPA attribute
4775 example: __HPA-ATTRIBUTE-KEY__
4778 description: hpa-feature-attributes object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json)
4781 $ref: "#/definitions/hpa-feature-attributes"
4784 - CloudInfrastructure
4785 summary: update an existing hpa-feature-attributes
4787 Update an existing hpa-feature-attributes
4789 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4790 The PUT operation will entirely replace an existing object.
4791 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
4793 Other differences between PUT and PATCH are:
4795 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
4796 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4797 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4798 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
4807 description: Response codes found in [response codes](https://wiki.onap.org/).
4811 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4814 example: __CLOUD-OWNER__
4815 - name: cloud-region-id
4817 description: Identifier used by the vendor for the region. Second part of composite key
4820 example: __CLOUD-REGION-ID__
4823 description: Flavor id, expected to be unique across cloud-region.
4826 example: __FLAVOR-ID__
4827 - name: hpa-capability-id
4829 description: UUID to uniquely identify a HPA capability
4832 example: __HPA-CAPABILITY-ID__
4833 - name: hpa-attribute-key
4835 description: name of the specific HPA attribute
4838 example: __HPA-ATTRIBUTE-KEY__
4841 description: hpa-feature-attributes object that needs to be updated.
4844 $ref: "#/patchDefinitions/hpa-feature-attributes"
4847 - CloudInfrastructure
4848 summary: delete an existing hpa-feature-attributes
4849 description: delete an existing hpa-feature-attributes
4850 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
4859 description: Response codes found in [response codes](https://wiki.onap.org/).
4863 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4866 example: __CLOUD-OWNER__
4867 - name: cloud-region-id
4869 description: Identifier used by the vendor for the region. Second part of composite key
4872 example: __CLOUD-REGION-ID__
4875 description: Flavor id, expected to be unique across cloud-region.
4878 example: __FLAVOR-ID__
4879 - name: hpa-capability-id
4881 description: UUID to uniquely identify a HPA capability
4884 example: __HPA-CAPABILITY-ID__
4885 - name: hpa-attribute-key
4887 description: name of the specific HPA attribute
4890 example: __HPA-ATTRIBUTE-KEY__
4891 - name: resource-version
4893 description: resource-version for concurrency
4896 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}:
4899 - CloudInfrastructure
4900 summary: returns hpa-capability
4901 description: returns hpa-capability
4902 operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
4908 description: successful operation
4910 $ref: "#/getDefinitions/hpa-capability"
4912 description: Response codes found in [response codes](https://wiki.onap.org/).
4916 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4919 example: __CLOUD-OWNER__
4920 - name: cloud-region-id
4922 description: Identifier used by the vendor for the region. Second part of composite key
4925 example: __CLOUD-REGION-ID__
4928 description: Flavor id, expected to be unique across cloud-region.
4931 example: __FLAVOR-ID__
4932 - name: hpa-capability-id
4934 description: UUID to uniquely identify a HPA capability
4937 example: __HPA-CAPABILITY-ID__
4940 - CloudInfrastructure
4941 summary: create or update an existing hpa-capability
4943 Create or update an existing hpa-capability.
4945 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
4946 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
4955 description: Response codes found in [response codes](https://wiki.onap.org/).
4959 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4962 example: __CLOUD-OWNER__
4963 - name: cloud-region-id
4965 description: Identifier used by the vendor for the region. Second part of composite key
4968 example: __CLOUD-REGION-ID__
4971 description: Flavor id, expected to be unique across cloud-region.
4974 example: __FLAVOR-ID__
4975 - name: hpa-capability-id
4977 description: UUID to uniquely identify a HPA capability
4980 example: __HPA-CAPABILITY-ID__
4983 description: hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json)
4986 $ref: "#/definitions/hpa-capability"
4989 - CloudInfrastructure
4990 summary: update an existing hpa-capability
4992 Update an existing hpa-capability
4994 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4995 The PUT operation will entirely replace an existing object.
4996 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
4998 Other differences between PUT and PATCH are:
5000 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
5001 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5002 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5003 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
5012 description: Response codes found in [response codes](https://wiki.onap.org/).
5016 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5019 example: __CLOUD-OWNER__
5020 - name: cloud-region-id
5022 description: Identifier used by the vendor for the region. Second part of composite key
5025 example: __CLOUD-REGION-ID__
5028 description: Flavor id, expected to be unique across cloud-region.
5031 example: __FLAVOR-ID__
5032 - name: hpa-capability-id
5034 description: UUID to uniquely identify a HPA capability
5037 example: __HPA-CAPABILITY-ID__
5040 description: hpa-capability object that needs to be updated.
5043 $ref: "#/patchDefinitions/hpa-capability"
5046 - CloudInfrastructure
5047 summary: delete an existing hpa-capability
5048 description: delete an existing hpa-capability
5049 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
5058 description: Response codes found in [response codes](https://wiki.onap.org/).
5062 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5065 example: __CLOUD-OWNER__
5066 - name: cloud-region-id
5068 description: Identifier used by the vendor for the region. Second part of composite key
5071 example: __CLOUD-REGION-ID__
5074 description: Flavor id, expected to be unique across cloud-region.
5077 example: __FLAVOR-ID__
5078 - name: hpa-capability-id
5080 description: UUID to uniquely identify a HPA capability
5083 example: __HPA-CAPABILITY-ID__
5084 - name: resource-version
5086 description: resource-version for concurrency
5089 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities:
5092 - CloudInfrastructure
5093 summary: returns hpa-capabilities
5094 description: returns hpa-capabilities
5095 operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilities
5101 description: successful operation
5103 $ref: "#/getDefinitions/hpa-capabilities"
5105 description: Response codes found in [response codes](https://wiki.onap.org/).
5109 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5112 example: __CLOUD-OWNER__
5113 - name: cloud-region-id
5115 description: Identifier used by the vendor for the region. Second part of composite key
5118 example: __CLOUD-REGION-ID__
5121 description: Flavor id, expected to be unique across cloud-region.
5124 example: __FLAVOR-ID__
5125 - name: hpa-capability-id
5135 - name: architecture
5140 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship:
5143 - CloudInfrastructure
5144 summary: see node definition for valid relationships
5145 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
5154 description: Response codes found in [response codes](https://wiki.onap.org/).
5158 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5161 example: __CLOUD-OWNER__
5162 - name: cloud-region-id
5164 description: Identifier used by the vendor for the region. Second part of composite key
5167 example: __CLOUD-REGION-ID__
5170 description: Flavor id, expected to be unique across cloud-region.
5173 example: __FLAVOR-ID__
5176 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
5179 $ref: "#/definitions/relationship"
5182 - CloudInfrastructure
5183 summary: delete an existing relationship
5184 description: delete an existing relationship
5185 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
5194 description: Response codes found in [response codes](https://wiki.onap.org/).
5198 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5201 example: __CLOUD-OWNER__
5202 - name: cloud-region-id
5204 description: Identifier used by the vendor for the region. Second part of composite key
5207 example: __CLOUD-REGION-ID__
5210 description: Flavor id, expected to be unique across cloud-region.
5213 example: __FLAVOR-ID__
5214 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}:
5217 - CloudInfrastructure
5218 summary: returns flavor
5219 description: returns flavor
5220 operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5226 description: successful operation
5228 $ref: "#/getDefinitions/flavor"
5230 description: Response codes found in [response codes](https://wiki.onap.org/).
5234 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5237 example: __CLOUD-OWNER__
5238 - name: cloud-region-id
5240 description: Identifier used by the vendor for the region. Second part of composite key
5243 example: __CLOUD-REGION-ID__
5246 description: Flavor id, expected to be unique across cloud-region.
5249 example: __FLAVOR-ID__
5252 - CloudInfrastructure
5253 summary: create or update an existing flavor
5255 Create or update an existing flavor.
5257 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
5258 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5267 description: Response codes found in [response codes](https://wiki.onap.org/).
5271 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5274 example: __CLOUD-OWNER__
5275 - name: cloud-region-id
5277 description: Identifier used by the vendor for the region. Second part of composite key
5280 example: __CLOUD-REGION-ID__
5283 description: Flavor id, expected to be unique across cloud-region.
5286 example: __FLAVOR-ID__
5289 description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
5292 $ref: "#/definitions/flavor"
5295 - CloudInfrastructure
5296 summary: update an existing flavor
5298 Update an existing flavor
5300 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5301 The PUT operation will entirely replace an existing object.
5302 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
5304 Other differences between PUT and PATCH are:
5306 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
5307 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5308 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5309 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5318 description: Response codes found in [response codes](https://wiki.onap.org/).
5322 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5325 example: __CLOUD-OWNER__
5326 - name: cloud-region-id
5328 description: Identifier used by the vendor for the region. Second part of composite key
5331 example: __CLOUD-REGION-ID__
5334 description: Flavor id, expected to be unique across cloud-region.
5337 example: __FLAVOR-ID__
5340 description: flavor object that needs to be updated.
5343 $ref: "#/patchDefinitions/flavor"
5346 - CloudInfrastructure
5347 summary: delete an existing flavor
5348 description: delete an existing flavor
5349 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5358 description: Response codes found in [response codes](https://wiki.onap.org/).
5362 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5365 example: __CLOUD-OWNER__
5366 - name: cloud-region-id
5368 description: Identifier used by the vendor for the region. Second part of composite key
5371 example: __CLOUD-REGION-ID__
5374 description: Flavor id, expected to be unique across cloud-region.
5377 example: __FLAVOR-ID__
5378 - name: resource-version
5380 description: resource-version for concurrency
5383 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors:
5386 - CloudInfrastructure
5387 summary: returns flavors
5388 description: returns flavors
5389 operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavors
5395 description: successful operation
5397 $ref: "#/getDefinitions/flavors"
5399 description: Response codes found in [response codes](https://wiki.onap.org/).
5403 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5406 example: __CLOUD-OWNER__
5407 - name: cloud-region-id
5409 description: Identifier used by the vendor for the region. Second part of composite key
5412 example: __CLOUD-REGION-ID__
5423 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship:
5426 - CloudInfrastructure
5427 summary: see node definition for valid relationships
5428 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
5437 description: Response codes found in [response codes](https://wiki.onap.org/).
5441 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5444 example: __CLOUD-OWNER__
5445 - name: cloud-region-id
5447 description: Identifier used by the vendor for the region. Second part of composite key
5450 example: __CLOUD-REGION-ID__
5453 description: Group id, expected to be unique across cloud-region.
5456 example: __GROUP-ID__
5459 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
5462 $ref: "#/definitions/relationship"
5465 - CloudInfrastructure
5466 summary: delete an existing relationship
5467 description: delete an existing relationship
5468 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
5477 description: Response codes found in [response codes](https://wiki.onap.org/).
5481 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5484 example: __CLOUD-OWNER__
5485 - name: cloud-region-id
5487 description: Identifier used by the vendor for the region. Second part of composite key
5490 example: __CLOUD-REGION-ID__
5493 description: Group id, expected to be unique across cloud-region.
5496 example: __GROUP-ID__
5497 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}:
5500 - CloudInfrastructure
5501 summary: returns group-assignment
5502 description: returns group-assignment
5503 operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5509 description: successful operation
5511 $ref: "#/getDefinitions/group-assignment"
5513 description: Response codes found in [response codes](https://wiki.onap.org/).
5517 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5520 example: __CLOUD-OWNER__
5521 - name: cloud-region-id
5523 description: Identifier used by the vendor for the region. Second part of composite key
5526 example: __CLOUD-REGION-ID__
5529 description: Group id, expected to be unique across cloud-region.
5532 example: __GROUP-ID__
5535 - CloudInfrastructure
5536 summary: create or update an existing group-assignment
5538 Create or update an existing group-assignment.
5540 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
5541 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5550 description: Response codes found in [response codes](https://wiki.onap.org/).
5554 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5557 example: __CLOUD-OWNER__
5558 - name: cloud-region-id
5560 description: Identifier used by the vendor for the region. Second part of composite key
5563 example: __CLOUD-REGION-ID__
5566 description: Group id, expected to be unique across cloud-region.
5569 example: __GROUP-ID__
5572 description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
5575 $ref: "#/definitions/group-assignment"
5578 - CloudInfrastructure
5579 summary: update an existing group-assignment
5581 Update an existing group-assignment
5583 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5584 The PUT operation will entirely replace an existing object.
5585 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
5587 Other differences between PUT and PATCH are:
5589 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
5590 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5591 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5592 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5601 description: Response codes found in [response codes](https://wiki.onap.org/).
5605 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5608 example: __CLOUD-OWNER__
5609 - name: cloud-region-id
5611 description: Identifier used by the vendor for the region. Second part of composite key
5614 example: __CLOUD-REGION-ID__
5617 description: Group id, expected to be unique across cloud-region.
5620 example: __GROUP-ID__
5623 description: group-assignment object that needs to be updated.
5626 $ref: "#/patchDefinitions/group-assignment"
5629 - CloudInfrastructure
5630 summary: delete an existing group-assignment
5631 description: delete an existing group-assignment
5632 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5641 description: Response codes found in [response codes](https://wiki.onap.org/).
5645 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5648 example: __CLOUD-OWNER__
5649 - name: cloud-region-id
5651 description: Identifier used by the vendor for the region. Second part of composite key
5654 example: __CLOUD-REGION-ID__
5657 description: Group id, expected to be unique across cloud-region.
5660 example: __GROUP-ID__
5661 - name: resource-version
5663 description: resource-version for concurrency
5666 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments:
5669 - CloudInfrastructure
5670 summary: returns group-assignments
5671 description: returns group-assignments
5672 operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments
5678 description: successful operation
5680 $ref: "#/getDefinitions/group-assignments"
5682 description: Response codes found in [response codes](https://wiki.onap.org/).
5686 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5689 example: __CLOUD-OWNER__
5690 - name: cloud-region-id
5692 description: Identifier used by the vendor for the region. Second part of composite key
5695 example: __CLOUD-REGION-ID__
5711 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship:
5714 - CloudInfrastructure
5715 summary: see node definition for valid relationships
5716 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5725 description: Response codes found in [response codes](https://wiki.onap.org/).
5729 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5732 example: __CLOUD-OWNER__
5733 - name: cloud-region-id
5735 description: Identifier used by the vendor for the region. Second part of composite key
5738 example: __CLOUD-REGION-ID__
5741 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5744 example: __SNAPSHOT-ID__
5747 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
5750 $ref: "#/definitions/relationship"
5753 - CloudInfrastructure
5754 summary: delete an existing relationship
5755 description: delete an existing relationship
5756 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5765 description: Response codes found in [response codes](https://wiki.onap.org/).
5769 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5772 example: __CLOUD-OWNER__
5773 - name: cloud-region-id
5775 description: Identifier used by the vendor for the region. Second part of composite key
5778 example: __CLOUD-REGION-ID__
5781 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5784 example: __SNAPSHOT-ID__
5785 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}:
5788 - CloudInfrastructure
5789 summary: returns snapshot
5790 description: returns snapshot
5791 operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5797 description: successful operation
5799 $ref: "#/getDefinitions/snapshot"
5801 description: Response codes found in [response codes](https://wiki.onap.org/).
5805 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5808 example: __CLOUD-OWNER__
5809 - name: cloud-region-id
5811 description: Identifier used by the vendor for the region. Second part of composite key
5814 example: __CLOUD-REGION-ID__
5817 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5820 example: __SNAPSHOT-ID__
5823 - CloudInfrastructure
5824 summary: create or update an existing snapshot
5826 Create or update an existing snapshot.
5828 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
5829 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5838 description: Response codes found in [response codes](https://wiki.onap.org/).
5842 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5845 example: __CLOUD-OWNER__
5846 - name: cloud-region-id
5848 description: Identifier used by the vendor for the region. Second part of composite key
5851 example: __CLOUD-REGION-ID__
5854 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5857 example: __SNAPSHOT-ID__
5860 description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
5863 $ref: "#/definitions/snapshot"
5866 - CloudInfrastructure
5867 summary: update an existing snapshot
5869 Update an existing snapshot
5871 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5872 The PUT operation will entirely replace an existing object.
5873 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
5875 Other differences between PUT and PATCH are:
5877 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
5878 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5879 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5880 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5889 description: Response codes found in [response codes](https://wiki.onap.org/).
5893 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5896 example: __CLOUD-OWNER__
5897 - name: cloud-region-id
5899 description: Identifier used by the vendor for the region. Second part of composite key
5902 example: __CLOUD-REGION-ID__
5905 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5908 example: __SNAPSHOT-ID__
5911 description: snapshot object that needs to be updated.
5914 $ref: "#/patchDefinitions/snapshot"
5917 - CloudInfrastructure
5918 summary: delete an existing snapshot
5919 description: delete an existing snapshot
5920 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5929 description: Response codes found in [response codes](https://wiki.onap.org/).
5933 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5936 example: __CLOUD-OWNER__
5937 - name: cloud-region-id
5939 description: Identifier used by the vendor for the region. Second part of composite key
5942 example: __CLOUD-REGION-ID__
5945 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5948 example: __SNAPSHOT-ID__
5949 - name: resource-version
5951 description: resource-version for concurrency
5954 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots:
5957 - CloudInfrastructure
5958 summary: returns snapshots
5959 description: returns snapshots
5960 operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots
5966 description: successful operation
5968 $ref: "#/getDefinitions/snapshots"
5970 description: Response codes found in [response codes](https://wiki.onap.org/).
5974 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5977 example: __CLOUD-OWNER__
5978 - name: cloud-region-id
5980 description: Identifier used by the vendor for the region. Second part of composite key
5983 example: __CLOUD-REGION-ID__
5989 - name: snapshot-name
5999 - name: application-vendor
6004 - name: application-version
6009 - name: prev-snapshot-id
6014 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship:
6017 - CloudInfrastructure
6018 summary: see node definition for valid relationships
6019 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
6028 description: Response codes found in [response codes](https://wiki.onap.org/).
6032 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6035 example: __CLOUD-OWNER__
6036 - name: cloud-region-id
6038 description: Identifier used by the vendor for the region. Second part of composite key
6041 example: __CLOUD-REGION-ID__
6044 description: Image id, expected to be unique across cloud region
6047 example: __IMAGE-ID__
6050 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
6053 $ref: "#/definitions/relationship"
6056 - CloudInfrastructure
6057 summary: delete an existing relationship
6058 description: delete an existing relationship
6059 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
6068 description: Response codes found in [response codes](https://wiki.onap.org/).
6072 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6075 example: __CLOUD-OWNER__
6076 - name: cloud-region-id
6078 description: Identifier used by the vendor for the region. Second part of composite key
6081 example: __CLOUD-REGION-ID__
6084 description: Image id, expected to be unique across cloud region
6087 example: __IMAGE-ID__
6088 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}:
6091 - CloudInfrastructure
6092 summary: returns metadatum
6093 description: returns metadatum
6094 operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6100 description: successful operation
6102 $ref: "#/getDefinitions/metadatum"
6104 description: Response codes found in [response codes](https://wiki.onap.org/).
6108 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6111 example: __CLOUD-OWNER__
6112 - name: cloud-region-id
6114 description: Identifier used by the vendor for the region. Second part of composite key
6117 example: __CLOUD-REGION-ID__
6120 description: Image id, expected to be unique across cloud region
6123 example: __IMAGE-ID__
6128 example: __METANAME__
6131 - CloudInfrastructure
6132 summary: create or update an existing metadatum
6134 Create or update an existing metadatum.
6136 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6137 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6146 description: Response codes found in [response codes](https://wiki.onap.org/).
6150 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6153 example: __CLOUD-OWNER__
6154 - name: cloud-region-id
6156 description: Identifier used by the vendor for the region. Second part of composite key
6159 example: __CLOUD-REGION-ID__
6162 description: Image id, expected to be unique across cloud region
6165 example: __IMAGE-ID__
6170 example: __METANAME__
6173 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)
6176 $ref: "#/definitions/metadatum"
6179 - CloudInfrastructure
6180 summary: update an existing metadatum
6182 Update an existing metadatum
6184 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6185 The PUT operation will entirely replace an existing object.
6186 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6188 Other differences between PUT and PATCH are:
6190 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6191 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6192 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6193 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6202 description: Response codes found in [response codes](https://wiki.onap.org/).
6206 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6209 example: __CLOUD-OWNER__
6210 - name: cloud-region-id
6212 description: Identifier used by the vendor for the region. Second part of composite key
6215 example: __CLOUD-REGION-ID__
6218 description: Image id, expected to be unique across cloud region
6221 example: __IMAGE-ID__
6226 example: __METANAME__
6229 description: metadatum object that needs to be updated.
6232 $ref: "#/patchDefinitions/metadatum"
6235 - CloudInfrastructure
6236 summary: delete an existing metadatum
6237 description: delete an existing metadatum
6238 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6247 description: Response codes found in [response codes](https://wiki.onap.org/).
6251 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6254 example: __CLOUD-OWNER__
6255 - name: cloud-region-id
6257 description: Identifier used by the vendor for the region. Second part of composite key
6260 example: __CLOUD-REGION-ID__
6263 description: Image id, expected to be unique across cloud region
6266 example: __IMAGE-ID__
6271 example: __METANAME__
6272 - name: resource-version
6274 description: resource-version for concurrency
6277 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata:
6280 - CloudInfrastructure
6281 summary: returns metadata
6282 description: returns metadata
6283 operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata
6289 description: successful operation
6291 $ref: "#/getDefinitions/metadata"
6293 description: Response codes found in [response codes](https://wiki.onap.org/).
6297 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6300 example: __CLOUD-OWNER__
6301 - name: cloud-region-id
6303 description: Identifier used by the vendor for the region. Second part of composite key
6306 example: __CLOUD-REGION-ID__
6309 description: Image id, expected to be unique across cloud region
6312 example: __IMAGE-ID__
6318 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}:
6321 - CloudInfrastructure
6322 summary: returns image
6323 description: returns image
6324 operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImage
6330 description: successful operation
6332 $ref: "#/getDefinitions/image"
6334 description: Response codes found in [response codes](https://wiki.onap.org/).
6338 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6341 example: __CLOUD-OWNER__
6342 - name: cloud-region-id
6344 description: Identifier used by the vendor for the region. Second part of composite key
6347 example: __CLOUD-REGION-ID__
6350 description: Image id, expected to be unique across cloud region
6353 example: __IMAGE-ID__
6356 - CloudInfrastructure
6357 summary: create or update an existing image
6359 Create or update an existing image.
6361 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6362 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
6371 description: Response codes found in [response codes](https://wiki.onap.org/).
6375 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6378 example: __CLOUD-OWNER__
6379 - name: cloud-region-id
6381 description: Identifier used by the vendor for the region. Second part of composite key
6384 example: __CLOUD-REGION-ID__
6387 description: Image id, expected to be unique across cloud region
6390 example: __IMAGE-ID__
6393 description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
6396 $ref: "#/definitions/image"
6399 - CloudInfrastructure
6400 summary: update an existing image
6402 Update an existing image
6404 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6405 The PUT operation will entirely replace an existing object.
6406 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6408 Other differences between PUT and PATCH are:
6410 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6411 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6412 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6413 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
6422 description: Response codes found in [response codes](https://wiki.onap.org/).
6426 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6429 example: __CLOUD-OWNER__
6430 - name: cloud-region-id
6432 description: Identifier used by the vendor for the region. Second part of composite key
6435 example: __CLOUD-REGION-ID__
6438 description: Image id, expected to be unique across cloud region
6441 example: __IMAGE-ID__
6444 description: image object that needs to be updated.
6447 $ref: "#/patchDefinitions/image"
6450 - CloudInfrastructure
6451 summary: delete an existing image
6452 description: delete an existing image
6453 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage
6462 description: Response codes found in [response codes](https://wiki.onap.org/).
6466 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6469 example: __CLOUD-OWNER__
6470 - name: cloud-region-id
6472 description: Identifier used by the vendor for the region. Second part of composite key
6475 example: __CLOUD-REGION-ID__
6478 description: Image id, expected to be unique across cloud region
6481 example: __IMAGE-ID__
6482 - name: resource-version
6484 description: resource-version for concurrency
6487 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images:
6490 - CloudInfrastructure
6491 summary: returns images
6492 description: returns images
6493 operationId: getCloudInfrastructureCloudRegionsCloudRegionImages
6499 description: successful operation
6501 $ref: "#/getDefinitions/images"
6503 description: Response codes found in [response codes](https://wiki.onap.org/).
6507 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6510 example: __CLOUD-OWNER__
6511 - name: cloud-region-id
6513 description: Identifier used by the vendor for the region. Second part of composite key
6516 example: __CLOUD-REGION-ID__
6532 - name: application-vendor
6537 - name: application-version
6542 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship:
6545 - CloudInfrastructure
6546 summary: see node definition for valid relationships
6547 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
6556 description: Response codes found in [response codes](https://wiki.onap.org/).
6560 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6563 example: __CLOUD-OWNER__
6564 - name: cloud-region-id
6566 description: Identifier used by the vendor for the region. Second part of composite key
6569 example: __CLOUD-REGION-ID__
6572 description: DVS switch name
6575 example: __SWITCH-NAME__
6578 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
6581 $ref: "#/definitions/relationship"
6584 - CloudInfrastructure
6585 summary: delete an existing relationship
6586 description: delete an existing relationship
6587 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
6596 description: Response codes found in [response codes](https://wiki.onap.org/).
6600 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6603 example: __CLOUD-OWNER__
6604 - name: cloud-region-id
6606 description: Identifier used by the vendor for the region. Second part of composite key
6609 example: __CLOUD-REGION-ID__
6612 description: DVS switch name
6615 example: __SWITCH-NAME__
6616 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}:
6619 - CloudInfrastructure
6620 summary: returns dvs-switch
6621 description: returns dvs-switch
6622 operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6628 description: successful operation
6630 $ref: "#/getDefinitions/dvs-switch"
6632 description: Response codes found in [response codes](https://wiki.onap.org/).
6636 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6639 example: __CLOUD-OWNER__
6640 - name: cloud-region-id
6642 description: Identifier used by the vendor for the region. Second part of composite key
6645 example: __CLOUD-REGION-ID__
6648 description: DVS switch name
6651 example: __SWITCH-NAME__
6654 - CloudInfrastructure
6655 summary: create or update an existing dvs-switch
6657 Create or update an existing dvs-switch.
6659 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6660 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6669 description: Response codes found in [response codes](https://wiki.onap.org/).
6673 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6676 example: __CLOUD-OWNER__
6677 - name: cloud-region-id
6679 description: Identifier used by the vendor for the region. Second part of composite key
6682 example: __CLOUD-REGION-ID__
6685 description: DVS switch name
6688 example: __SWITCH-NAME__
6691 description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
6694 $ref: "#/definitions/dvs-switch"
6697 - CloudInfrastructure
6698 summary: update an existing dvs-switch
6700 Update an existing dvs-switch
6702 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6703 The PUT operation will entirely replace an existing object.
6704 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6706 Other differences between PUT and PATCH are:
6708 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6709 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6710 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6711 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6720 description: Response codes found in [response codes](https://wiki.onap.org/).
6724 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6727 example: __CLOUD-OWNER__
6728 - name: cloud-region-id
6730 description: Identifier used by the vendor for the region. Second part of composite key
6733 example: __CLOUD-REGION-ID__
6736 description: DVS switch name
6739 example: __SWITCH-NAME__
6742 description: dvs-switch object that needs to be updated.
6745 $ref: "#/patchDefinitions/dvs-switch"
6748 - CloudInfrastructure
6749 summary: delete an existing dvs-switch
6750 description: delete an existing dvs-switch
6751 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6760 description: Response codes found in [response codes](https://wiki.onap.org/).
6764 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6767 example: __CLOUD-OWNER__
6768 - name: cloud-region-id
6770 description: Identifier used by the vendor for the region. Second part of composite key
6773 example: __CLOUD-REGION-ID__
6776 description: DVS switch name
6779 example: __SWITCH-NAME__
6780 - name: resource-version
6782 description: resource-version for concurrency
6785 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches:
6788 - CloudInfrastructure
6789 summary: returns dvs-switches
6790 description: returns dvs-switches
6791 operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches
6797 description: successful operation
6799 $ref: "#/getDefinitions/dvs-switches"
6801 description: Response codes found in [response codes](https://wiki.onap.org/).
6805 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6808 example: __CLOUD-OWNER__
6809 - name: cloud-region-id
6811 description: Identifier used by the vendor for the region. Second part of composite key
6814 example: __CLOUD-REGION-ID__
6825 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship:
6828 - CloudInfrastructure
6829 summary: see node definition for valid relationships
6830 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
6839 description: Response codes found in [response codes](https://wiki.onap.org/).
6843 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6846 example: __CLOUD-OWNER__
6847 - name: cloud-region-id
6849 description: Identifier used by the vendor for the region. Second part of composite key
6852 example: __CLOUD-REGION-ID__
6853 - name: network-uuid
6855 description: UUID of the network. Unique across a cloud-region
6858 example: __NETWORK-UUID__
6861 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
6864 $ref: "#/definitions/relationship"
6867 - CloudInfrastructure
6868 summary: delete an existing relationship
6869 description: delete an existing relationship
6870 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
6879 description: Response codes found in [response codes](https://wiki.onap.org/).
6883 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6886 example: __CLOUD-OWNER__
6887 - name: cloud-region-id
6889 description: Identifier used by the vendor for the region. Second part of composite key
6892 example: __CLOUD-REGION-ID__
6893 - name: network-uuid
6895 description: UUID of the network. Unique across a cloud-region
6898 example: __NETWORK-UUID__
6899 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}:
6902 - CloudInfrastructure
6903 summary: returns oam-network
6904 description: returns oam-network
6905 operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6911 description: successful operation
6913 $ref: "#/getDefinitions/oam-network"
6915 description: Response codes found in [response codes](https://wiki.onap.org/).
6919 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6922 example: __CLOUD-OWNER__
6923 - name: cloud-region-id
6925 description: Identifier used by the vendor for the region. Second part of composite key
6928 example: __CLOUD-REGION-ID__
6929 - name: network-uuid
6931 description: UUID of the network. Unique across a cloud-region
6934 example: __NETWORK-UUID__
6937 - CloudInfrastructure
6938 summary: create or update an existing oam-network
6940 Create or update an existing oam-network.
6942 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6943 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6952 description: Response codes found in [response codes](https://wiki.onap.org/).
6956 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6959 example: __CLOUD-OWNER__
6960 - name: cloud-region-id
6962 description: Identifier used by the vendor for the region. Second part of composite key
6965 example: __CLOUD-REGION-ID__
6966 - name: network-uuid
6968 description: UUID of the network. Unique across a cloud-region
6971 example: __NETWORK-UUID__
6974 description: oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
6977 $ref: "#/definitions/oam-network"
6980 - CloudInfrastructure
6981 summary: update an existing oam-network
6983 Update an existing oam-network
6985 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6986 The PUT operation will entirely replace an existing object.
6987 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6989 Other differences between PUT and PATCH are:
6991 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6992 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6993 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6994 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7003 description: Response codes found in [response codes](https://wiki.onap.org/).
7007 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7010 example: __CLOUD-OWNER__
7011 - name: cloud-region-id
7013 description: Identifier used by the vendor for the region. Second part of composite key
7016 example: __CLOUD-REGION-ID__
7017 - name: network-uuid
7019 description: UUID of the network. Unique across a cloud-region
7022 example: __NETWORK-UUID__
7025 description: oam-network object that needs to be updated.
7028 $ref: "#/patchDefinitions/oam-network"
7031 - CloudInfrastructure
7032 summary: delete an existing oam-network
7033 description: delete an existing oam-network
7034 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7043 description: Response codes found in [response codes](https://wiki.onap.org/).
7047 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7050 example: __CLOUD-OWNER__
7051 - name: cloud-region-id
7053 description: Identifier used by the vendor for the region. Second part of composite key
7056 example: __CLOUD-REGION-ID__
7057 - name: network-uuid
7059 description: UUID of the network. Unique across a cloud-region
7062 example: __NETWORK-UUID__
7063 - name: resource-version
7065 description: resource-version for concurrency
7068 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks:
7071 - CloudInfrastructure
7072 summary: returns oam-networks
7073 description: returns oam-networks
7074 operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworks
7080 description: successful operation
7082 $ref: "#/getDefinitions/oam-networks"
7084 description: Response codes found in [response codes](https://wiki.onap.org/).
7088 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7091 example: __CLOUD-OWNER__
7092 - name: cloud-region-id
7094 description: Identifier used by the vendor for the region. Second part of composite key
7097 example: __CLOUD-REGION-ID__
7098 - name: network-uuid
7103 - name: network-name
7114 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship:
7117 - CloudInfrastructure
7118 summary: see node definition for valid relationships
7119 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
7128 description: Response codes found in [response codes](https://wiki.onap.org/).
7132 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7135 example: __CLOUD-OWNER__
7136 - name: cloud-region-id
7138 description: Identifier used by the vendor for the region. Second part of composite key
7141 example: __CLOUD-REGION-ID__
7142 - name: availability-zone-name
7144 description: Name of the availability zone. Unique across a cloud region
7147 example: __AVAILABILITY-ZONE-NAME__
7150 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
7153 $ref: "#/definitions/relationship"
7156 - CloudInfrastructure
7157 summary: delete an existing relationship
7158 description: delete an existing relationship
7159 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
7168 description: Response codes found in [response codes](https://wiki.onap.org/).
7172 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7175 example: __CLOUD-OWNER__
7176 - name: cloud-region-id
7178 description: Identifier used by the vendor for the region. Second part of composite key
7181 example: __CLOUD-REGION-ID__
7182 - name: availability-zone-name
7184 description: Name of the availability zone. Unique across a cloud region
7187 example: __AVAILABILITY-ZONE-NAME__
7188 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}:
7191 - CloudInfrastructure
7192 summary: returns availability-zone
7193 description: returns availability-zone
7194 operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7200 description: successful operation
7202 $ref: "#/getDefinitions/availability-zone"
7204 description: Response codes found in [response codes](https://wiki.onap.org/).
7208 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7211 example: __CLOUD-OWNER__
7212 - name: cloud-region-id
7214 description: Identifier used by the vendor for the region. Second part of composite key
7217 example: __CLOUD-REGION-ID__
7218 - name: availability-zone-name
7220 description: Name of the availability zone. Unique across a cloud region
7223 example: __AVAILABILITY-ZONE-NAME__
7226 - CloudInfrastructure
7227 summary: create or update an existing availability-zone
7229 Create or update an existing availability-zone.
7231 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
7232 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7241 description: Response codes found in [response codes](https://wiki.onap.org/).
7245 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7248 example: __CLOUD-OWNER__
7249 - name: cloud-region-id
7251 description: Identifier used by the vendor for the region. Second part of composite key
7254 example: __CLOUD-REGION-ID__
7255 - name: availability-zone-name
7257 description: Name of the availability zone. Unique across a cloud region
7260 example: __AVAILABILITY-ZONE-NAME__
7263 description: availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
7266 $ref: "#/definitions/availability-zone"
7269 - CloudInfrastructure
7270 summary: update an existing availability-zone
7272 Update an existing availability-zone
7274 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7275 The PUT operation will entirely replace an existing object.
7276 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
7278 Other differences between PUT and PATCH are:
7280 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
7281 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7282 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7283 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7292 description: Response codes found in [response codes](https://wiki.onap.org/).
7296 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7299 example: __CLOUD-OWNER__
7300 - name: cloud-region-id
7302 description: Identifier used by the vendor for the region. Second part of composite key
7305 example: __CLOUD-REGION-ID__
7306 - name: availability-zone-name
7308 description: Name of the availability zone. Unique across a cloud region
7311 example: __AVAILABILITY-ZONE-NAME__
7314 description: availability-zone object that needs to be updated.
7317 $ref: "#/patchDefinitions/availability-zone"
7320 - CloudInfrastructure
7321 summary: delete an existing availability-zone
7322 description: delete an existing availability-zone
7323 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7332 description: Response codes found in [response codes](https://wiki.onap.org/).
7336 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7339 example: __CLOUD-OWNER__
7340 - name: cloud-region-id
7342 description: Identifier used by the vendor for the region. Second part of composite key
7345 example: __CLOUD-REGION-ID__
7346 - name: availability-zone-name
7348 description: Name of the availability zone. Unique across a cloud region
7351 example: __AVAILABILITY-ZONE-NAME__
7352 - name: resource-version
7354 description: resource-version for concurrency
7357 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones:
7360 - CloudInfrastructure
7361 summary: returns availability-zones
7362 description: returns availability-zones
7363 operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZones
7369 description: successful operation
7371 $ref: "#/getDefinitions/availability-zones"
7373 description: Response codes found in [response codes](https://wiki.onap.org/).
7377 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7380 example: __CLOUD-OWNER__
7381 - name: cloud-region-id
7383 description: Identifier used by the vendor for the region. Second part of composite key
7386 example: __CLOUD-REGION-ID__
7387 - name: availability-zone-name
7392 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship:
7395 - CloudInfrastructure
7396 summary: see node definition for valid relationships
7397 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
7406 description: Response codes found in [response codes](https://wiki.onap.org/).
7410 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7413 example: __CLOUD-OWNER__
7414 - name: cloud-region-id
7416 description: Identifier used by the vendor for the region. Second part of composite key
7419 example: __CLOUD-REGION-ID__
7422 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegion.json)
7425 $ref: "#/definitions/relationship"
7428 - CloudInfrastructure
7429 summary: delete an existing relationship
7430 description: delete an existing relationship
7431 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
7440 description: Response codes found in [response codes](https://wiki.onap.org/).
7444 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7447 example: __CLOUD-OWNER__
7448 - name: cloud-region-id
7450 description: Identifier used by the vendor for the region. Second part of composite key
7453 example: __CLOUD-REGION-ID__
7454 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship:
7457 - CloudInfrastructure
7458 summary: see node definition for valid relationships
7459 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship
7468 description: Response codes found in [response codes](https://wiki.onap.org/).
7472 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7475 example: __CLOUD-OWNER__
7476 - name: cloud-region-id
7478 description: Identifier used by the vendor for the region. Second part of composite key
7481 example: __CLOUD-REGION-ID__
7482 - name: vip-ipv4-address
7484 description: IP address
7487 example: __VIP-IPV4-ADDRESS__
7490 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)
7493 $ref: "#/definitions/relationship"
7496 - CloudInfrastructure
7497 summary: delete an existing relationship
7498 description: delete an existing relationship
7499 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship
7508 description: Response codes found in [response codes](https://wiki.onap.org/).
7512 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7515 example: __CLOUD-OWNER__
7516 - name: cloud-region-id
7518 description: Identifier used by the vendor for the region. Second part of composite key
7521 example: __CLOUD-REGION-ID__
7522 - name: vip-ipv4-address
7524 description: IP address
7527 example: __VIP-IPV4-ADDRESS__
7528 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}:
7531 - CloudInfrastructure
7532 summary: returns vip-ipv4-address-list
7533 description: returns vip-ipv4-address-list
7534 operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
7540 description: successful operation
7542 $ref: "#/getDefinitions/vip-ipv4-address-list"
7544 description: Response codes found in [response codes](https://wiki.onap.org/).
7548 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7551 example: __CLOUD-OWNER__
7552 - name: cloud-region-id
7554 description: Identifier used by the vendor for the region. Second part of composite key
7557 example: __CLOUD-REGION-ID__
7558 - name: vip-ipv4-address
7560 description: IP address
7563 example: __VIP-IPV4-ADDRESS__
7566 - CloudInfrastructure
7567 summary: create or update an existing vip-ipv4-address-list
7569 Create or update an existing vip-ipv4-address-list.
7571 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
7572 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
7581 description: Response codes found in [response codes](https://wiki.onap.org/).
7585 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7588 example: __CLOUD-OWNER__
7589 - name: cloud-region-id
7591 description: Identifier used by the vendor for the region. Second part of composite key
7594 example: __CLOUD-REGION-ID__
7595 - name: vip-ipv4-address
7597 description: IP address
7600 example: __VIP-IPV4-ADDRESS__
7603 description: vip-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)
7606 $ref: "#/definitions/vip-ipv4-address-list"
7609 - CloudInfrastructure
7610 summary: update an existing vip-ipv4-address-list
7612 Update an existing vip-ipv4-address-list
7614 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7615 The PUT operation will entirely replace an existing object.
7616 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
7618 Other differences between PUT and PATCH are:
7620 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
7621 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7622 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7623 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
7632 description: Response codes found in [response codes](https://wiki.onap.org/).
7636 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7639 example: __CLOUD-OWNER__
7640 - name: cloud-region-id
7642 description: Identifier used by the vendor for the region. Second part of composite key
7645 example: __CLOUD-REGION-ID__
7646 - name: vip-ipv4-address
7648 description: IP address
7651 example: __VIP-IPV4-ADDRESS__
7654 description: vip-ipv4-address-list object that needs to be updated.
7657 $ref: "#/patchDefinitions/vip-ipv4-address-list"
7660 - CloudInfrastructure
7661 summary: delete an existing vip-ipv4-address-list
7662 description: delete an existing vip-ipv4-address-list
7663 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
7672 description: Response codes found in [response codes](https://wiki.onap.org/).
7676 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7679 example: __CLOUD-OWNER__
7680 - name: cloud-region-id
7682 description: Identifier used by the vendor for the region. Second part of composite key
7685 example: __CLOUD-REGION-ID__
7686 - name: vip-ipv4-address
7688 description: IP address
7691 example: __VIP-IPV4-ADDRESS__
7692 - name: resource-version
7694 description: resource-version for concurrency
7697 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship:
7700 - CloudInfrastructure
7701 summary: see node definition for valid relationships
7702 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship
7711 description: Response codes found in [response codes](https://wiki.onap.org/).
7715 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7718 example: __CLOUD-OWNER__
7719 - name: cloud-region-id
7721 description: Identifier used by the vendor for the region. Second part of composite key
7724 example: __CLOUD-REGION-ID__
7725 - name: vip-ipv6-address
7727 description: IP address
7730 example: __VIP-IPV6-ADDRESS__
7733 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)
7736 $ref: "#/definitions/relationship"
7739 - CloudInfrastructure
7740 summary: delete an existing relationship
7741 description: delete an existing relationship
7742 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship
7751 description: Response codes found in [response codes](https://wiki.onap.org/).
7755 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7758 example: __CLOUD-OWNER__
7759 - name: cloud-region-id
7761 description: Identifier used by the vendor for the region. Second part of composite key
7764 example: __CLOUD-REGION-ID__
7765 - name: vip-ipv6-address
7767 description: IP address
7770 example: __VIP-IPV6-ADDRESS__
7771 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}:
7774 - CloudInfrastructure
7775 summary: returns vip-ipv6-address-list
7776 description: returns vip-ipv6-address-list
7777 operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
7783 description: successful operation
7785 $ref: "#/getDefinitions/vip-ipv6-address-list"
7787 description: Response codes found in [response codes](https://wiki.onap.org/).
7791 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7794 example: __CLOUD-OWNER__
7795 - name: cloud-region-id
7797 description: Identifier used by the vendor for the region. Second part of composite key
7800 example: __CLOUD-REGION-ID__
7801 - name: vip-ipv6-address
7803 description: IP address
7806 example: __VIP-IPV6-ADDRESS__
7809 - CloudInfrastructure
7810 summary: create or update an existing vip-ipv6-address-list
7812 Create or update an existing vip-ipv6-address-list.
7814 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
7815 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
7824 description: Response codes found in [response codes](https://wiki.onap.org/).
7828 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7831 example: __CLOUD-OWNER__
7832 - name: cloud-region-id
7834 description: Identifier used by the vendor for the region. Second part of composite key
7837 example: __CLOUD-REGION-ID__
7838 - name: vip-ipv6-address
7840 description: IP address
7843 example: __VIP-IPV6-ADDRESS__
7846 description: vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)
7849 $ref: "#/definitions/vip-ipv6-address-list"
7852 - CloudInfrastructure
7853 summary: update an existing vip-ipv6-address-list
7855 Update an existing vip-ipv6-address-list
7857 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7858 The PUT operation will entirely replace an existing object.
7859 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
7861 Other differences between PUT and PATCH are:
7863 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
7864 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7865 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7866 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
7875 description: Response codes found in [response codes](https://wiki.onap.org/).
7879 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7882 example: __CLOUD-OWNER__
7883 - name: cloud-region-id
7885 description: Identifier used by the vendor for the region. Second part of composite key
7888 example: __CLOUD-REGION-ID__
7889 - name: vip-ipv6-address
7891 description: IP address
7894 example: __VIP-IPV6-ADDRESS__
7897 description: vip-ipv6-address-list object that needs to be updated.
7900 $ref: "#/patchDefinitions/vip-ipv6-address-list"
7903 - CloudInfrastructure
7904 summary: delete an existing vip-ipv6-address-list
7905 description: delete an existing vip-ipv6-address-list
7906 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
7915 description: Response codes found in [response codes](https://wiki.onap.org/).
7919 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7922 example: __CLOUD-OWNER__
7923 - name: cloud-region-id
7925 description: Identifier used by the vendor for the region. Second part of composite key
7928 example: __CLOUD-REGION-ID__
7929 - name: vip-ipv6-address
7931 description: IP address
7934 example: __VIP-IPV6-ADDRESS__
7935 - name: resource-version
7937 description: resource-version for concurrency
7940 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship:
7943 - CloudInfrastructure
7944 summary: see node definition for valid relationships
7945 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityRelationshipListRelationship
7954 description: Response codes found in [response codes](https://wiki.onap.org/).
7958 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7961 example: __CLOUD-OWNER__
7962 - name: cloud-region-id
7964 description: Identifier used by the vendor for the region. Second part of composite key
7967 example: __CLOUD-REGION-ID__
7968 - name: hpa-capability-id
7970 description: UUID to uniquely identify a HPA capability
7973 example: __HPA-CAPABILITY-ID__
7976 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json)
7979 $ref: "#/definitions/relationship"
7982 - CloudInfrastructure
7983 summary: delete an existing relationship
7984 description: delete an existing relationship
7985 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityRelationshipListRelationship
7994 description: Response codes found in [response codes](https://wiki.onap.org/).
7998 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8001 example: __CLOUD-OWNER__
8002 - name: cloud-region-id
8004 description: Identifier used by the vendor for the region. Second part of composite key
8007 example: __CLOUD-REGION-ID__
8008 - name: hpa-capability-id
8010 description: UUID to uniquely identify a HPA capability
8013 example: __HPA-CAPABILITY-ID__
8014 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/relationship-list/relationship:
8017 - CloudInfrastructure
8018 summary: see node definition for valid relationships
8019 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship
8028 description: Response codes found in [response codes](https://wiki.onap.org/).
8032 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8035 example: __CLOUD-OWNER__
8036 - name: cloud-region-id
8038 description: Identifier used by the vendor for the region. Second part of composite key
8041 example: __CLOUD-REGION-ID__
8042 - name: hpa-capability-id
8044 description: UUID to uniquely identify a HPA capability
8047 example: __HPA-CAPABILITY-ID__
8048 - name: hpa-attribute-key
8050 description: name of the specific HPA attribute
8053 example: __HPA-ATTRIBUTE-KEY__
8056 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json)
8059 $ref: "#/definitions/relationship"
8062 - CloudInfrastructure
8063 summary: delete an existing relationship
8064 description: delete an existing relationship
8065 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship
8074 description: Response codes found in [response codes](https://wiki.onap.org/).
8078 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8081 example: __CLOUD-OWNER__
8082 - name: cloud-region-id
8084 description: Identifier used by the vendor for the region. Second part of composite key
8087 example: __CLOUD-REGION-ID__
8088 - name: hpa-capability-id
8090 description: UUID to uniquely identify a HPA capability
8093 example: __HPA-CAPABILITY-ID__
8094 - name: hpa-attribute-key
8096 description: name of the specific HPA attribute
8099 example: __HPA-ATTRIBUTE-KEY__
8100 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}:
8103 - CloudInfrastructure
8104 summary: returns hpa-feature-attributes
8105 description: returns hpa-feature-attributes
8106 operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
8112 description: successful operation
8114 $ref: "#/getDefinitions/hpa-feature-attributes"
8116 description: Response codes found in [response codes](https://wiki.onap.org/).
8120 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8123 example: __CLOUD-OWNER__
8124 - name: cloud-region-id
8126 description: Identifier used by the vendor for the region. Second part of composite key
8129 example: __CLOUD-REGION-ID__
8130 - name: hpa-capability-id
8132 description: UUID to uniquely identify a HPA capability
8135 example: __HPA-CAPABILITY-ID__
8136 - name: hpa-attribute-key
8138 description: name of the specific HPA attribute
8141 example: __HPA-ATTRIBUTE-KEY__
8144 - CloudInfrastructure
8145 summary: create or update an existing hpa-feature-attributes
8147 Create or update an existing hpa-feature-attributes.
8149 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8150 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
8159 description: Response codes found in [response codes](https://wiki.onap.org/).
8163 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8166 example: __CLOUD-OWNER__
8167 - name: cloud-region-id
8169 description: Identifier used by the vendor for the region. Second part of composite key
8172 example: __CLOUD-REGION-ID__
8173 - name: hpa-capability-id
8175 description: UUID to uniquely identify a HPA capability
8178 example: __HPA-CAPABILITY-ID__
8179 - name: hpa-attribute-key
8181 description: name of the specific HPA attribute
8184 example: __HPA-ATTRIBUTE-KEY__
8187 description: hpa-feature-attributes object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json)
8190 $ref: "#/definitions/hpa-feature-attributes"
8193 - CloudInfrastructure
8194 summary: update an existing hpa-feature-attributes
8196 Update an existing hpa-feature-attributes
8198 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8199 The PUT operation will entirely replace an existing object.
8200 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8202 Other differences between PUT and PATCH are:
8204 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8205 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8206 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8207 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
8216 description: Response codes found in [response codes](https://wiki.onap.org/).
8220 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8223 example: __CLOUD-OWNER__
8224 - name: cloud-region-id
8226 description: Identifier used by the vendor for the region. Second part of composite key
8229 example: __CLOUD-REGION-ID__
8230 - name: hpa-capability-id
8232 description: UUID to uniquely identify a HPA capability
8235 example: __HPA-CAPABILITY-ID__
8236 - name: hpa-attribute-key
8238 description: name of the specific HPA attribute
8241 example: __HPA-ATTRIBUTE-KEY__
8244 description: hpa-feature-attributes object that needs to be updated.
8247 $ref: "#/patchDefinitions/hpa-feature-attributes"
8250 - CloudInfrastructure
8251 summary: delete an existing hpa-feature-attributes
8252 description: delete an existing hpa-feature-attributes
8253 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
8262 description: Response codes found in [response codes](https://wiki.onap.org/).
8266 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8269 example: __CLOUD-OWNER__
8270 - name: cloud-region-id
8272 description: Identifier used by the vendor for the region. Second part of composite key
8275 example: __CLOUD-REGION-ID__
8276 - name: hpa-capability-id
8278 description: UUID to uniquely identify a HPA capability
8281 example: __HPA-CAPABILITY-ID__
8282 - name: hpa-attribute-key
8284 description: name of the specific HPA attribute
8287 example: __HPA-ATTRIBUTE-KEY__
8288 - name: resource-version
8290 description: resource-version for concurrency
8293 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}:
8296 - CloudInfrastructure
8297 summary: returns hpa-capability
8298 description: returns hpa-capability
8299 operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
8305 description: successful operation
8307 $ref: "#/getDefinitions/hpa-capability"
8309 description: Response codes found in [response codes](https://wiki.onap.org/).
8313 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8316 example: __CLOUD-OWNER__
8317 - name: cloud-region-id
8319 description: Identifier used by the vendor for the region. Second part of composite key
8322 example: __CLOUD-REGION-ID__
8323 - name: hpa-capability-id
8325 description: UUID to uniquely identify a HPA capability
8328 example: __HPA-CAPABILITY-ID__
8331 - CloudInfrastructure
8332 summary: create or update an existing hpa-capability
8334 Create or update an existing hpa-capability.
8336 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8337 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
8346 description: Response codes found in [response codes](https://wiki.onap.org/).
8350 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8353 example: __CLOUD-OWNER__
8354 - name: cloud-region-id
8356 description: Identifier used by the vendor for the region. Second part of composite key
8359 example: __CLOUD-REGION-ID__
8360 - name: hpa-capability-id
8362 description: UUID to uniquely identify a HPA capability
8365 example: __HPA-CAPABILITY-ID__
8368 description: hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json)
8371 $ref: "#/definitions/hpa-capability"
8374 - CloudInfrastructure
8375 summary: update an existing hpa-capability
8377 Update an existing hpa-capability
8379 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8380 The PUT operation will entirely replace an existing object.
8381 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8383 Other differences between PUT and PATCH are:
8385 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8386 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8387 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8388 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
8397 description: Response codes found in [response codes](https://wiki.onap.org/).
8401 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8404 example: __CLOUD-OWNER__
8405 - name: cloud-region-id
8407 description: Identifier used by the vendor for the region. Second part of composite key
8410 example: __CLOUD-REGION-ID__
8411 - name: hpa-capability-id
8413 description: UUID to uniquely identify a HPA capability
8416 example: __HPA-CAPABILITY-ID__
8419 description: hpa-capability object that needs to be updated.
8422 $ref: "#/patchDefinitions/hpa-capability"
8425 - CloudInfrastructure
8426 summary: delete an existing hpa-capability
8427 description: delete an existing hpa-capability
8428 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
8437 description: Response codes found in [response codes](https://wiki.onap.org/).
8441 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8444 example: __CLOUD-OWNER__
8445 - name: cloud-region-id
8447 description: Identifier used by the vendor for the region. Second part of composite key
8450 example: __CLOUD-REGION-ID__
8451 - name: hpa-capability-id
8453 description: UUID to uniquely identify a HPA capability
8456 example: __HPA-CAPABILITY-ID__
8457 - name: resource-version
8459 description: resource-version for concurrency
8462 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities:
8465 - CloudInfrastructure
8466 summary: returns hpa-capabilities
8467 description: returns hpa-capabilities
8468 operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilities
8474 description: successful operation
8476 $ref: "#/getDefinitions/hpa-capabilities"
8478 description: Response codes found in [response codes](https://wiki.onap.org/).
8482 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8485 example: __CLOUD-OWNER__
8486 - name: cloud-region-id
8488 description: Identifier used by the vendor for the region. Second part of composite key
8491 example: __CLOUD-REGION-ID__
8492 - name: hpa-capability-id
8502 - name: architecture
8507 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}:
8510 - CloudInfrastructure
8511 summary: returns cloud-region
8512 description: returns cloud-region
8513 operationId: getCloudInfrastructureCloudRegionsCloudRegion
8519 description: successful operation
8521 $ref: "#/getDefinitions/cloud-region"
8523 description: Response codes found in [response codes](https://wiki.onap.org/).
8527 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8530 example: __CLOUD-OWNER__
8531 - name: cloud-region-id
8533 description: Identifier used by the vendor for the region. Second part of composite key
8536 example: __CLOUD-REGION-ID__
8539 - CloudInfrastructure
8540 summary: create or update an existing cloud-region
8542 Create or update an existing cloud-region.
8544 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8545 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegion
8554 description: Response codes found in [response codes](https://wiki.onap.org/).
8558 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8561 example: __CLOUD-OWNER__
8562 - name: cloud-region-id
8564 description: Identifier used by the vendor for the region. Second part of composite key
8567 example: __CLOUD-REGION-ID__
8570 description: cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureCloudRegionsCloudRegion.json)
8573 $ref: "#/definitions/cloud-region"
8576 - CloudInfrastructure
8577 summary: update an existing cloud-region
8579 Update an existing cloud-region
8581 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8582 The PUT operation will entirely replace an existing object.
8583 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8585 Other differences between PUT and PATCH are:
8587 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8588 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8589 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8590 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegion
8599 description: Response codes found in [response codes](https://wiki.onap.org/).
8603 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8606 example: __CLOUD-OWNER__
8607 - name: cloud-region-id
8609 description: Identifier used by the vendor for the region. Second part of composite key
8612 example: __CLOUD-REGION-ID__
8615 description: cloud-region object that needs to be updated.
8618 $ref: "#/patchDefinitions/cloud-region"
8621 - CloudInfrastructure
8622 summary: delete an existing cloud-region
8623 description: delete an existing cloud-region
8624 operationId: deleteCloudInfrastructureCloudRegionsCloudRegion
8633 description: Response codes found in [response codes](https://wiki.onap.org/).
8637 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8640 example: __CLOUD-OWNER__
8641 - name: cloud-region-id
8643 description: Identifier used by the vendor for the region. Second part of composite key
8646 example: __CLOUD-REGION-ID__
8647 - name: resource-version
8649 description: resource-version for concurrency
8652 /cloud-infrastructure/cloud-regions:
8655 - CloudInfrastructure
8656 summary: returns cloud-regions
8657 description: returns cloud-regions
8658 operationId: getCloudInfrastructureCloudRegions
8664 description: successful operation
8666 $ref: "#/getDefinitions/cloud-regions"
8668 description: Response codes found in [response codes](https://wiki.onap.org/).
8675 - name: cloud-region-id
8685 - name: owner-defined-type
8690 /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship:
8693 - CloudInfrastructure
8694 summary: see node definition for valid relationships
8695 operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
8704 description: Response codes found in [response codes](https://wiki.onap.org/).
8706 - name: nm-profile-name
8708 description: Unique name of network profile.
8711 example: __NM-PROFILE-NAME__
8714 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureNetworkProfilesNetworkProfile.json)
8717 $ref: "#/definitions/relationship"
8720 - CloudInfrastructure
8721 summary: delete an existing relationship
8722 description: delete an existing relationship
8723 operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
8732 description: Response codes found in [response codes](https://wiki.onap.org/).
8734 - name: nm-profile-name
8736 description: Unique name of network profile.
8739 example: __NM-PROFILE-NAME__
8740 /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}:
8743 - CloudInfrastructure
8744 summary: returns network-profile
8745 description: returns network-profile
8746 operationId: getCloudInfrastructureNetworkProfilesNetworkProfile
8752 description: successful operation
8754 $ref: "#/getDefinitions/network-profile"
8756 description: Response codes found in [response codes](https://wiki.onap.org/).
8758 - name: nm-profile-name
8760 description: Unique name of network profile.
8763 example: __NM-PROFILE-NAME__
8766 - CloudInfrastructure
8767 summary: create or update an existing network-profile
8769 Create or update an existing network-profile.
8771 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8772 operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile
8781 description: Response codes found in [response codes](https://wiki.onap.org/).
8783 - name: nm-profile-name
8785 description: Unique name of network profile.
8788 example: __NM-PROFILE-NAME__
8791 description: network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureNetworkProfilesNetworkProfile.json)
8794 $ref: "#/definitions/network-profile"
8797 - CloudInfrastructure
8798 summary: update an existing network-profile
8800 Update an existing network-profile
8802 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8803 The PUT operation will entirely replace an existing object.
8804 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8806 Other differences between PUT and PATCH are:
8808 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8809 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8810 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8811 operationId: UpdateCloudInfrastructureNetworkProfilesNetworkProfile
8820 description: Response codes found in [response codes](https://wiki.onap.org/).
8822 - name: nm-profile-name
8824 description: Unique name of network profile.
8827 example: __NM-PROFILE-NAME__
8830 description: network-profile object that needs to be updated.
8833 $ref: "#/patchDefinitions/network-profile"
8836 - CloudInfrastructure
8837 summary: delete an existing network-profile
8838 description: delete an existing network-profile
8839 operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfile
8848 description: Response codes found in [response codes](https://wiki.onap.org/).
8850 - name: nm-profile-name
8852 description: Unique name of network profile.
8855 example: __NM-PROFILE-NAME__
8856 - name: resource-version
8858 description: resource-version for concurrency
8861 /cloud-infrastructure/network-profiles:
8864 - CloudInfrastructure
8865 summary: returns network-profiles
8866 description: returns network-profiles
8867 operationId: getCloudInfrastructureNetworkProfiles
8873 description: successful operation
8875 $ref: "#/getDefinitions/network-profiles"
8877 description: Response codes found in [response codes](https://wiki.onap.org/).
8879 - name: nm-profile-name
8884 /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship:
8887 - CloudInfrastructure
8888 summary: see node definition for valid relationships
8889 operationId: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship
8898 description: Response codes found in [response codes](https://wiki.onap.org/).
8902 description: Value from executing hostname on the compute node.
8905 example: __HOSTNAME__
8908 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserver.json)
8911 $ref: "#/definitions/relationship"
8914 - CloudInfrastructure
8915 summary: delete an existing relationship
8916 description: delete an existing relationship
8917 operationId: deleteCloudInfrastructurePserversPserverRelationshipListRelationship
8926 description: Response codes found in [response codes](https://wiki.onap.org/).
8930 description: Value from executing hostname on the compute node.
8933 example: __HOSTNAME__
8934 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
8937 - CloudInfrastructure
8938 summary: see node definition for valid relationships
8939 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
8948 description: Response codes found in [response codes](https://wiki.onap.org/).
8952 description: Value from executing hostname on the compute node.
8955 example: __HOSTNAME__
8956 - name: interface-name
8958 description: Name that identifies the physical interface
8961 example: __INTERFACE-NAME__
8964 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
8967 $ref: "#/definitions/relationship"
8970 - CloudInfrastructure
8971 summary: delete an existing relationship
8972 description: delete an existing relationship
8973 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
8982 description: Response codes found in [response codes](https://wiki.onap.org/).
8986 description: Value from executing hostname on the compute node.
8989 example: __HOSTNAME__
8990 - name: interface-name
8992 description: Name that identifies the physical interface
8995 example: __INTERFACE-NAME__
8996 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
8999 - CloudInfrastructure
9000 summary: see node definition for valid relationships
9001 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
9010 description: Response codes found in [response codes](https://wiki.onap.org/).
9014 description: Value from executing hostname on the compute node.
9017 example: __HOSTNAME__
9018 - name: interface-name
9020 description: Name that identifies the physical interface
9023 example: __INTERFACE-NAME__
9026 description: Identifier for the sriov-pf
9029 example: __PF-PCI-ID__
9032 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)
9035 $ref: "#/definitions/relationship"
9038 - CloudInfrastructure
9039 summary: delete an existing relationship
9040 description: delete an existing relationship
9041 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
9050 description: Response codes found in [response codes](https://wiki.onap.org/).
9054 description: Value from executing hostname on the compute node.
9057 example: __HOSTNAME__
9058 - name: interface-name
9060 description: Name that identifies the physical interface
9063 example: __INTERFACE-NAME__
9066 description: Identifier for the sriov-pf
9069 example: __PF-PCI-ID__
9070 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
9073 - CloudInfrastructure
9074 summary: returns sriov-pf
9075 description: returns sriov-pf
9076 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
9082 description: successful operation
9084 $ref: "#/getDefinitions/sriov-pf"
9086 description: Response codes found in [response codes](https://wiki.onap.org/).
9090 description: Value from executing hostname on the compute node.
9093 example: __HOSTNAME__
9094 - name: interface-name
9096 description: Name that identifies the physical interface
9099 example: __INTERFACE-NAME__
9102 description: Identifier for the sriov-pf
9105 example: __PF-PCI-ID__
9108 - CloudInfrastructure
9109 summary: create or update an existing sriov-pf
9111 Create or update an existing sriov-pf.
9113 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9114 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
9123 description: Response codes found in [response codes](https://wiki.onap.org/).
9127 description: Value from executing hostname on the compute node.
9130 example: __HOSTNAME__
9131 - name: interface-name
9133 description: Name that identifies the physical interface
9136 example: __INTERFACE-NAME__
9139 description: Identifier for the sriov-pf
9142 example: __PF-PCI-ID__
9145 description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)
9148 $ref: "#/definitions/sriov-pf"
9151 - CloudInfrastructure
9152 summary: update an existing sriov-pf
9154 Update an existing sriov-pf
9156 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9157 The PUT operation will entirely replace an existing object.
9158 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9160 Other differences between PUT and PATCH are:
9162 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9163 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9164 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9165 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
9174 description: Response codes found in [response codes](https://wiki.onap.org/).
9178 description: Value from executing hostname on the compute node.
9181 example: __HOSTNAME__
9182 - name: interface-name
9184 description: Name that identifies the physical interface
9187 example: __INTERFACE-NAME__
9190 description: Identifier for the sriov-pf
9193 example: __PF-PCI-ID__
9196 description: sriov-pf object that needs to be updated.
9199 $ref: "#/patchDefinitions/sriov-pf"
9202 - CloudInfrastructure
9203 summary: delete an existing sriov-pf
9204 description: delete an existing sriov-pf
9205 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
9214 description: Response codes found in [response codes](https://wiki.onap.org/).
9218 description: Value from executing hostname on the compute node.
9221 example: __HOSTNAME__
9222 - name: interface-name
9224 description: Name that identifies the physical interface
9227 example: __INTERFACE-NAME__
9230 description: Identifier for the sriov-pf
9233 example: __PF-PCI-ID__
9234 - name: resource-version
9236 description: resource-version for concurrency
9239 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
9242 - CloudInfrastructure
9243 summary: returns sriov-pfs
9244 description: returns sriov-pfs
9245 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfs
9251 description: successful operation
9253 $ref: "#/getDefinitions/sriov-pfs"
9255 description: Response codes found in [response codes](https://wiki.onap.org/).
9259 description: Value from executing hostname on the compute node.
9262 example: __HOSTNAME__
9263 - name: interface-name
9265 description: Name that identifies the physical interface
9268 example: __INTERFACE-NAME__
9274 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
9277 - CloudInfrastructure
9278 summary: see node definition for valid relationships
9279 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
9288 description: Response codes found in [response codes](https://wiki.onap.org/).
9292 description: Value from executing hostname on the compute node.
9295 example: __HOSTNAME__
9296 - name: interface-name
9298 description: Name that identifies the physical interface
9301 example: __INTERFACE-NAME__
9302 - name: interface-name
9304 description: Name given to the interface
9307 example: __INTERFACE-NAME__
9308 - name: vlan-interface
9310 description: String that identifies the interface
9313 example: __VLAN-INTERFACE__
9316 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
9319 $ref: "#/definitions/relationship"
9322 - CloudInfrastructure
9323 summary: delete an existing relationship
9324 description: delete an existing relationship
9325 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
9334 description: Response codes found in [response codes](https://wiki.onap.org/).
9338 description: Value from executing hostname on the compute node.
9341 example: __HOSTNAME__
9342 - name: interface-name
9344 description: Name that identifies the physical interface
9347 example: __INTERFACE-NAME__
9348 - name: interface-name
9350 description: Name given to the interface
9353 example: __INTERFACE-NAME__
9354 - name: vlan-interface
9356 description: String that identifies the interface
9359 example: __VLAN-INTERFACE__
9360 /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:
9363 - CloudInfrastructure
9364 summary: see node definition for valid relationships
9365 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
9374 description: Response codes found in [response codes](https://wiki.onap.org/).
9378 description: Value from executing hostname on the compute node.
9381 example: __HOSTNAME__
9382 - name: interface-name
9384 description: Name that identifies the physical interface
9387 example: __INTERFACE-NAME__
9388 - name: interface-name
9390 description: Name given to the interface
9393 example: __INTERFACE-NAME__
9394 - name: vlan-interface
9396 description: String that identifies the interface
9399 example: __VLAN-INTERFACE__
9400 - name: l3-interface-ipv4-address
9402 description: IP address
9405 example: __L3-INTERFACE-IPV4-ADDRESS__
9408 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
9411 $ref: "#/definitions/relationship"
9414 - CloudInfrastructure
9415 summary: delete an existing relationship
9416 description: delete an existing relationship
9417 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
9426 description: Response codes found in [response codes](https://wiki.onap.org/).
9430 description: Value from executing hostname on the compute node.
9433 example: __HOSTNAME__
9434 - name: interface-name
9436 description: Name that identifies the physical interface
9439 example: __INTERFACE-NAME__
9440 - name: interface-name
9442 description: Name given to the interface
9445 example: __INTERFACE-NAME__
9446 - name: vlan-interface
9448 description: String that identifies the interface
9451 example: __VLAN-INTERFACE__
9452 - name: l3-interface-ipv4-address
9454 description: IP address
9457 example: __L3-INTERFACE-IPV4-ADDRESS__
9458 /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}:
9461 - CloudInfrastructure
9462 summary: returns l3-interface-ipv4-address-list
9463 description: returns l3-interface-ipv4-address-list
9464 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9470 description: successful operation
9472 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
9474 description: Response codes found in [response codes](https://wiki.onap.org/).
9478 description: Value from executing hostname on the compute node.
9481 example: __HOSTNAME__
9482 - name: interface-name
9484 description: Name that identifies the physical interface
9487 example: __INTERFACE-NAME__
9488 - name: interface-name
9490 description: Name given to the interface
9493 example: __INTERFACE-NAME__
9494 - name: vlan-interface
9496 description: String that identifies the interface
9499 example: __VLAN-INTERFACE__
9500 - name: l3-interface-ipv4-address
9502 description: IP address
9505 example: __L3-INTERFACE-IPV4-ADDRESS__
9508 - CloudInfrastructure
9509 summary: create or update an existing l3-interface-ipv4-address-list
9511 Create or update an existing l3-interface-ipv4-address-list.
9513 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9514 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9523 description: Response codes found in [response codes](https://wiki.onap.org/).
9527 description: Value from executing hostname on the compute node.
9530 example: __HOSTNAME__
9531 - name: interface-name
9533 description: Name that identifies the physical interface
9536 example: __INTERFACE-NAME__
9537 - name: interface-name
9539 description: Name given to the interface
9542 example: __INTERFACE-NAME__
9543 - name: vlan-interface
9545 description: String that identifies the interface
9548 example: __VLAN-INTERFACE__
9549 - name: l3-interface-ipv4-address
9551 description: IP address
9554 example: __L3-INTERFACE-IPV4-ADDRESS__
9557 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
9560 $ref: "#/definitions/l3-interface-ipv4-address-list"
9563 - CloudInfrastructure
9564 summary: update an existing l3-interface-ipv4-address-list
9566 Update an existing l3-interface-ipv4-address-list
9568 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9569 The PUT operation will entirely replace an existing object.
9570 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9572 Other differences between PUT and PATCH are:
9574 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9575 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9576 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9577 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9586 description: Response codes found in [response codes](https://wiki.onap.org/).
9590 description: Value from executing hostname on the compute node.
9593 example: __HOSTNAME__
9594 - name: interface-name
9596 description: Name that identifies the physical interface
9599 example: __INTERFACE-NAME__
9600 - name: interface-name
9602 description: Name given to the interface
9605 example: __INTERFACE-NAME__
9606 - name: vlan-interface
9608 description: String that identifies the interface
9611 example: __VLAN-INTERFACE__
9612 - name: l3-interface-ipv4-address
9614 description: IP address
9617 example: __L3-INTERFACE-IPV4-ADDRESS__
9620 description: l3-interface-ipv4-address-list object that needs to be updated.
9623 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
9626 - CloudInfrastructure
9627 summary: delete an existing l3-interface-ipv4-address-list
9628 description: delete an existing l3-interface-ipv4-address-list
9629 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
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 physical interface
9651 example: __INTERFACE-NAME__
9652 - name: interface-name
9654 description: Name given to the interface
9657 example: __INTERFACE-NAME__
9658 - name: vlan-interface
9660 description: String that identifies the interface
9663 example: __VLAN-INTERFACE__
9664 - name: l3-interface-ipv4-address
9666 description: IP address
9669 example: __L3-INTERFACE-IPV4-ADDRESS__
9670 - name: resource-version
9672 description: resource-version for concurrency
9675 /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:
9678 - CloudInfrastructure
9679 summary: see node definition for valid relationships
9680 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
9689 description: Response codes found in [response codes](https://wiki.onap.org/).
9693 description: Value from executing hostname on the compute node.
9696 example: __HOSTNAME__
9697 - name: interface-name
9699 description: Name that identifies the physical interface
9702 example: __INTERFACE-NAME__
9703 - name: interface-name
9705 description: Name given to the interface
9708 example: __INTERFACE-NAME__
9709 - name: vlan-interface
9711 description: String that identifies the interface
9714 example: __VLAN-INTERFACE__
9715 - name: l3-interface-ipv6-address
9717 description: IP address
9720 example: __L3-INTERFACE-IPV6-ADDRESS__
9723 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
9726 $ref: "#/definitions/relationship"
9729 - CloudInfrastructure
9730 summary: delete an existing relationship
9731 description: delete an existing relationship
9732 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
9741 description: Response codes found in [response codes](https://wiki.onap.org/).
9745 description: Value from executing hostname on the compute node.
9748 example: __HOSTNAME__
9749 - name: interface-name
9751 description: Name that identifies the physical interface
9754 example: __INTERFACE-NAME__
9755 - name: interface-name
9757 description: Name given to the interface
9760 example: __INTERFACE-NAME__
9761 - name: vlan-interface
9763 description: String that identifies the interface
9766 example: __VLAN-INTERFACE__
9767 - name: l3-interface-ipv6-address
9769 description: IP address
9772 example: __L3-INTERFACE-IPV6-ADDRESS__
9773 /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}:
9776 - CloudInfrastructure
9777 summary: returns l3-interface-ipv6-address-list
9778 description: returns l3-interface-ipv6-address-list
9779 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
9785 description: successful operation
9787 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
9789 description: Response codes found in [response codes](https://wiki.onap.org/).
9793 description: Value from executing hostname on the compute node.
9796 example: __HOSTNAME__
9797 - name: interface-name
9799 description: Name that identifies the physical interface
9802 example: __INTERFACE-NAME__
9803 - name: interface-name
9805 description: Name given to the interface
9808 example: __INTERFACE-NAME__
9809 - name: vlan-interface
9811 description: String that identifies the interface
9814 example: __VLAN-INTERFACE__
9815 - name: l3-interface-ipv6-address
9817 description: IP address
9820 example: __L3-INTERFACE-IPV6-ADDRESS__
9823 - CloudInfrastructure
9824 summary: create or update an existing l3-interface-ipv6-address-list
9826 Create or update an existing l3-interface-ipv6-address-list.
9828 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9829 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
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 physical 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-ipv6-address
9866 description: IP address
9869 example: __L3-INTERFACE-IPV6-ADDRESS__
9872 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
9875 $ref: "#/definitions/l3-interface-ipv6-address-list"
9878 - CloudInfrastructure
9879 summary: update an existing l3-interface-ipv6-address-list
9881 Update an existing l3-interface-ipv6-address-list
9883 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9884 The PUT operation will entirely replace an existing object.
9885 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9887 Other differences between PUT and PATCH are:
9889 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9890 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9891 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9892 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
9901 description: Response codes found in [response codes](https://wiki.onap.org/).
9905 description: Value from executing hostname on the compute node.
9908 example: __HOSTNAME__
9909 - name: interface-name
9911 description: Name that identifies the physical interface
9914 example: __INTERFACE-NAME__
9915 - name: interface-name
9917 description: Name given to the interface
9920 example: __INTERFACE-NAME__
9921 - name: vlan-interface
9923 description: String that identifies the interface
9926 example: __VLAN-INTERFACE__
9927 - name: l3-interface-ipv6-address
9929 description: IP address
9932 example: __L3-INTERFACE-IPV6-ADDRESS__
9935 description: l3-interface-ipv6-address-list object that needs to be updated.
9938 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
9941 - CloudInfrastructure
9942 summary: delete an existing l3-interface-ipv6-address-list
9943 description: delete an existing l3-interface-ipv6-address-list
9944 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
9953 description: Response codes found in [response codes](https://wiki.onap.org/).
9957 description: Value from executing hostname on the compute node.
9960 example: __HOSTNAME__
9961 - name: interface-name
9963 description: Name that identifies the physical interface
9966 example: __INTERFACE-NAME__
9967 - name: interface-name
9969 description: Name given to the interface
9972 example: __INTERFACE-NAME__
9973 - name: vlan-interface
9975 description: String that identifies the interface
9978 example: __VLAN-INTERFACE__
9979 - name: l3-interface-ipv6-address
9981 description: IP address
9984 example: __L3-INTERFACE-IPV6-ADDRESS__
9985 - name: resource-version
9987 description: resource-version for concurrency
9990 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
9993 - CloudInfrastructure
9994 summary: returns vlan
9995 description: returns vlan
9996 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
10002 description: successful operation
10004 $ref: "#/getDefinitions/vlan"
10006 description: Response codes found in [response codes](https://wiki.onap.org/).
10010 description: Value from executing hostname on the compute node.
10013 example: __HOSTNAME__
10014 - name: interface-name
10016 description: Name that identifies the physical interface
10019 example: __INTERFACE-NAME__
10020 - name: interface-name
10022 description: Name given to the interface
10025 example: __INTERFACE-NAME__
10026 - name: vlan-interface
10028 description: String that identifies the interface
10031 example: __VLAN-INTERFACE__
10034 - CloudInfrastructure
10035 summary: create or update an existing vlan
10037 Create or update an existing vlan.
10039 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10040 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
10049 description: Response codes found in [response codes](https://wiki.onap.org/).
10053 description: Value from executing hostname on the compute node.
10056 example: __HOSTNAME__
10057 - name: interface-name
10059 description: Name that identifies the physical interface
10062 example: __INTERFACE-NAME__
10063 - name: interface-name
10065 description: Name given to the interface
10068 example: __INTERFACE-NAME__
10069 - name: vlan-interface
10071 description: String that identifies the interface
10074 example: __VLAN-INTERFACE__
10077 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
10080 $ref: "#/definitions/vlan"
10083 - CloudInfrastructure
10084 summary: update an existing vlan
10086 Update an existing vlan
10088 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10089 The PUT operation will entirely replace an existing object.
10090 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10092 Other differences between PUT and PATCH are:
10094 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10095 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10096 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10097 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
10106 description: Response codes found in [response codes](https://wiki.onap.org/).
10110 description: Value from executing hostname on the compute node.
10113 example: __HOSTNAME__
10114 - name: interface-name
10116 description: Name that identifies the physical interface
10119 example: __INTERFACE-NAME__
10120 - name: interface-name
10122 description: Name given to the interface
10125 example: __INTERFACE-NAME__
10126 - name: vlan-interface
10128 description: String that identifies the interface
10131 example: __VLAN-INTERFACE__
10134 description: vlan object that needs to be updated.
10137 $ref: "#/patchDefinitions/vlan"
10140 - CloudInfrastructure
10141 summary: delete an existing vlan
10142 description: delete an existing vlan
10143 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
10152 description: Response codes found in [response codes](https://wiki.onap.org/).
10156 description: Value from executing hostname on the compute node.
10159 example: __HOSTNAME__
10160 - name: interface-name
10162 description: Name that identifies the physical interface
10165 example: __INTERFACE-NAME__
10166 - name: interface-name
10168 description: Name given to the interface
10171 example: __INTERFACE-NAME__
10172 - name: vlan-interface
10174 description: String that identifies the interface
10177 example: __VLAN-INTERFACE__
10178 - name: resource-version
10180 description: resource-version for concurrency
10183 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
10186 - CloudInfrastructure
10187 summary: returns vlans
10188 description: returns vlans
10189 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans
10195 description: successful operation
10197 $ref: "#/getDefinitions/vlans"
10199 description: Response codes found in [response codes](https://wiki.onap.org/).
10203 description: Value from executing hostname on the compute node.
10206 example: __HOSTNAME__
10207 - name: interface-name
10209 description: Name that identifies the physical interface
10212 example: __INTERFACE-NAME__
10213 - name: interface-name
10215 description: Name given to the interface
10218 example: __INTERFACE-NAME__
10219 - name: vlan-interface
10224 - name: vlan-id-inner
10235 /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:
10238 - CloudInfrastructure
10239 summary: see node definition for valid relationships
10240 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
10249 description: Response codes found in [response codes](https://wiki.onap.org/).
10253 description: Value from executing hostname on the compute node.
10256 example: __HOSTNAME__
10257 - name: interface-name
10259 description: Name that identifies the physical interface
10262 example: __INTERFACE-NAME__
10263 - name: interface-name
10265 description: Name given to the interface
10268 example: __INTERFACE-NAME__
10271 description: PCI ID used to identify the sriov-vf
10274 example: __PCI-ID__
10277 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
10280 $ref: "#/definitions/relationship"
10283 - CloudInfrastructure
10284 summary: delete an existing relationship
10285 description: delete an existing relationship
10286 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
10295 description: Response codes found in [response codes](https://wiki.onap.org/).
10299 description: Value from executing hostname on the compute node.
10302 example: __HOSTNAME__
10303 - name: interface-name
10305 description: Name that identifies the physical interface
10308 example: __INTERFACE-NAME__
10309 - name: interface-name
10311 description: Name given to the interface
10314 example: __INTERFACE-NAME__
10317 description: PCI ID used to identify the sriov-vf
10320 example: __PCI-ID__
10321 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
10324 - CloudInfrastructure
10325 summary: returns sriov-vf
10326 description: returns sriov-vf
10327 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10333 description: successful operation
10335 $ref: "#/getDefinitions/sriov-vf"
10337 description: Response codes found in [response codes](https://wiki.onap.org/).
10341 description: Value from executing hostname on the compute node.
10344 example: __HOSTNAME__
10345 - name: interface-name
10347 description: Name that identifies the physical interface
10350 example: __INTERFACE-NAME__
10351 - name: interface-name
10353 description: Name given to the interface
10356 example: __INTERFACE-NAME__
10359 description: PCI ID used to identify the sriov-vf
10362 example: __PCI-ID__
10365 - CloudInfrastructure
10366 summary: create or update an existing sriov-vf
10368 Create or update an existing sriov-vf.
10370 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10371 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10380 description: Response codes found in [response codes](https://wiki.onap.org/).
10384 description: Value from executing hostname on the compute node.
10387 example: __HOSTNAME__
10388 - name: interface-name
10390 description: Name that identifies the physical interface
10393 example: __INTERFACE-NAME__
10394 - name: interface-name
10396 description: Name given to the interface
10399 example: __INTERFACE-NAME__
10402 description: PCI ID used to identify the sriov-vf
10405 example: __PCI-ID__
10408 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
10411 $ref: "#/definitions/sriov-vf"
10414 - CloudInfrastructure
10415 summary: update an existing sriov-vf
10417 Update an existing sriov-vf
10419 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10420 The PUT operation will entirely replace an existing object.
10421 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10423 Other differences between PUT and PATCH are:
10425 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10426 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10427 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10428 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10437 description: Response codes found in [response codes](https://wiki.onap.org/).
10441 description: Value from executing hostname on the compute node.
10444 example: __HOSTNAME__
10445 - name: interface-name
10447 description: Name that identifies the physical interface
10450 example: __INTERFACE-NAME__
10451 - name: interface-name
10453 description: Name given to the interface
10456 example: __INTERFACE-NAME__
10459 description: PCI ID used to identify the sriov-vf
10462 example: __PCI-ID__
10465 description: sriov-vf object that needs to be updated.
10468 $ref: "#/patchDefinitions/sriov-vf"
10471 - CloudInfrastructure
10472 summary: delete an existing sriov-vf
10473 description: delete an existing sriov-vf
10474 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10483 description: Response codes found in [response codes](https://wiki.onap.org/).
10487 description: Value from executing hostname on the compute node.
10490 example: __HOSTNAME__
10491 - name: interface-name
10493 description: Name that identifies the physical interface
10496 example: __INTERFACE-NAME__
10497 - name: interface-name
10499 description: Name given to the interface
10502 example: __INTERFACE-NAME__
10505 description: PCI ID used to identify the sriov-vf
10508 example: __PCI-ID__
10509 - name: resource-version
10511 description: resource-version for concurrency
10514 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
10517 - CloudInfrastructure
10518 summary: returns sriov-vfs
10519 description: returns sriov-vfs
10520 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
10526 description: successful operation
10528 $ref: "#/getDefinitions/sriov-vfs"
10530 description: Response codes found in [response codes](https://wiki.onap.org/).
10534 description: Value from executing hostname on the compute node.
10537 example: __HOSTNAME__
10538 - name: interface-name
10540 description: Name that identifies the physical interface
10543 example: __INTERFACE-NAME__
10544 - name: interface-name
10546 description: Name given to the interface
10549 example: __INTERFACE-NAME__
10555 - name: vf-vlan-filter
10560 - name: vf-mac-filter
10565 - name: vf-vlan-strip
10570 - name: neutron-network-id
10575 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
10578 - CloudInfrastructure
10579 summary: see node definition for valid relationships
10580 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
10589 description: Response codes found in [response codes](https://wiki.onap.org/).
10593 description: Value from executing hostname on the compute node.
10596 example: __HOSTNAME__
10597 - name: interface-name
10599 description: Name that identifies the physical interface
10602 example: __INTERFACE-NAME__
10603 - name: interface-name
10605 description: Name given to the interface
10608 example: __INTERFACE-NAME__
10611 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
10614 $ref: "#/definitions/relationship"
10617 - CloudInfrastructure
10618 summary: delete an existing relationship
10619 description: delete an existing relationship
10620 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
10629 description: Response codes found in [response codes](https://wiki.onap.org/).
10633 description: Value from executing hostname on the compute node.
10636 example: __HOSTNAME__
10637 - name: interface-name
10639 description: Name that identifies the physical interface
10642 example: __INTERFACE-NAME__
10643 - name: interface-name
10645 description: Name given to the interface
10648 example: __INTERFACE-NAME__
10649 /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:
10652 - CloudInfrastructure
10653 summary: see node definition for valid relationships
10654 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
10663 description: Response codes found in [response codes](https://wiki.onap.org/).
10667 description: Value from executing hostname on the compute node.
10670 example: __HOSTNAME__
10671 - name: interface-name
10673 description: Name that identifies the physical interface
10676 example: __INTERFACE-NAME__
10677 - name: interface-name
10679 description: Name given to the interface
10682 example: __INTERFACE-NAME__
10683 - name: l3-interface-ipv4-address
10685 description: IP address
10688 example: __L3-INTERFACE-IPV4-ADDRESS__
10691 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
10694 $ref: "#/definitions/relationship"
10697 - CloudInfrastructure
10698 summary: delete an existing relationship
10699 description: delete an existing relationship
10700 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
10709 description: Response codes found in [response codes](https://wiki.onap.org/).
10713 description: Value from executing hostname on the compute node.
10716 example: __HOSTNAME__
10717 - name: interface-name
10719 description: Name that identifies the physical interface
10722 example: __INTERFACE-NAME__
10723 - name: interface-name
10725 description: Name given to the interface
10728 example: __INTERFACE-NAME__
10729 - name: l3-interface-ipv4-address
10731 description: IP address
10734 example: __L3-INTERFACE-IPV4-ADDRESS__
10735 /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}:
10738 - CloudInfrastructure
10739 summary: returns l3-interface-ipv4-address-list
10740 description: returns l3-interface-ipv4-address-list
10741 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
10747 description: successful operation
10749 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
10751 description: Response codes found in [response codes](https://wiki.onap.org/).
10755 description: Value from executing hostname on the compute node.
10758 example: __HOSTNAME__
10759 - name: interface-name
10761 description: Name that identifies the physical interface
10764 example: __INTERFACE-NAME__
10765 - name: interface-name
10767 description: Name given to the interface
10770 example: __INTERFACE-NAME__
10771 - name: l3-interface-ipv4-address
10773 description: IP address
10776 example: __L3-INTERFACE-IPV4-ADDRESS__
10779 - CloudInfrastructure
10780 summary: create or update an existing l3-interface-ipv4-address-list
10782 Create or update an existing l3-interface-ipv4-address-list.
10784 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10785 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
10794 description: Response codes found in [response codes](https://wiki.onap.org/).
10798 description: Value from executing hostname on the compute node.
10801 example: __HOSTNAME__
10802 - name: interface-name
10804 description: Name that identifies the physical interface
10807 example: __INTERFACE-NAME__
10808 - name: interface-name
10810 description: Name given to the interface
10813 example: __INTERFACE-NAME__
10814 - name: l3-interface-ipv4-address
10816 description: IP address
10819 example: __L3-INTERFACE-IPV4-ADDRESS__
10822 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
10825 $ref: "#/definitions/l3-interface-ipv4-address-list"
10828 - CloudInfrastructure
10829 summary: update an existing l3-interface-ipv4-address-list
10831 Update an existing l3-interface-ipv4-address-list
10833 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10834 The PUT operation will entirely replace an existing object.
10835 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10837 Other differences between PUT and PATCH are:
10839 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10840 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10841 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10842 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
10851 description: Response codes found in [response codes](https://wiki.onap.org/).
10855 description: Value from executing hostname on the compute node.
10858 example: __HOSTNAME__
10859 - name: interface-name
10861 description: Name that identifies the physical interface
10864 example: __INTERFACE-NAME__
10865 - name: interface-name
10867 description: Name given to the interface
10870 example: __INTERFACE-NAME__
10871 - name: l3-interface-ipv4-address
10873 description: IP address
10876 example: __L3-INTERFACE-IPV4-ADDRESS__
10879 description: l3-interface-ipv4-address-list object that needs to be updated.
10882 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
10885 - CloudInfrastructure
10886 summary: delete an existing l3-interface-ipv4-address-list
10887 description: delete an existing l3-interface-ipv4-address-list
10888 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
10897 description: Response codes found in [response codes](https://wiki.onap.org/).
10901 description: Value from executing hostname on the compute node.
10904 example: __HOSTNAME__
10905 - name: interface-name
10907 description: Name that identifies the physical interface
10910 example: __INTERFACE-NAME__
10911 - name: interface-name
10913 description: Name given to the interface
10916 example: __INTERFACE-NAME__
10917 - name: l3-interface-ipv4-address
10919 description: IP address
10922 example: __L3-INTERFACE-IPV4-ADDRESS__
10923 - name: resource-version
10925 description: resource-version for concurrency
10928 /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:
10931 - CloudInfrastructure
10932 summary: see node definition for valid relationships
10933 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
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 physical interface
10955 example: __INTERFACE-NAME__
10956 - name: interface-name
10958 description: Name given to the interface
10961 example: __INTERFACE-NAME__
10962 - name: l3-interface-ipv6-address
10964 description: IP address
10967 example: __L3-INTERFACE-IPV6-ADDRESS__
10970 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
10973 $ref: "#/definitions/relationship"
10976 - CloudInfrastructure
10977 summary: delete an existing relationship
10978 description: delete an existing relationship
10979 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
10988 description: Response codes found in [response codes](https://wiki.onap.org/).
10992 description: Value from executing hostname on the compute node.
10995 example: __HOSTNAME__
10996 - name: interface-name
10998 description: Name that identifies the physical interface
11001 example: __INTERFACE-NAME__
11002 - name: interface-name
11004 description: Name given to the interface
11007 example: __INTERFACE-NAME__
11008 - name: l3-interface-ipv6-address
11010 description: IP address
11013 example: __L3-INTERFACE-IPV6-ADDRESS__
11014 /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}:
11017 - CloudInfrastructure
11018 summary: returns l3-interface-ipv6-address-list
11019 description: returns l3-interface-ipv6-address-list
11020 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11026 description: successful operation
11028 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
11030 description: Response codes found in [response codes](https://wiki.onap.org/).
11034 description: Value from executing hostname on the compute node.
11037 example: __HOSTNAME__
11038 - name: interface-name
11040 description: Name that identifies the physical interface
11043 example: __INTERFACE-NAME__
11044 - name: interface-name
11046 description: Name given to the interface
11049 example: __INTERFACE-NAME__
11050 - name: l3-interface-ipv6-address
11052 description: IP address
11055 example: __L3-INTERFACE-IPV6-ADDRESS__
11058 - CloudInfrastructure
11059 summary: create or update an existing l3-interface-ipv6-address-list
11061 Create or update an existing l3-interface-ipv6-address-list.
11063 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11064 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11073 description: Response codes found in [response codes](https://wiki.onap.org/).
11077 description: Value from executing hostname on the compute node.
11080 example: __HOSTNAME__
11081 - name: interface-name
11083 description: Name that identifies the physical interface
11086 example: __INTERFACE-NAME__
11087 - name: interface-name
11089 description: Name given to the interface
11092 example: __INTERFACE-NAME__
11093 - name: l3-interface-ipv6-address
11095 description: IP address
11098 example: __L3-INTERFACE-IPV6-ADDRESS__
11101 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
11104 $ref: "#/definitions/l3-interface-ipv6-address-list"
11107 - CloudInfrastructure
11108 summary: update an existing l3-interface-ipv6-address-list
11110 Update an existing l3-interface-ipv6-address-list
11112 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11113 The PUT operation will entirely replace an existing object.
11114 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11116 Other differences between PUT and PATCH are:
11118 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11119 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11120 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11121 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11130 description: Response codes found in [response codes](https://wiki.onap.org/).
11134 description: Value from executing hostname on the compute node.
11137 example: __HOSTNAME__
11138 - name: interface-name
11140 description: Name that identifies the physical interface
11143 example: __INTERFACE-NAME__
11144 - name: interface-name
11146 description: Name given to the interface
11149 example: __INTERFACE-NAME__
11150 - name: l3-interface-ipv6-address
11152 description: IP address
11155 example: __L3-INTERFACE-IPV6-ADDRESS__
11158 description: l3-interface-ipv6-address-list object that needs to be updated.
11161 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
11164 - CloudInfrastructure
11165 summary: delete an existing l3-interface-ipv6-address-list
11166 description: delete an existing l3-interface-ipv6-address-list
11167 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11176 description: Response codes found in [response codes](https://wiki.onap.org/).
11180 description: Value from executing hostname on the compute node.
11183 example: __HOSTNAME__
11184 - name: interface-name
11186 description: Name that identifies the physical interface
11189 example: __INTERFACE-NAME__
11190 - name: interface-name
11192 description: Name given to the interface
11195 example: __INTERFACE-NAME__
11196 - name: l3-interface-ipv6-address
11198 description: IP address
11201 example: __L3-INTERFACE-IPV6-ADDRESS__
11202 - name: resource-version
11204 description: resource-version for concurrency
11207 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
11210 - CloudInfrastructure
11211 summary: returns l-interface
11212 description: returns l-interface
11213 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
11219 description: successful operation
11221 $ref: "#/getDefinitions/l-interface"
11223 description: Response codes found in [response codes](https://wiki.onap.org/).
11227 description: Value from executing hostname on the compute node.
11230 example: __HOSTNAME__
11231 - name: interface-name
11233 description: Name that identifies the physical interface
11236 example: __INTERFACE-NAME__
11237 - name: interface-name
11239 description: Name given to the interface
11242 example: __INTERFACE-NAME__
11245 - CloudInfrastructure
11246 summary: create or update an existing l-interface
11248 Create or update an existing l-interface.
11250 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11251 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
11260 description: Response codes found in [response codes](https://wiki.onap.org/).
11264 description: Value from executing hostname on the compute node.
11267 example: __HOSTNAME__
11268 - name: interface-name
11270 description: Name that identifies the physical interface
11273 example: __INTERFACE-NAME__
11274 - name: interface-name
11276 description: Name given to the interface
11279 example: __INTERFACE-NAME__
11282 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
11285 $ref: "#/definitions/l-interface"
11288 - CloudInfrastructure
11289 summary: update an existing l-interface
11291 Update an existing l-interface
11293 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11294 The PUT operation will entirely replace an existing object.
11295 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11297 Other differences between PUT and PATCH are:
11299 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11300 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11301 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11302 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
11311 description: Response codes found in [response codes](https://wiki.onap.org/).
11315 description: Value from executing hostname on the compute node.
11318 example: __HOSTNAME__
11319 - name: interface-name
11321 description: Name that identifies the physical interface
11324 example: __INTERFACE-NAME__
11325 - name: interface-name
11327 description: Name given to the interface
11330 example: __INTERFACE-NAME__
11333 description: l-interface object that needs to be updated.
11336 $ref: "#/patchDefinitions/l-interface"
11339 - CloudInfrastructure
11340 summary: delete an existing l-interface
11341 description: delete an existing l-interface
11342 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
11351 description: Response codes found in [response codes](https://wiki.onap.org/).
11355 description: Value from executing hostname on the compute node.
11358 example: __HOSTNAME__
11359 - name: interface-name
11361 description: Name that identifies the physical interface
11364 example: __INTERFACE-NAME__
11365 - name: interface-name
11367 description: Name given to the interface
11370 example: __INTERFACE-NAME__
11371 - name: resource-version
11373 description: resource-version for concurrency
11376 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces:
11379 - CloudInfrastructure
11380 summary: returns l-interfaces
11381 description: returns l-interfaces
11382 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces
11388 description: successful operation
11390 $ref: "#/getDefinitions/l-interfaces"
11392 description: Response codes found in [response codes](https://wiki.onap.org/).
11396 description: Value from executing hostname on the compute node.
11399 example: __HOSTNAME__
11400 - name: interface-name
11402 description: Name that identifies the physical interface
11405 example: __INTERFACE-NAME__
11406 - name: interface-name
11411 - name: interface-id
11421 - name: network-name
11426 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}:
11429 - CloudInfrastructure
11430 summary: returns p-interface
11431 description: returns p-interface
11432 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface
11438 description: successful operation
11440 $ref: "#/getDefinitions/p-interface"
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 physical interface
11455 example: __INTERFACE-NAME__
11458 - CloudInfrastructure
11459 summary: create or update an existing p-interface
11461 Create or update an existing p-interface.
11463 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11464 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface
11473 description: Response codes found in [response codes](https://wiki.onap.org/).
11477 description: Value from executing hostname on the compute node.
11480 example: __HOSTNAME__
11481 - name: interface-name
11483 description: Name that identifies the physical interface
11486 example: __INTERFACE-NAME__
11489 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
11492 $ref: "#/definitions/p-interface"
11495 - CloudInfrastructure
11496 summary: update an existing p-interface
11498 Update an existing p-interface
11500 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11501 The PUT operation will entirely replace an existing object.
11502 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11504 Other differences between PUT and PATCH are:
11506 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11507 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11508 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11509 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterface
11518 description: Response codes found in [response codes](https://wiki.onap.org/).
11522 description: Value from executing hostname on the compute node.
11525 example: __HOSTNAME__
11526 - name: interface-name
11528 description: Name that identifies the physical interface
11531 example: __INTERFACE-NAME__
11534 description: p-interface object that needs to be updated.
11537 $ref: "#/patchDefinitions/p-interface"
11540 - CloudInfrastructure
11541 summary: delete an existing p-interface
11542 description: delete an existing p-interface
11543 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface
11552 description: Response codes found in [response codes](https://wiki.onap.org/).
11556 description: Value from executing hostname on the compute node.
11559 example: __HOSTNAME__
11560 - name: interface-name
11562 description: Name that identifies the physical interface
11565 example: __INTERFACE-NAME__
11566 - name: resource-version
11568 description: resource-version for concurrency
11571 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces:
11574 - CloudInfrastructure
11575 summary: returns p-interfaces
11576 description: returns p-interfaces
11577 operationId: getCloudInfrastructurePserversPserverPInterfaces
11583 description: successful operation
11585 $ref: "#/getDefinitions/p-interfaces"
11587 description: Response codes found in [response codes](https://wiki.onap.org/).
11591 description: Value from executing hostname on the compute node.
11594 example: __HOSTNAME__
11595 - name: interface-name
11600 - name: prov-status
11605 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
11608 - CloudInfrastructure
11609 summary: see node definition for valid relationships
11610 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
11619 description: Response codes found in [response codes](https://wiki.onap.org/).
11623 description: Value from executing hostname on the compute node.
11626 example: __HOSTNAME__
11627 - name: interface-name
11629 description: Name that identifies the link aggregate interface
11632 example: __INTERFACE-NAME__
11635 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
11638 $ref: "#/definitions/relationship"
11641 - CloudInfrastructure
11642 summary: delete an existing relationship
11643 description: delete an existing relationship
11644 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
11653 description: Response codes found in [response codes](https://wiki.onap.org/).
11657 description: Value from executing hostname on the compute node.
11660 example: __HOSTNAME__
11661 - name: interface-name
11663 description: Name that identifies the link aggregate interface
11666 example: __INTERFACE-NAME__
11667 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
11670 - CloudInfrastructure
11671 summary: see node definition for valid relationships
11672 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
11681 description: Response codes found in [response codes](https://wiki.onap.org/).
11685 description: Value from executing hostname on the compute node.
11688 example: __HOSTNAME__
11689 - name: interface-name
11691 description: Name that identifies the link aggregate interface
11694 example: __INTERFACE-NAME__
11695 - name: interface-name
11697 description: Name given to the interface
11700 example: __INTERFACE-NAME__
11701 - name: vlan-interface
11703 description: String that identifies the interface
11706 example: __VLAN-INTERFACE__
11709 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
11712 $ref: "#/definitions/relationship"
11715 - CloudInfrastructure
11716 summary: delete an existing relationship
11717 description: delete an existing relationship
11718 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
11727 description: Response codes found in [response codes](https://wiki.onap.org/).
11731 description: Value from executing hostname on the compute node.
11734 example: __HOSTNAME__
11735 - name: interface-name
11737 description: Name that identifies the link aggregate interface
11740 example: __INTERFACE-NAME__
11741 - name: interface-name
11743 description: Name given to the interface
11746 example: __INTERFACE-NAME__
11747 - name: vlan-interface
11749 description: String that identifies the interface
11752 example: __VLAN-INTERFACE__
11753 /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:
11756 - CloudInfrastructure
11757 summary: see node definition for valid relationships
11758 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
11767 description: Response codes found in [response codes](https://wiki.onap.org/).
11771 description: Value from executing hostname on the compute node.
11774 example: __HOSTNAME__
11775 - name: interface-name
11777 description: Name that identifies the link aggregate interface
11780 example: __INTERFACE-NAME__
11781 - name: interface-name
11783 description: Name given to the interface
11786 example: __INTERFACE-NAME__
11787 - name: vlan-interface
11789 description: String that identifies the interface
11792 example: __VLAN-INTERFACE__
11793 - name: l3-interface-ipv4-address
11795 description: IP address
11798 example: __L3-INTERFACE-IPV4-ADDRESS__
11801 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
11804 $ref: "#/definitions/relationship"
11807 - CloudInfrastructure
11808 summary: delete an existing relationship
11809 description: delete an existing relationship
11810 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
11819 description: Response codes found in [response codes](https://wiki.onap.org/).
11823 description: Value from executing hostname on the compute node.
11826 example: __HOSTNAME__
11827 - name: interface-name
11829 description: Name that identifies the link aggregate interface
11832 example: __INTERFACE-NAME__
11833 - name: interface-name
11835 description: Name given to the interface
11838 example: __INTERFACE-NAME__
11839 - name: vlan-interface
11841 description: String that identifies the interface
11844 example: __VLAN-INTERFACE__
11845 - name: l3-interface-ipv4-address
11847 description: IP address
11850 example: __L3-INTERFACE-IPV4-ADDRESS__
11851 /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}:
11854 - CloudInfrastructure
11855 summary: returns l3-interface-ipv4-address-list
11856 description: returns l3-interface-ipv4-address-list
11857 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11863 description: successful operation
11865 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
11867 description: Response codes found in [response codes](https://wiki.onap.org/).
11871 description: Value from executing hostname on the compute node.
11874 example: __HOSTNAME__
11875 - name: interface-name
11877 description: Name that identifies the link aggregate interface
11880 example: __INTERFACE-NAME__
11881 - name: interface-name
11883 description: Name given to the interface
11886 example: __INTERFACE-NAME__
11887 - name: vlan-interface
11889 description: String that identifies the interface
11892 example: __VLAN-INTERFACE__
11893 - name: l3-interface-ipv4-address
11895 description: IP address
11898 example: __L3-INTERFACE-IPV4-ADDRESS__
11901 - CloudInfrastructure
11902 summary: create or update an existing l3-interface-ipv4-address-list
11904 Create or update an existing l3-interface-ipv4-address-list.
11906 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11907 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11916 description: Response codes found in [response codes](https://wiki.onap.org/).
11920 description: Value from executing hostname on the compute node.
11923 example: __HOSTNAME__
11924 - name: interface-name
11926 description: Name that identifies the link aggregate interface
11929 example: __INTERFACE-NAME__
11930 - name: interface-name
11932 description: Name given to the interface
11935 example: __INTERFACE-NAME__
11936 - name: vlan-interface
11938 description: String that identifies the interface
11941 example: __VLAN-INTERFACE__
11942 - name: l3-interface-ipv4-address
11944 description: IP address
11947 example: __L3-INTERFACE-IPV4-ADDRESS__
11950 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
11953 $ref: "#/definitions/l3-interface-ipv4-address-list"
11956 - CloudInfrastructure
11957 summary: update an existing l3-interface-ipv4-address-list
11959 Update an existing l3-interface-ipv4-address-list
11961 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11962 The PUT operation will entirely replace an existing object.
11963 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11965 Other differences between PUT and PATCH are:
11967 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11968 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11969 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11970 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11979 description: Response codes found in [response codes](https://wiki.onap.org/).
11983 description: Value from executing hostname on the compute node.
11986 example: __HOSTNAME__
11987 - name: interface-name
11989 description: Name that identifies the link aggregate interface
11992 example: __INTERFACE-NAME__
11993 - name: interface-name
11995 description: Name given to the interface
11998 example: __INTERFACE-NAME__
11999 - name: vlan-interface
12001 description: String that identifies the interface
12004 example: __VLAN-INTERFACE__
12005 - name: l3-interface-ipv4-address
12007 description: IP address
12010 example: __L3-INTERFACE-IPV4-ADDRESS__
12013 description: l3-interface-ipv4-address-list object that needs to be updated.
12016 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
12019 - CloudInfrastructure
12020 summary: delete an existing l3-interface-ipv4-address-list
12021 description: delete an existing l3-interface-ipv4-address-list
12022 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
12031 description: Response codes found in [response codes](https://wiki.onap.org/).
12035 description: Value from executing hostname on the compute node.
12038 example: __HOSTNAME__
12039 - name: interface-name
12041 description: Name that identifies the link aggregate interface
12044 example: __INTERFACE-NAME__
12045 - name: interface-name
12047 description: Name given to the interface
12050 example: __INTERFACE-NAME__
12051 - name: vlan-interface
12053 description: String that identifies the interface
12056 example: __VLAN-INTERFACE__
12057 - name: l3-interface-ipv4-address
12059 description: IP address
12062 example: __L3-INTERFACE-IPV4-ADDRESS__
12063 - name: resource-version
12065 description: resource-version for concurrency
12068 /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:
12071 - CloudInfrastructure
12072 summary: see node definition for valid relationships
12073 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
12082 description: Response codes found in [response codes](https://wiki.onap.org/).
12086 description: Value from executing hostname on the compute node.
12089 example: __HOSTNAME__
12090 - name: interface-name
12092 description: Name that identifies the link aggregate interface
12095 example: __INTERFACE-NAME__
12096 - name: interface-name
12098 description: Name given to the interface
12101 example: __INTERFACE-NAME__
12102 - name: vlan-interface
12104 description: String that identifies the interface
12107 example: __VLAN-INTERFACE__
12108 - name: l3-interface-ipv6-address
12110 description: IP address
12113 example: __L3-INTERFACE-IPV6-ADDRESS__
12116 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
12119 $ref: "#/definitions/relationship"
12122 - CloudInfrastructure
12123 summary: delete an existing relationship
12124 description: delete an existing relationship
12125 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
12134 description: Response codes found in [response codes](https://wiki.onap.org/).
12138 description: Value from executing hostname on the compute node.
12141 example: __HOSTNAME__
12142 - name: interface-name
12144 description: Name that identifies the link aggregate interface
12147 example: __INTERFACE-NAME__
12148 - name: interface-name
12150 description: Name given to the interface
12153 example: __INTERFACE-NAME__
12154 - name: vlan-interface
12156 description: String that identifies the interface
12159 example: __VLAN-INTERFACE__
12160 - name: l3-interface-ipv6-address
12162 description: IP address
12165 example: __L3-INTERFACE-IPV6-ADDRESS__
12166 /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}:
12169 - CloudInfrastructure
12170 summary: returns l3-interface-ipv6-address-list
12171 description: returns l3-interface-ipv6-address-list
12172 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
12178 description: successful operation
12180 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
12182 description: Response codes found in [response codes](https://wiki.onap.org/).
12186 description: Value from executing hostname on the compute node.
12189 example: __HOSTNAME__
12190 - name: interface-name
12192 description: Name that identifies the link aggregate interface
12195 example: __INTERFACE-NAME__
12196 - name: interface-name
12198 description: Name given to the interface
12201 example: __INTERFACE-NAME__
12202 - name: vlan-interface
12204 description: String that identifies the interface
12207 example: __VLAN-INTERFACE__
12208 - name: l3-interface-ipv6-address
12210 description: IP address
12213 example: __L3-INTERFACE-IPV6-ADDRESS__
12216 - CloudInfrastructure
12217 summary: create or update an existing l3-interface-ipv6-address-list
12219 Create or update an existing l3-interface-ipv6-address-list.
12221 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12222 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
12231 description: Response codes found in [response codes](https://wiki.onap.org/).
12235 description: Value from executing hostname on the compute node.
12238 example: __HOSTNAME__
12239 - name: interface-name
12241 description: Name that identifies the link aggregate interface
12244 example: __INTERFACE-NAME__
12245 - name: interface-name
12247 description: Name given to the interface
12250 example: __INTERFACE-NAME__
12251 - name: vlan-interface
12253 description: String that identifies the interface
12256 example: __VLAN-INTERFACE__
12257 - name: l3-interface-ipv6-address
12259 description: IP address
12262 example: __L3-INTERFACE-IPV6-ADDRESS__
12265 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
12268 $ref: "#/definitions/l3-interface-ipv6-address-list"
12271 - CloudInfrastructure
12272 summary: update an existing l3-interface-ipv6-address-list
12274 Update an existing l3-interface-ipv6-address-list
12276 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12277 The PUT operation will entirely replace an existing object.
12278 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12280 Other differences between PUT and PATCH are:
12282 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12283 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12284 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12285 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
12294 description: Response codes found in [response codes](https://wiki.onap.org/).
12298 description: Value from executing hostname on the compute node.
12301 example: __HOSTNAME__
12302 - name: interface-name
12304 description: Name that identifies the link aggregate interface
12307 example: __INTERFACE-NAME__
12308 - name: interface-name
12310 description: Name given to the interface
12313 example: __INTERFACE-NAME__
12314 - name: vlan-interface
12316 description: String that identifies the interface
12319 example: __VLAN-INTERFACE__
12320 - name: l3-interface-ipv6-address
12322 description: IP address
12325 example: __L3-INTERFACE-IPV6-ADDRESS__
12328 description: l3-interface-ipv6-address-list object that needs to be updated.
12331 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
12334 - CloudInfrastructure
12335 summary: delete an existing l3-interface-ipv6-address-list
12336 description: delete an existing l3-interface-ipv6-address-list
12337 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
12346 description: Response codes found in [response codes](https://wiki.onap.org/).
12350 description: Value from executing hostname on the compute node.
12353 example: __HOSTNAME__
12354 - name: interface-name
12356 description: Name that identifies the link aggregate interface
12359 example: __INTERFACE-NAME__
12360 - name: interface-name
12362 description: Name given to the interface
12365 example: __INTERFACE-NAME__
12366 - name: vlan-interface
12368 description: String that identifies the interface
12371 example: __VLAN-INTERFACE__
12372 - name: l3-interface-ipv6-address
12374 description: IP address
12377 example: __L3-INTERFACE-IPV6-ADDRESS__
12378 - name: resource-version
12380 description: resource-version for concurrency
12383 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
12386 - CloudInfrastructure
12387 summary: returns vlan
12388 description: returns vlan
12389 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
12395 description: successful operation
12397 $ref: "#/getDefinitions/vlan"
12399 description: Response codes found in [response codes](https://wiki.onap.org/).
12403 description: Value from executing hostname on the compute node.
12406 example: __HOSTNAME__
12407 - name: interface-name
12409 description: Name that identifies the link aggregate interface
12412 example: __INTERFACE-NAME__
12413 - name: interface-name
12415 description: Name given to the interface
12418 example: __INTERFACE-NAME__
12419 - name: vlan-interface
12421 description: String that identifies the interface
12424 example: __VLAN-INTERFACE__
12427 - CloudInfrastructure
12428 summary: create or update an existing vlan
12430 Create or update an existing vlan.
12432 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12433 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
12442 description: Response codes found in [response codes](https://wiki.onap.org/).
12446 description: Value from executing hostname on the compute node.
12449 example: __HOSTNAME__
12450 - name: interface-name
12452 description: Name that identifies the link aggregate interface
12455 example: __INTERFACE-NAME__
12456 - name: interface-name
12458 description: Name given to the interface
12461 example: __INTERFACE-NAME__
12462 - name: vlan-interface
12464 description: String that identifies the interface
12467 example: __VLAN-INTERFACE__
12470 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
12473 $ref: "#/definitions/vlan"
12476 - CloudInfrastructure
12477 summary: update an existing vlan
12479 Update an existing vlan
12481 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12482 The PUT operation will entirely replace an existing object.
12483 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12485 Other differences between PUT and PATCH are:
12487 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12488 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12489 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12490 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
12499 description: Response codes found in [response codes](https://wiki.onap.org/).
12503 description: Value from executing hostname on the compute node.
12506 example: __HOSTNAME__
12507 - name: interface-name
12509 description: Name that identifies the link aggregate interface
12512 example: __INTERFACE-NAME__
12513 - name: interface-name
12515 description: Name given to the interface
12518 example: __INTERFACE-NAME__
12519 - name: vlan-interface
12521 description: String that identifies the interface
12524 example: __VLAN-INTERFACE__
12527 description: vlan object that needs to be updated.
12530 $ref: "#/patchDefinitions/vlan"
12533 - CloudInfrastructure
12534 summary: delete an existing vlan
12535 description: delete an existing vlan
12536 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
12545 description: Response codes found in [response codes](https://wiki.onap.org/).
12549 description: Value from executing hostname on the compute node.
12552 example: __HOSTNAME__
12553 - name: interface-name
12555 description: Name that identifies the link aggregate interface
12558 example: __INTERFACE-NAME__
12559 - name: interface-name
12561 description: Name given to the interface
12564 example: __INTERFACE-NAME__
12565 - name: vlan-interface
12567 description: String that identifies the interface
12570 example: __VLAN-INTERFACE__
12571 - name: resource-version
12573 description: resource-version for concurrency
12576 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
12579 - CloudInfrastructure
12580 summary: returns vlans
12581 description: returns vlans
12582 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
12588 description: successful operation
12590 $ref: "#/getDefinitions/vlans"
12592 description: Response codes found in [response codes](https://wiki.onap.org/).
12596 description: Value from executing hostname on the compute node.
12599 example: __HOSTNAME__
12600 - name: interface-name
12602 description: Name that identifies the link aggregate interface
12605 example: __INTERFACE-NAME__
12606 - name: interface-name
12608 description: Name given to the interface
12611 example: __INTERFACE-NAME__
12612 - name: vlan-interface
12617 - name: vlan-id-inner
12628 /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:
12631 - CloudInfrastructure
12632 summary: see node definition for valid relationships
12633 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
12642 description: Response codes found in [response codes](https://wiki.onap.org/).
12646 description: Value from executing hostname on the compute node.
12649 example: __HOSTNAME__
12650 - name: interface-name
12652 description: Name that identifies the link aggregate interface
12655 example: __INTERFACE-NAME__
12656 - name: interface-name
12658 description: Name given to the interface
12661 example: __INTERFACE-NAME__
12664 description: PCI ID used to identify the sriov-vf
12667 example: __PCI-ID__
12670 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
12673 $ref: "#/definitions/relationship"
12676 - CloudInfrastructure
12677 summary: delete an existing relationship
12678 description: delete an existing relationship
12679 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
12688 description: Response codes found in [response codes](https://wiki.onap.org/).
12692 description: Value from executing hostname on the compute node.
12695 example: __HOSTNAME__
12696 - name: interface-name
12698 description: Name that identifies the link aggregate interface
12701 example: __INTERFACE-NAME__
12702 - name: interface-name
12704 description: Name given to the interface
12707 example: __INTERFACE-NAME__
12710 description: PCI ID used to identify the sriov-vf
12713 example: __PCI-ID__
12714 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
12717 - CloudInfrastructure
12718 summary: returns sriov-vf
12719 description: returns sriov-vf
12720 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12726 description: successful operation
12728 $ref: "#/getDefinitions/sriov-vf"
12730 description: Response codes found in [response codes](https://wiki.onap.org/).
12734 description: Value from executing hostname on the compute node.
12737 example: __HOSTNAME__
12738 - name: interface-name
12740 description: Name that identifies the link aggregate interface
12743 example: __INTERFACE-NAME__
12744 - name: interface-name
12746 description: Name given to the interface
12749 example: __INTERFACE-NAME__
12752 description: PCI ID used to identify the sriov-vf
12755 example: __PCI-ID__
12758 - CloudInfrastructure
12759 summary: create or update an existing sriov-vf
12761 Create or update an existing sriov-vf.
12763 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12764 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12773 description: Response codes found in [response codes](https://wiki.onap.org/).
12777 description: Value from executing hostname on the compute node.
12780 example: __HOSTNAME__
12781 - name: interface-name
12783 description: Name that identifies the link aggregate interface
12786 example: __INTERFACE-NAME__
12787 - name: interface-name
12789 description: Name given to the interface
12792 example: __INTERFACE-NAME__
12795 description: PCI ID used to identify the sriov-vf
12798 example: __PCI-ID__
12801 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
12804 $ref: "#/definitions/sriov-vf"
12807 - CloudInfrastructure
12808 summary: update an existing sriov-vf
12810 Update an existing sriov-vf
12812 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12813 The PUT operation will entirely replace an existing object.
12814 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12816 Other differences between PUT and PATCH are:
12818 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12819 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12820 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12821 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12830 description: Response codes found in [response codes](https://wiki.onap.org/).
12834 description: Value from executing hostname on the compute node.
12837 example: __HOSTNAME__
12838 - name: interface-name
12840 description: Name that identifies the link aggregate interface
12843 example: __INTERFACE-NAME__
12844 - name: interface-name
12846 description: Name given to the interface
12849 example: __INTERFACE-NAME__
12852 description: PCI ID used to identify the sriov-vf
12855 example: __PCI-ID__
12858 description: sriov-vf object that needs to be updated.
12861 $ref: "#/patchDefinitions/sriov-vf"
12864 - CloudInfrastructure
12865 summary: delete an existing sriov-vf
12866 description: delete an existing sriov-vf
12867 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12876 description: Response codes found in [response codes](https://wiki.onap.org/).
12880 description: Value from executing hostname on the compute node.
12883 example: __HOSTNAME__
12884 - name: interface-name
12886 description: Name that identifies the link aggregate interface
12889 example: __INTERFACE-NAME__
12890 - name: interface-name
12892 description: Name given to the interface
12895 example: __INTERFACE-NAME__
12898 description: PCI ID used to identify the sriov-vf
12901 example: __PCI-ID__
12902 - name: resource-version
12904 description: resource-version for concurrency
12907 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
12910 - CloudInfrastructure
12911 summary: returns sriov-vfs
12912 description: returns sriov-vfs
12913 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
12919 description: successful operation
12921 $ref: "#/getDefinitions/sriov-vfs"
12923 description: Response codes found in [response codes](https://wiki.onap.org/).
12927 description: Value from executing hostname on the compute node.
12930 example: __HOSTNAME__
12931 - name: interface-name
12933 description: Name that identifies the link aggregate interface
12936 example: __INTERFACE-NAME__
12937 - name: interface-name
12939 description: Name given to the interface
12942 example: __INTERFACE-NAME__
12948 - name: vf-vlan-filter
12953 - name: vf-mac-filter
12958 - name: vf-vlan-strip
12963 - name: neutron-network-id
12968 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
12971 - CloudInfrastructure
12972 summary: see node definition for valid relationships
12973 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
12982 description: Response codes found in [response codes](https://wiki.onap.org/).
12986 description: Value from executing hostname on the compute node.
12989 example: __HOSTNAME__
12990 - name: interface-name
12992 description: Name that identifies the link aggregate interface
12995 example: __INTERFACE-NAME__
12996 - name: interface-name
12998 description: Name given to the interface
13001 example: __INTERFACE-NAME__
13004 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
13007 $ref: "#/definitions/relationship"
13010 - CloudInfrastructure
13011 summary: delete an existing relationship
13012 description: delete an existing relationship
13013 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
13022 description: Response codes found in [response codes](https://wiki.onap.org/).
13026 description: Value from executing hostname on the compute node.
13029 example: __HOSTNAME__
13030 - name: interface-name
13032 description: Name that identifies the link aggregate interface
13035 example: __INTERFACE-NAME__
13036 - name: interface-name
13038 description: Name given to the interface
13041 example: __INTERFACE-NAME__
13042 /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:
13045 - CloudInfrastructure
13046 summary: see node definition for valid relationships
13047 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
13056 description: Response codes found in [response codes](https://wiki.onap.org/).
13060 description: Value from executing hostname on the compute node.
13063 example: __HOSTNAME__
13064 - name: interface-name
13066 description: Name that identifies the link aggregate interface
13069 example: __INTERFACE-NAME__
13070 - name: interface-name
13072 description: Name given to the interface
13075 example: __INTERFACE-NAME__
13076 - name: l3-interface-ipv4-address
13078 description: IP address
13081 example: __L3-INTERFACE-IPV4-ADDRESS__
13084 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
13087 $ref: "#/definitions/relationship"
13090 - CloudInfrastructure
13091 summary: delete an existing relationship
13092 description: delete an existing relationship
13093 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
13102 description: Response codes found in [response codes](https://wiki.onap.org/).
13106 description: Value from executing hostname on the compute node.
13109 example: __HOSTNAME__
13110 - name: interface-name
13112 description: Name that identifies the link aggregate interface
13115 example: __INTERFACE-NAME__
13116 - name: interface-name
13118 description: Name given to the interface
13121 example: __INTERFACE-NAME__
13122 - name: l3-interface-ipv4-address
13124 description: IP address
13127 example: __L3-INTERFACE-IPV4-ADDRESS__
13128 /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}:
13131 - CloudInfrastructure
13132 summary: returns l3-interface-ipv4-address-list
13133 description: returns l3-interface-ipv4-address-list
13134 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
13140 description: successful operation
13142 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
13144 description: Response codes found in [response codes](https://wiki.onap.org/).
13148 description: Value from executing hostname on the compute node.
13151 example: __HOSTNAME__
13152 - name: interface-name
13154 description: Name that identifies the link aggregate interface
13157 example: __INTERFACE-NAME__
13158 - name: interface-name
13160 description: Name given to the interface
13163 example: __INTERFACE-NAME__
13164 - name: l3-interface-ipv4-address
13166 description: IP address
13169 example: __L3-INTERFACE-IPV4-ADDRESS__
13172 - CloudInfrastructure
13173 summary: create or update an existing l3-interface-ipv4-address-list
13175 Create or update an existing l3-interface-ipv4-address-list.
13177 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13178 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
13187 description: Response codes found in [response codes](https://wiki.onap.org/).
13191 description: Value from executing hostname on the compute node.
13194 example: __HOSTNAME__
13195 - name: interface-name
13197 description: Name that identifies the link aggregate interface
13200 example: __INTERFACE-NAME__
13201 - name: interface-name
13203 description: Name given to the interface
13206 example: __INTERFACE-NAME__
13207 - name: l3-interface-ipv4-address
13209 description: IP address
13212 example: __L3-INTERFACE-IPV4-ADDRESS__
13215 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
13218 $ref: "#/definitions/l3-interface-ipv4-address-list"
13221 - CloudInfrastructure
13222 summary: update an existing l3-interface-ipv4-address-list
13224 Update an existing l3-interface-ipv4-address-list
13226 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13227 The PUT operation will entirely replace an existing object.
13228 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13230 Other differences between PUT and PATCH are:
13232 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13233 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13234 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13235 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
13244 description: Response codes found in [response codes](https://wiki.onap.org/).
13248 description: Value from executing hostname on the compute node.
13251 example: __HOSTNAME__
13252 - name: interface-name
13254 description: Name that identifies the link aggregate interface
13257 example: __INTERFACE-NAME__
13258 - name: interface-name
13260 description: Name given to the interface
13263 example: __INTERFACE-NAME__
13264 - name: l3-interface-ipv4-address
13266 description: IP address
13269 example: __L3-INTERFACE-IPV4-ADDRESS__
13272 description: l3-interface-ipv4-address-list object that needs to be updated.
13275 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
13278 - CloudInfrastructure
13279 summary: delete an existing l3-interface-ipv4-address-list
13280 description: delete an existing l3-interface-ipv4-address-list
13281 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
13290 description: Response codes found in [response codes](https://wiki.onap.org/).
13294 description: Value from executing hostname on the compute node.
13297 example: __HOSTNAME__
13298 - name: interface-name
13300 description: Name that identifies the link aggregate interface
13303 example: __INTERFACE-NAME__
13304 - name: interface-name
13306 description: Name given to the interface
13309 example: __INTERFACE-NAME__
13310 - name: l3-interface-ipv4-address
13312 description: IP address
13315 example: __L3-INTERFACE-IPV4-ADDRESS__
13316 - name: resource-version
13318 description: resource-version for concurrency
13321 /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:
13324 - CloudInfrastructure
13325 summary: see node definition for valid relationships
13326 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
13335 description: Response codes found in [response codes](https://wiki.onap.org/).
13339 description: Value from executing hostname on the compute node.
13342 example: __HOSTNAME__
13343 - name: interface-name
13345 description: Name that identifies the link aggregate interface
13348 example: __INTERFACE-NAME__
13349 - name: interface-name
13351 description: Name given to the interface
13354 example: __INTERFACE-NAME__
13355 - name: l3-interface-ipv6-address
13357 description: IP address
13360 example: __L3-INTERFACE-IPV6-ADDRESS__
13363 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
13366 $ref: "#/definitions/relationship"
13369 - CloudInfrastructure
13370 summary: delete an existing relationship
13371 description: delete an existing relationship
13372 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
13381 description: Response codes found in [response codes](https://wiki.onap.org/).
13385 description: Value from executing hostname on the compute node.
13388 example: __HOSTNAME__
13389 - name: interface-name
13391 description: Name that identifies the link aggregate interface
13394 example: __INTERFACE-NAME__
13395 - name: interface-name
13397 description: Name given to the interface
13400 example: __INTERFACE-NAME__
13401 - name: l3-interface-ipv6-address
13403 description: IP address
13406 example: __L3-INTERFACE-IPV6-ADDRESS__
13407 /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}:
13410 - CloudInfrastructure
13411 summary: returns l3-interface-ipv6-address-list
13412 description: returns l3-interface-ipv6-address-list
13413 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13419 description: successful operation
13421 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
13423 description: Response codes found in [response codes](https://wiki.onap.org/).
13427 description: Value from executing hostname on the compute node.
13430 example: __HOSTNAME__
13431 - name: interface-name
13433 description: Name that identifies the link aggregate interface
13436 example: __INTERFACE-NAME__
13437 - name: interface-name
13439 description: Name given to the interface
13442 example: __INTERFACE-NAME__
13443 - name: l3-interface-ipv6-address
13445 description: IP address
13448 example: __L3-INTERFACE-IPV6-ADDRESS__
13451 - CloudInfrastructure
13452 summary: create or update an existing l3-interface-ipv6-address-list
13454 Create or update an existing l3-interface-ipv6-address-list.
13456 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13457 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13466 description: Response codes found in [response codes](https://wiki.onap.org/).
13470 description: Value from executing hostname on the compute node.
13473 example: __HOSTNAME__
13474 - name: interface-name
13476 description: Name that identifies the link aggregate interface
13479 example: __INTERFACE-NAME__
13480 - name: interface-name
13482 description: Name given to the interface
13485 example: __INTERFACE-NAME__
13486 - name: l3-interface-ipv6-address
13488 description: IP address
13491 example: __L3-INTERFACE-IPV6-ADDRESS__
13494 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
13497 $ref: "#/definitions/l3-interface-ipv6-address-list"
13500 - CloudInfrastructure
13501 summary: update an existing l3-interface-ipv6-address-list
13503 Update an existing l3-interface-ipv6-address-list
13505 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13506 The PUT operation will entirely replace an existing object.
13507 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13509 Other differences between PUT and PATCH are:
13511 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13512 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13513 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13514 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13523 description: Response codes found in [response codes](https://wiki.onap.org/).
13527 description: Value from executing hostname on the compute node.
13530 example: __HOSTNAME__
13531 - name: interface-name
13533 description: Name that identifies the link aggregate interface
13536 example: __INTERFACE-NAME__
13537 - name: interface-name
13539 description: Name given to the interface
13542 example: __INTERFACE-NAME__
13543 - name: l3-interface-ipv6-address
13545 description: IP address
13548 example: __L3-INTERFACE-IPV6-ADDRESS__
13551 description: l3-interface-ipv6-address-list object that needs to be updated.
13554 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
13557 - CloudInfrastructure
13558 summary: delete an existing l3-interface-ipv6-address-list
13559 description: delete an existing l3-interface-ipv6-address-list
13560 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13569 description: Response codes found in [response codes](https://wiki.onap.org/).
13573 description: Value from executing hostname on the compute node.
13576 example: __HOSTNAME__
13577 - name: interface-name
13579 description: Name that identifies the link aggregate interface
13582 example: __INTERFACE-NAME__
13583 - name: interface-name
13585 description: Name given to the interface
13588 example: __INTERFACE-NAME__
13589 - name: l3-interface-ipv6-address
13591 description: IP address
13594 example: __L3-INTERFACE-IPV6-ADDRESS__
13595 - name: resource-version
13597 description: resource-version for concurrency
13600 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
13603 - CloudInfrastructure
13604 summary: returns l-interface
13605 description: returns l-interface
13606 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13612 description: successful operation
13614 $ref: "#/getDefinitions/l-interface"
13616 description: Response codes found in [response codes](https://wiki.onap.org/).
13620 description: Value from executing hostname on the compute node.
13623 example: __HOSTNAME__
13624 - name: interface-name
13626 description: Name that identifies the link aggregate interface
13629 example: __INTERFACE-NAME__
13630 - name: interface-name
13632 description: Name given to the interface
13635 example: __INTERFACE-NAME__
13638 - CloudInfrastructure
13639 summary: create or update an existing l-interface
13641 Create or update an existing l-interface.
13643 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13644 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13653 description: Response codes found in [response codes](https://wiki.onap.org/).
13657 description: Value from executing hostname on the compute node.
13660 example: __HOSTNAME__
13661 - name: interface-name
13663 description: Name that identifies the link aggregate interface
13666 example: __INTERFACE-NAME__
13667 - name: interface-name
13669 description: Name given to the interface
13672 example: __INTERFACE-NAME__
13675 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
13678 $ref: "#/definitions/l-interface"
13681 - CloudInfrastructure
13682 summary: update an existing l-interface
13684 Update an existing l-interface
13686 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13687 The PUT operation will entirely replace an existing object.
13688 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13690 Other differences between PUT and PATCH are:
13692 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13693 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13694 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13695 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13704 description: Response codes found in [response codes](https://wiki.onap.org/).
13708 description: Value from executing hostname on the compute node.
13711 example: __HOSTNAME__
13712 - name: interface-name
13714 description: Name that identifies the link aggregate interface
13717 example: __INTERFACE-NAME__
13718 - name: interface-name
13720 description: Name given to the interface
13723 example: __INTERFACE-NAME__
13726 description: l-interface object that needs to be updated.
13729 $ref: "#/patchDefinitions/l-interface"
13732 - CloudInfrastructure
13733 summary: delete an existing l-interface
13734 description: delete an existing l-interface
13735 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13744 description: Response codes found in [response codes](https://wiki.onap.org/).
13748 description: Value from executing hostname on the compute node.
13751 example: __HOSTNAME__
13752 - name: interface-name
13754 description: Name that identifies the link aggregate interface
13757 example: __INTERFACE-NAME__
13758 - name: interface-name
13760 description: Name given to the interface
13763 example: __INTERFACE-NAME__
13764 - name: resource-version
13766 description: resource-version for concurrency
13769 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
13772 - CloudInfrastructure
13773 summary: returns l-interfaces
13774 description: returns l-interfaces
13775 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces
13781 description: successful operation
13783 $ref: "#/getDefinitions/l-interfaces"
13785 description: Response codes found in [response codes](https://wiki.onap.org/).
13789 description: Value from executing hostname on the compute node.
13792 example: __HOSTNAME__
13793 - name: interface-name
13795 description: Name that identifies the link aggregate interface
13798 example: __INTERFACE-NAME__
13799 - name: interface-name
13804 - name: interface-id
13814 - name: network-name
13819 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}:
13822 - CloudInfrastructure
13823 summary: returns lag-interface
13824 description: returns lag-interface
13825 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface
13831 description: successful operation
13833 $ref: "#/getDefinitions/lag-interface"
13835 description: Response codes found in [response codes](https://wiki.onap.org/).
13839 description: Value from executing hostname on the compute node.
13842 example: __HOSTNAME__
13843 - name: interface-name
13845 description: Name that identifies the link aggregate interface
13848 example: __INTERFACE-NAME__
13851 - CloudInfrastructure
13852 summary: create or update an existing lag-interface
13854 Create or update an existing lag-interface.
13856 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13857 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
13866 description: Response codes found in [response codes](https://wiki.onap.org/).
13870 description: Value from executing hostname on the compute node.
13873 example: __HOSTNAME__
13874 - name: interface-name
13876 description: Name that identifies the link aggregate interface
13879 example: __INTERFACE-NAME__
13882 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
13885 $ref: "#/definitions/lag-interface"
13888 - CloudInfrastructure
13889 summary: update an existing lag-interface
13891 Update an existing lag-interface
13893 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13894 The PUT operation will entirely replace an existing object.
13895 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13897 Other differences between PUT and PATCH are:
13899 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13900 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13901 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13902 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
13911 description: Response codes found in [response codes](https://wiki.onap.org/).
13915 description: Value from executing hostname on the compute node.
13918 example: __HOSTNAME__
13919 - name: interface-name
13921 description: Name that identifies the link aggregate interface
13924 example: __INTERFACE-NAME__
13927 description: lag-interface object that needs to be updated.
13930 $ref: "#/patchDefinitions/lag-interface"
13933 - CloudInfrastructure
13934 summary: delete an existing lag-interface
13935 description: delete an existing lag-interface
13936 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface
13945 description: Response codes found in [response codes](https://wiki.onap.org/).
13949 description: Value from executing hostname on the compute node.
13952 example: __HOSTNAME__
13953 - name: interface-name
13955 description: Name that identifies the link aggregate interface
13958 example: __INTERFACE-NAME__
13959 - name: resource-version
13961 description: resource-version for concurrency
13964 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces:
13967 - CloudInfrastructure
13968 summary: returns lag-interfaces
13969 description: returns lag-interfaces
13970 operationId: getCloudInfrastructurePserversPserverLagInterfaces
13976 description: successful operation
13978 $ref: "#/getDefinitions/lag-interfaces"
13980 description: Response codes found in [response codes](https://wiki.onap.org/).
13984 description: Value from executing hostname on the compute node.
13987 example: __HOSTNAME__
13988 - name: interface-name
13993 - name: interface-id
13998 - name: interface-role
14003 /cloud-infrastructure/pservers/pserver/{hostname}:
14006 - CloudInfrastructure
14007 summary: returns pserver
14008 description: returns pserver
14009 operationId: getCloudInfrastructurePserversPserver
14015 description: successful operation
14017 $ref: "#/getDefinitions/pserver"
14019 description: Response codes found in [response codes](https://wiki.onap.org/).
14023 description: Value from executing hostname on the compute node.
14026 example: __HOSTNAME__
14029 - CloudInfrastructure
14030 summary: create or update an existing pserver
14032 Create or update an existing pserver.
14034 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14035 operationId: createOrUpdateCloudInfrastructurePserversPserver
14044 description: Response codes found in [response codes](https://wiki.onap.org/).
14048 description: Value from executing hostname on the compute node.
14051 example: __HOSTNAME__
14054 description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructurePserversPserver.json)
14057 $ref: "#/definitions/pserver"
14060 - CloudInfrastructure
14061 summary: update an existing pserver
14063 Update an existing pserver
14065 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14066 The PUT operation will entirely replace an existing object.
14067 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14069 Other differences between PUT and PATCH are:
14071 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14072 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14073 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14074 operationId: UpdateCloudInfrastructurePserversPserver
14083 description: Response codes found in [response codes](https://wiki.onap.org/).
14087 description: Value from executing hostname on the compute node.
14090 example: __HOSTNAME__
14093 description: pserver object that needs to be updated.
14096 $ref: "#/patchDefinitions/pserver"
14099 - CloudInfrastructure
14100 summary: delete an existing pserver
14101 description: delete an existing pserver
14102 operationId: deleteCloudInfrastructurePserversPserver
14111 description: Response codes found in [response codes](https://wiki.onap.org/).
14115 description: Value from executing hostname on the compute node.
14118 example: __HOSTNAME__
14119 - name: resource-version
14121 description: resource-version for concurrency
14124 /cloud-infrastructure/pservers:
14127 - CloudInfrastructure
14128 summary: returns pservers
14129 description: returns pservers
14130 operationId: getCloudInfrastructurePservers
14136 description: successful operation
14138 $ref: "#/getDefinitions/pservers"
14140 description: Response codes found in [response codes](https://wiki.onap.org/).
14162 - name: pserver-name2
14167 /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship:
14170 - CloudInfrastructure
14171 summary: see node definition for valid relationships
14172 operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
14181 description: Response codes found in [response codes](https://wiki.onap.org/).
14185 description: Unique ID of the vdc
14188 example: __VDC-ID__
14191 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
14194 $ref: "#/definitions/relationship"
14197 - CloudInfrastructure
14198 summary: delete an existing relationship
14199 description: delete an existing relationship
14200 operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
14209 description: Response codes found in [response codes](https://wiki.onap.org/).
14213 description: Unique ID of the vdc
14216 example: __VDC-ID__
14217 /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}:
14220 - CloudInfrastructure
14221 summary: returns virtual-data-center
14222 description: returns virtual-data-center
14223 operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter
14229 description: successful operation
14231 $ref: "#/getDefinitions/virtual-data-center"
14233 description: Response codes found in [response codes](https://wiki.onap.org/).
14237 description: Unique ID of the vdc
14240 example: __VDC-ID__
14243 - CloudInfrastructure
14244 summary: create or update an existing virtual-data-center
14246 Create or update an existing virtual-data-center.
14248 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14249 operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
14258 description: Response codes found in [response codes](https://wiki.onap.org/).
14262 description: Unique ID of the vdc
14265 example: __VDC-ID__
14268 description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
14271 $ref: "#/definitions/virtual-data-center"
14274 - CloudInfrastructure
14275 summary: update an existing virtual-data-center
14277 Update an existing virtual-data-center
14279 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14280 The PUT operation will entirely replace an existing object.
14281 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14283 Other differences between PUT and PATCH are:
14285 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14286 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14287 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14288 operationId: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
14297 description: Response codes found in [response codes](https://wiki.onap.org/).
14301 description: Unique ID of the vdc
14304 example: __VDC-ID__
14307 description: virtual-data-center object that needs to be updated.
14310 $ref: "#/patchDefinitions/virtual-data-center"
14313 - CloudInfrastructure
14314 summary: delete an existing virtual-data-center
14315 description: delete an existing virtual-data-center
14316 operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter
14325 description: Response codes found in [response codes](https://wiki.onap.org/).
14329 description: Unique ID of the vdc
14332 example: __VDC-ID__
14333 - name: resource-version
14335 description: resource-version for concurrency
14338 /cloud-infrastructure/virtual-data-centers:
14341 - CloudInfrastructure
14342 summary: returns virtual-data-centers
14343 description: returns virtual-data-centers
14344 operationId: getCloudInfrastructureVirtualDataCenters
14350 description: successful operation
14352 $ref: "#/getDefinitions/virtual-data-centers"
14354 description: Response codes found in [response codes](https://wiki.onap.org/).
14366 /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship:
14369 - CloudInfrastructure
14370 summary: see node definition for valid relationships
14371 operationId: createOrUpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironmentRelationshipListRelationship
14380 description: Response codes found in [response codes](https://wiki.onap.org/).
14382 - name: operational-environment-id
14384 description: UUID of an operational environment
14387 example: __OPERATIONAL-ENVIRONMENT-ID__
14390 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json)
14393 $ref: "#/definitions/relationship"
14396 - CloudInfrastructure
14397 summary: delete an existing relationship
14398 description: delete an existing relationship
14399 operationId: deleteCloudInfrastructureOperationalEnvironmentsOperationalEnvironmentRelationshipListRelationship
14408 description: Response codes found in [response codes](https://wiki.onap.org/).
14410 - name: operational-environment-id
14412 description: UUID of an operational environment
14415 example: __OPERATIONAL-ENVIRONMENT-ID__
14416 /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}:
14419 - CloudInfrastructure
14420 summary: returns operational-environment
14421 description: returns operational-environment
14422 operationId: getCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
14428 description: successful operation
14430 $ref: "#/getDefinitions/operational-environment"
14432 description: Response codes found in [response codes](https://wiki.onap.org/).
14434 - name: operational-environment-id
14436 description: UUID of an operational environment
14439 example: __OPERATIONAL-ENVIRONMENT-ID__
14442 - CloudInfrastructure
14443 summary: create or update an existing operational-environment
14445 Create or update an existing operational-environment.
14447 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14448 operationId: createOrUpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
14457 description: Response codes found in [response codes](https://wiki.onap.org/).
14459 - name: operational-environment-id
14461 description: UUID of an operational environment
14464 example: __OPERATIONAL-ENVIRONMENT-ID__
14467 description: operational-environment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json)
14470 $ref: "#/definitions/operational-environment"
14473 - CloudInfrastructure
14474 summary: update an existing operational-environment
14476 Update an existing operational-environment
14478 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14479 The PUT operation will entirely replace an existing object.
14480 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14482 Other differences between PUT and PATCH are:
14484 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14485 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14486 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14487 operationId: UpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
14496 description: Response codes found in [response codes](https://wiki.onap.org/).
14498 - name: operational-environment-id
14500 description: UUID of an operational environment
14503 example: __OPERATIONAL-ENVIRONMENT-ID__
14506 description: operational-environment object that needs to be updated.
14509 $ref: "#/patchDefinitions/operational-environment"
14512 - CloudInfrastructure
14513 summary: delete an existing operational-environment
14514 description: delete an existing operational-environment
14515 operationId: deleteCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
14524 description: Response codes found in [response codes](https://wiki.onap.org/).
14526 - name: operational-environment-id
14528 description: UUID of an operational environment
14531 example: __OPERATIONAL-ENVIRONMENT-ID__
14532 - name: resource-version
14534 description: resource-version for concurrency
14537 /cloud-infrastructure/operational-environments:
14540 - CloudInfrastructure
14541 summary: returns operational-environments
14542 description: returns operational-environments
14543 operationId: getCloudInfrastructureOperationalEnvironments
14549 description: successful operation
14551 $ref: "#/getDefinitions/operational-environments"
14553 description: Response codes found in [response codes](https://wiki.onap.org/).
14555 - name: operational-environment-id
14560 /business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
14564 summary: see node definition for valid relationships
14565 operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship
14574 description: Response codes found in [response codes](https://wiki.onap.org/).
14576 - name: resource-instance-id
14578 description: Unique id of resource instance.
14581 example: __RESOURCE-INSTANCE-ID__
14584 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessConnectorsConnector.json)
14587 $ref: "#/definitions/relationship"
14591 summary: delete an existing relationship
14592 description: delete an existing relationship
14593 operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship
14602 description: Response codes found in [response codes](https://wiki.onap.org/).
14604 - name: resource-instance-id
14606 description: Unique id of resource instance.
14609 example: __RESOURCE-INSTANCE-ID__
14610 /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
14614 summary: returns metadatum
14615 description: returns metadatum
14616 operationId: getBusinessConnectorsConnectorMetadataMetadatum
14622 description: successful operation
14624 $ref: "#/getDefinitions/metadatum"
14626 description: Response codes found in [response codes](https://wiki.onap.org/).
14628 - name: resource-instance-id
14630 description: Unique id of resource instance.
14633 example: __RESOURCE-INSTANCE-ID__
14638 example: __METANAME__
14642 summary: create or update an existing metadatum
14644 Create or update an existing metadatum.
14646 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14647 operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum
14656 description: Response codes found in [response codes](https://wiki.onap.org/).
14658 - name: resource-instance-id
14660 description: Unique id of resource instance.
14663 example: __RESOURCE-INSTANCE-ID__
14668 example: __METANAME__
14671 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessConnectorsConnectorMetadataMetadatum.json)
14674 $ref: "#/definitions/metadatum"
14678 summary: update an existing metadatum
14680 Update an existing metadatum
14682 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14683 The PUT operation will entirely replace an existing object.
14684 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14686 Other differences between PUT and PATCH are:
14688 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14689 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14690 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14691 operationId: UpdateBusinessConnectorsConnectorMetadataMetadatum
14700 description: Response codes found in [response codes](https://wiki.onap.org/).
14702 - name: resource-instance-id
14704 description: Unique id of resource instance.
14707 example: __RESOURCE-INSTANCE-ID__
14712 example: __METANAME__
14715 description: metadatum object that needs to be updated.
14718 $ref: "#/patchDefinitions/metadatum"
14722 summary: delete an existing metadatum
14723 description: delete an existing metadatum
14724 operationId: deleteBusinessConnectorsConnectorMetadataMetadatum
14733 description: Response codes found in [response codes](https://wiki.onap.org/).
14735 - name: resource-instance-id
14737 description: Unique id of resource instance.
14740 example: __RESOURCE-INSTANCE-ID__
14745 example: __METANAME__
14746 - name: resource-version
14748 description: resource-version for concurrency
14751 /business/connectors/connector/{resource-instance-id}/metadata:
14755 summary: returns metadata
14756 description: returns metadata
14757 operationId: getBusinessConnectorsConnectorMetadata
14763 description: successful operation
14765 $ref: "#/getDefinitions/metadata"
14767 description: Response codes found in [response codes](https://wiki.onap.org/).
14769 - name: resource-instance-id
14771 description: Unique id of resource instance.
14774 example: __RESOURCE-INSTANCE-ID__
14780 /business/connectors/connector/{resource-instance-id}:
14784 summary: returns connector
14785 description: returns connector
14786 operationId: getBusinessConnectorsConnector
14792 description: successful operation
14794 $ref: "#/getDefinitions/connector"
14796 description: Response codes found in [response codes](https://wiki.onap.org/).
14798 - name: resource-instance-id
14800 description: Unique id of resource instance.
14803 example: __RESOURCE-INSTANCE-ID__
14807 summary: create or update an existing connector
14809 Create or update an existing connector.
14811 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14812 operationId: createOrUpdateBusinessConnectorsConnector
14821 description: Response codes found in [response codes](https://wiki.onap.org/).
14823 - name: resource-instance-id
14825 description: Unique id of resource instance.
14828 example: __RESOURCE-INSTANCE-ID__
14831 description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessConnectorsConnector.json)
14834 $ref: "#/definitions/connector"
14838 summary: update an existing connector
14840 Update an existing connector
14842 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14843 The PUT operation will entirely replace an existing object.
14844 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14846 Other differences between PUT and PATCH are:
14848 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14849 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14850 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14851 operationId: UpdateBusinessConnectorsConnector
14860 description: Response codes found in [response codes](https://wiki.onap.org/).
14862 - name: resource-instance-id
14864 description: Unique id of resource instance.
14867 example: __RESOURCE-INSTANCE-ID__
14870 description: connector object that needs to be updated.
14873 $ref: "#/patchDefinitions/connector"
14877 summary: delete an existing connector
14878 description: delete an existing connector
14879 operationId: deleteBusinessConnectorsConnector
14888 description: Response codes found in [response codes](https://wiki.onap.org/).
14890 - name: resource-instance-id
14892 description: Unique id of resource instance.
14895 example: __RESOURCE-INSTANCE-ID__
14896 - name: resource-version
14898 description: resource-version for concurrency
14901 /business/connectors:
14905 summary: returns connectors
14906 description: returns connectors
14907 operationId: getBusinessConnectors
14913 description: successful operation
14915 $ref: "#/getDefinitions/connectors"
14917 description: Response codes found in [response codes](https://wiki.onap.org/).
14919 - name: resource-instance-id
14924 - name: model-invariant-id
14929 - name: model-version-id
14934 - name: widget-model-id
14939 - name: widget-model-version
14944 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
14948 summary: see node definition for valid relationships
14949 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
14958 description: Response codes found in [response codes](https://wiki.onap.org/).
14960 - name: global-customer-id
14962 description: Global customer id used across ECOMP to uniquely identify customer.
14965 example: __GLOBAL-CUSTOMER-ID__
14966 - name: service-type
14968 description: Value defined by orchestration to identify this service across ECOMP.
14971 example: __SERVICE-TYPE__
14972 - name: service-instance-id
14974 description: Uniquely identifies this instance of a service
14977 example: __SERVICE-INSTANCE-ID__
14980 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
14983 $ref: "#/definitions/relationship"
14987 summary: delete an existing relationship
14988 description: delete an existing relationship
14989 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
14998 description: Response codes found in [response codes](https://wiki.onap.org/).
15000 - name: global-customer-id
15002 description: Global customer id used across ECOMP to uniquely identify customer.
15005 example: __GLOBAL-CUSTOMER-ID__
15006 - name: service-type
15008 description: Value defined by orchestration to identify this service across ECOMP.
15011 example: __SERVICE-TYPE__
15012 - name: service-instance-id
15014 description: Uniquely identifies this instance of a service
15017 example: __SERVICE-INSTANCE-ID__
15018 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
15022 summary: returns metadatum
15023 description: returns metadatum
15024 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
15030 description: successful operation
15032 $ref: "#/getDefinitions/metadatum"
15034 description: Response codes found in [response codes](https://wiki.onap.org/).
15036 - name: global-customer-id
15038 description: Global customer id used across ECOMP to uniquely identify customer.
15041 example: __GLOBAL-CUSTOMER-ID__
15042 - name: service-type
15044 description: Value defined by orchestration to identify this service across ECOMP.
15047 example: __SERVICE-TYPE__
15048 - name: service-instance-id
15050 description: Uniquely identifies this instance of a service
15053 example: __SERVICE-INSTANCE-ID__
15058 example: __METANAME__
15062 summary: create or update an existing metadatum
15064 Create or update an existing metadatum.
15066 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15067 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
15076 description: Response codes found in [response codes](https://wiki.onap.org/).
15078 - name: global-customer-id
15080 description: Global customer id used across ECOMP to uniquely identify customer.
15083 example: __GLOBAL-CUSTOMER-ID__
15084 - name: service-type
15086 description: Value defined by orchestration to identify this service across ECOMP.
15089 example: __SERVICE-TYPE__
15090 - name: service-instance-id
15092 description: Uniquely identifies this instance of a service
15095 example: __SERVICE-INSTANCE-ID__
15100 example: __METANAME__
15103 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)
15106 $ref: "#/definitions/metadatum"
15110 summary: update an existing metadatum
15112 Update an existing metadatum
15114 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15115 The PUT operation will entirely replace an existing object.
15116 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15118 Other differences between PUT and PATCH are:
15120 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15121 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15122 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15123 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
15132 description: Response codes found in [response codes](https://wiki.onap.org/).
15134 - name: global-customer-id
15136 description: Global customer id used across ECOMP to uniquely identify customer.
15139 example: __GLOBAL-CUSTOMER-ID__
15140 - name: service-type
15142 description: Value defined by orchestration to identify this service across ECOMP.
15145 example: __SERVICE-TYPE__
15146 - name: service-instance-id
15148 description: Uniquely identifies this instance of a service
15151 example: __SERVICE-INSTANCE-ID__
15156 example: __METANAME__
15159 description: metadatum object that needs to be updated.
15162 $ref: "#/patchDefinitions/metadatum"
15166 summary: delete an existing metadatum
15167 description: delete an existing metadatum
15168 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
15177 description: Response codes found in [response codes](https://wiki.onap.org/).
15179 - name: global-customer-id
15181 description: Global customer id used across ECOMP to uniquely identify customer.
15184 example: __GLOBAL-CUSTOMER-ID__
15185 - name: service-type
15187 description: Value defined by orchestration to identify this service across ECOMP.
15190 example: __SERVICE-TYPE__
15191 - name: service-instance-id
15193 description: Uniquely identifies this instance of a service
15196 example: __SERVICE-INSTANCE-ID__
15201 example: __METANAME__
15202 - name: resource-version
15204 description: resource-version for concurrency
15207 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
15211 summary: returns metadata
15212 description: returns metadata
15213 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
15219 description: successful operation
15221 $ref: "#/getDefinitions/metadata"
15223 description: Response codes found in [response codes](https://wiki.onap.org/).
15225 - name: global-customer-id
15227 description: Global customer id used across ECOMP to uniquely identify customer.
15230 example: __GLOBAL-CUSTOMER-ID__
15231 - name: service-type
15233 description: Value defined by orchestration to identify this service across ECOMP.
15236 example: __SERVICE-TYPE__
15237 - name: service-instance-id
15239 description: Uniquely identifies this instance of a service
15242 example: __SERVICE-INSTANCE-ID__
15248 /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:
15252 summary: see node definition for valid relationships
15253 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
15262 description: Response codes found in [response codes](https://wiki.onap.org/).
15264 - name: global-customer-id
15266 description: Global customer id used across ECOMP to uniquely identify customer.
15269 example: __GLOBAL-CUSTOMER-ID__
15270 - name: service-type
15272 description: Value defined by orchestration to identify this service across ECOMP.
15275 example: __SERVICE-TYPE__
15276 - name: service-instance-id
15278 description: Uniquely identifies this instance of a service
15281 example: __SERVICE-INSTANCE-ID__
15284 description: Allotted Resource id UUID assigned to this instance.
15290 description: Allotted Resource id UUID assigned to this instance.
15296 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
15299 $ref: "#/definitions/relationship"
15303 summary: delete an existing relationship
15304 description: delete an existing relationship
15305 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
15314 description: Response codes found in [response codes](https://wiki.onap.org/).
15316 - name: global-customer-id
15318 description: Global customer id used across ECOMP to uniquely identify customer.
15321 example: __GLOBAL-CUSTOMER-ID__
15322 - name: service-type
15324 description: Value defined by orchestration to identify this service across ECOMP.
15327 example: __SERVICE-TYPE__
15328 - name: service-instance-id
15330 description: Uniquely identifies this instance of a service
15333 example: __SERVICE-INSTANCE-ID__
15336 description: Allotted Resource id UUID assigned to this instance.
15342 description: Allotted Resource id UUID assigned to this instance.
15346 /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}:
15350 summary: returns tunnel-xconnect
15351 description: returns tunnel-xconnect
15352 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15358 description: successful operation
15360 $ref: "#/getDefinitions/tunnel-xconnect"
15362 description: Response codes found in [response codes](https://wiki.onap.org/).
15364 - name: global-customer-id
15366 description: Global customer id used across ECOMP to uniquely identify customer.
15369 example: __GLOBAL-CUSTOMER-ID__
15370 - name: service-type
15372 description: Value defined by orchestration to identify this service across ECOMP.
15375 example: __SERVICE-TYPE__
15376 - name: service-instance-id
15378 description: Uniquely identifies this instance of a service
15381 example: __SERVICE-INSTANCE-ID__
15384 description: Allotted Resource id UUID assigned to this instance.
15390 description: Allotted Resource id UUID assigned to this instance.
15397 summary: create or update an existing tunnel-xconnect
15399 Create or update an existing tunnel-xconnect.
15401 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15402 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15411 description: Response codes found in [response codes](https://wiki.onap.org/).
15413 - name: global-customer-id
15415 description: Global customer id used across ECOMP to uniquely identify customer.
15418 example: __GLOBAL-CUSTOMER-ID__
15419 - name: service-type
15421 description: Value defined by orchestration to identify this service across ECOMP.
15424 example: __SERVICE-TYPE__
15425 - name: service-instance-id
15427 description: Uniquely identifies this instance of a service
15430 example: __SERVICE-INSTANCE-ID__
15433 description: Allotted Resource id UUID assigned to this instance.
15439 description: Allotted Resource id UUID assigned to this instance.
15445 description: tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
15448 $ref: "#/definitions/tunnel-xconnect"
15452 summary: update an existing tunnel-xconnect
15454 Update an existing tunnel-xconnect
15456 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15457 The PUT operation will entirely replace an existing object.
15458 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15460 Other differences between PUT and PATCH are:
15462 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15463 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15464 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15465 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15474 description: Response codes found in [response codes](https://wiki.onap.org/).
15476 - name: global-customer-id
15478 description: Global customer id used across ECOMP to uniquely identify customer.
15481 example: __GLOBAL-CUSTOMER-ID__
15482 - name: service-type
15484 description: Value defined by orchestration to identify this service across ECOMP.
15487 example: __SERVICE-TYPE__
15488 - name: service-instance-id
15490 description: Uniquely identifies this instance of a service
15493 example: __SERVICE-INSTANCE-ID__
15496 description: Allotted Resource id UUID assigned to this instance.
15502 description: Allotted Resource id UUID assigned to this instance.
15508 description: tunnel-xconnect object that needs to be updated.
15511 $ref: "#/patchDefinitions/tunnel-xconnect"
15515 summary: delete an existing tunnel-xconnect
15516 description: delete an existing tunnel-xconnect
15517 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15526 description: Response codes found in [response codes](https://wiki.onap.org/).
15528 - name: global-customer-id
15530 description: Global customer id used across ECOMP to uniquely identify customer.
15533 example: __GLOBAL-CUSTOMER-ID__
15534 - name: service-type
15536 description: Value defined by orchestration to identify this service across ECOMP.
15539 example: __SERVICE-TYPE__
15540 - name: service-instance-id
15542 description: Uniquely identifies this instance of a service
15545 example: __SERVICE-INSTANCE-ID__
15548 description: Allotted Resource id UUID assigned to this instance.
15554 description: Allotted Resource id UUID assigned to this instance.
15558 - name: resource-version
15560 description: resource-version for concurrency
15563 /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:
15567 summary: returns tunnel-xconnects
15568 description: returns tunnel-xconnects
15569 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects
15575 description: successful operation
15577 $ref: "#/getDefinitions/tunnel-xconnects"
15579 description: Response codes found in [response codes](https://wiki.onap.org/).
15581 - name: global-customer-id
15583 description: Global customer id used across ECOMP to uniquely identify customer.
15586 example: __GLOBAL-CUSTOMER-ID__
15587 - name: service-type
15589 description: Value defined by orchestration to identify this service across ECOMP.
15592 example: __SERVICE-TYPE__
15593 - name: service-instance-id
15595 description: Uniquely identifies this instance of a service
15598 example: __SERVICE-INSTANCE-ID__
15601 description: Allotted Resource id UUID assigned to this instance.
15610 /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:
15614 summary: see node definition for valid relationships
15615 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
15624 description: Response codes found in [response codes](https://wiki.onap.org/).
15626 - name: global-customer-id
15628 description: Global customer id used across ECOMP to uniquely identify customer.
15631 example: __GLOBAL-CUSTOMER-ID__
15632 - name: service-type
15634 description: Value defined by orchestration to identify this service across ECOMP.
15637 example: __SERVICE-TYPE__
15638 - name: service-instance-id
15640 description: Uniquely identifies this instance of a service
15643 example: __SERVICE-INSTANCE-ID__
15646 description: Allotted Resource id UUID assigned to this instance.
15652 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
15655 $ref: "#/definitions/relationship"
15659 summary: delete an existing relationship
15660 description: delete an existing relationship
15661 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
15670 description: Response codes found in [response codes](https://wiki.onap.org/).
15672 - name: global-customer-id
15674 description: Global customer id used across ECOMP to uniquely identify customer.
15677 example: __GLOBAL-CUSTOMER-ID__
15678 - name: service-type
15680 description: Value defined by orchestration to identify this service across ECOMP.
15683 example: __SERVICE-TYPE__
15684 - name: service-instance-id
15686 description: Uniquely identifies this instance of a service
15689 example: __SERVICE-INSTANCE-ID__
15692 description: Allotted Resource id UUID assigned to this instance.
15696 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}:
15700 summary: returns allotted-resource
15701 description: returns allotted-resource
15702 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
15708 description: successful operation
15710 $ref: "#/getDefinitions/allotted-resource"
15712 description: Response codes found in [response codes](https://wiki.onap.org/).
15714 - name: global-customer-id
15716 description: Global customer id used across ECOMP to uniquely identify customer.
15719 example: __GLOBAL-CUSTOMER-ID__
15720 - name: service-type
15722 description: Value defined by orchestration to identify this service across ECOMP.
15725 example: __SERVICE-TYPE__
15726 - name: service-instance-id
15728 description: Uniquely identifies this instance of a service
15731 example: __SERVICE-INSTANCE-ID__
15734 description: Allotted Resource id UUID assigned to this instance.
15741 summary: create or update an existing allotted-resource
15743 Create or update an existing allotted-resource.
15745 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15746 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
15755 description: Response codes found in [response codes](https://wiki.onap.org/).
15757 - name: global-customer-id
15759 description: Global customer id used across ECOMP to uniquely identify customer.
15762 example: __GLOBAL-CUSTOMER-ID__
15763 - name: service-type
15765 description: Value defined by orchestration to identify this service across ECOMP.
15768 example: __SERVICE-TYPE__
15769 - name: service-instance-id
15771 description: Uniquely identifies this instance of a service
15774 example: __SERVICE-INSTANCE-ID__
15777 description: Allotted Resource id UUID assigned to this instance.
15783 description: allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
15786 $ref: "#/definitions/allotted-resource"
15790 summary: update an existing allotted-resource
15792 Update an existing allotted-resource
15794 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15795 The PUT operation will entirely replace an existing object.
15796 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15798 Other differences between PUT and PATCH are:
15800 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15801 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15802 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15803 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
15812 description: Response codes found in [response codes](https://wiki.onap.org/).
15814 - name: global-customer-id
15816 description: Global customer id used across ECOMP to uniquely identify customer.
15819 example: __GLOBAL-CUSTOMER-ID__
15820 - name: service-type
15822 description: Value defined by orchestration to identify this service across ECOMP.
15825 example: __SERVICE-TYPE__
15826 - name: service-instance-id
15828 description: Uniquely identifies this instance of a service
15831 example: __SERVICE-INSTANCE-ID__
15834 description: Allotted Resource id UUID assigned to this instance.
15840 description: allotted-resource object that needs to be updated.
15843 $ref: "#/patchDefinitions/allotted-resource"
15847 summary: delete an existing allotted-resource
15848 description: delete an existing allotted-resource
15849 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
15858 description: Response codes found in [response codes](https://wiki.onap.org/).
15860 - name: global-customer-id
15862 description: Global customer id used across ECOMP to uniquely identify customer.
15865 example: __GLOBAL-CUSTOMER-ID__
15866 - name: service-type
15868 description: Value defined by orchestration to identify this service across ECOMP.
15871 example: __SERVICE-TYPE__
15872 - name: service-instance-id
15874 description: Uniquely identifies this instance of a service
15877 example: __SERVICE-INSTANCE-ID__
15880 description: Allotted Resource id UUID assigned to this instance.
15884 - name: resource-version
15886 description: resource-version for concurrency
15889 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources:
15893 summary: returns allotted-resources
15894 description: returns allotted-resources
15895 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources
15901 description: successful operation
15903 $ref: "#/getDefinitions/allotted-resources"
15905 description: Response codes found in [response codes](https://wiki.onap.org/).
15907 - name: global-customer-id
15909 description: Global customer id used across ECOMP to uniquely identify customer.
15912 example: __GLOBAL-CUSTOMER-ID__
15913 - name: service-type
15915 description: Value defined by orchestration to identify this service across ECOMP.
15918 example: __SERVICE-TYPE__
15919 - name: service-instance-id
15921 description: Uniquely identifies this instance of a service
15924 example: __SERVICE-INSTANCE-ID__
15930 - name: model-invariant-id
15935 - name: model-version-id
15950 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
15954 summary: returns service-instance
15955 description: returns service-instance
15956 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
15962 description: successful operation
15964 $ref: "#/getDefinitions/service-instance"
15966 description: Response codes found in [response codes](https://wiki.onap.org/).
15968 - name: global-customer-id
15970 description: Global customer id used across ECOMP to uniquely identify customer.
15973 example: __GLOBAL-CUSTOMER-ID__
15974 - name: service-type
15976 description: Value defined by orchestration to identify this service across ECOMP.
15979 example: __SERVICE-TYPE__
15980 - name: service-instance-id
15982 description: Uniquely identifies this instance of a service
15985 example: __SERVICE-INSTANCE-ID__
15989 summary: create or update an existing service-instance
15991 Create or update an existing service-instance.
15993 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15994 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
16003 description: Response codes found in [response codes](https://wiki.onap.org/).
16005 - name: global-customer-id
16007 description: Global customer id used across ECOMP to uniquely identify customer.
16010 example: __GLOBAL-CUSTOMER-ID__
16011 - name: service-type
16013 description: Value defined by orchestration to identify this service across ECOMP.
16016 example: __SERVICE-TYPE__
16017 - name: service-instance-id
16019 description: Uniquely identifies this instance of a service
16022 example: __SERVICE-INSTANCE-ID__
16025 description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
16028 $ref: "#/definitions/service-instance"
16032 summary: update an existing service-instance
16034 Update an existing service-instance
16036 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16037 The PUT operation will entirely replace an existing object.
16038 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16040 Other differences between PUT and PATCH are:
16042 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16043 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16044 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16045 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
16054 description: Response codes found in [response codes](https://wiki.onap.org/).
16056 - name: global-customer-id
16058 description: Global customer id used across ECOMP to uniquely identify customer.
16061 example: __GLOBAL-CUSTOMER-ID__
16062 - name: service-type
16064 description: Value defined by orchestration to identify this service across ECOMP.
16067 example: __SERVICE-TYPE__
16068 - name: service-instance-id
16070 description: Uniquely identifies this instance of a service
16073 example: __SERVICE-INSTANCE-ID__
16076 description: service-instance object that needs to be updated.
16079 $ref: "#/patchDefinitions/service-instance"
16083 summary: delete an existing service-instance
16084 description: delete an existing service-instance
16085 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
16094 description: Response codes found in [response codes](https://wiki.onap.org/).
16096 - name: global-customer-id
16098 description: Global customer id used across ECOMP to uniquely identify customer.
16101 example: __GLOBAL-CUSTOMER-ID__
16102 - name: service-type
16104 description: Value defined by orchestration to identify this service across ECOMP.
16107 example: __SERVICE-TYPE__
16108 - name: service-instance-id
16110 description: Uniquely identifies this instance of a service
16113 example: __SERVICE-INSTANCE-ID__
16114 - name: resource-version
16116 description: resource-version for concurrency
16119 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances:
16123 summary: returns service-instances
16124 description: returns service-instances
16125 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances
16131 description: successful operation
16133 $ref: "#/getDefinitions/service-instances"
16135 description: Response codes found in [response codes](https://wiki.onap.org/).
16137 - name: global-customer-id
16139 description: Global customer id used across ECOMP to uniquely identify customer.
16142 example: __GLOBAL-CUSTOMER-ID__
16143 - name: service-type
16145 description: Value defined by orchestration to identify this service across ECOMP.
16148 example: __SERVICE-TYPE__
16149 - name: service-instance-id
16154 - name: service-instance-name
16159 - name: environment-context
16164 - name: workload-context
16169 - name: model-invariant-id
16174 - name: model-version-id
16179 - name: widget-model-id
16184 - name: widget-model-version
16189 - name: service-instance-location-id
16194 - name: orchestration-status
16199 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship:
16203 summary: see node definition for valid relationships
16204 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
16213 description: Response codes found in [response codes](https://wiki.onap.org/).
16215 - name: global-customer-id
16217 description: Global customer id used across ECOMP to uniquely identify customer.
16220 example: __GLOBAL-CUSTOMER-ID__
16221 - name: service-type
16223 description: Value defined by orchestration to identify this service across ECOMP.
16226 example: __SERVICE-TYPE__
16229 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
16232 $ref: "#/definitions/relationship"
16236 summary: delete an existing relationship
16237 description: delete an existing relationship
16238 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
16247 description: Response codes found in [response codes](https://wiki.onap.org/).
16249 - name: global-customer-id
16251 description: Global customer id used across ECOMP to uniquely identify customer.
16254 example: __GLOBAL-CUSTOMER-ID__
16255 - name: service-type
16257 description: Value defined by orchestration to identify this service across ECOMP.
16260 example: __SERVICE-TYPE__
16261 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}:
16265 summary: returns service-subscription
16266 description: returns service-subscription
16267 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16273 description: successful operation
16275 $ref: "#/getDefinitions/service-subscription"
16277 description: Response codes found in [response codes](https://wiki.onap.org/).
16279 - name: global-customer-id
16281 description: Global customer id used across ECOMP to uniquely identify customer.
16284 example: __GLOBAL-CUSTOMER-ID__
16285 - name: service-type
16287 description: Value defined by orchestration to identify this service across ECOMP.
16290 example: __SERVICE-TYPE__
16294 summary: create or update an existing service-subscription
16296 Create or update an existing service-subscription.
16298 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16299 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16308 description: Response codes found in [response codes](https://wiki.onap.org/).
16310 - name: global-customer-id
16312 description: Global customer id used across ECOMP to uniquely identify customer.
16315 example: __GLOBAL-CUSTOMER-ID__
16316 - name: service-type
16318 description: Value defined by orchestration to identify this service across ECOMP.
16321 example: __SERVICE-TYPE__
16324 description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
16327 $ref: "#/definitions/service-subscription"
16331 summary: update an existing service-subscription
16333 Update an existing service-subscription
16335 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16336 The PUT operation will entirely replace an existing object.
16337 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16339 Other differences between PUT and PATCH are:
16341 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16342 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16343 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16344 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16353 description: Response codes found in [response codes](https://wiki.onap.org/).
16355 - name: global-customer-id
16357 description: Global customer id used across ECOMP to uniquely identify customer.
16360 example: __GLOBAL-CUSTOMER-ID__
16361 - name: service-type
16363 description: Value defined by orchestration to identify this service across ECOMP.
16366 example: __SERVICE-TYPE__
16369 description: service-subscription object that needs to be updated.
16372 $ref: "#/patchDefinitions/service-subscription"
16376 summary: delete an existing service-subscription
16377 description: delete an existing service-subscription
16378 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16387 description: Response codes found in [response codes](https://wiki.onap.org/).
16389 - name: global-customer-id
16391 description: Global customer id used across ECOMP to uniquely identify customer.
16394 example: __GLOBAL-CUSTOMER-ID__
16395 - name: service-type
16397 description: Value defined by orchestration to identify this service across ECOMP.
16400 example: __SERVICE-TYPE__
16401 - name: resource-version
16403 description: resource-version for concurrency
16406 /business/customers/customer/{global-customer-id}/service-subscriptions:
16410 summary: returns service-subscriptions
16411 description: returns service-subscriptions
16412 operationId: getBusinessCustomersCustomerServiceSubscriptions
16418 description: successful operation
16420 $ref: "#/getDefinitions/service-subscriptions"
16422 description: Response codes found in [response codes](https://wiki.onap.org/).
16424 - name: global-customer-id
16426 description: Global customer id used across ECOMP to uniquely identify customer.
16429 example: __GLOBAL-CUSTOMER-ID__
16430 - name: service-type
16435 /business/customers/customer/{global-customer-id}/relationship-list/relationship:
16439 summary: see node definition for valid relationships
16440 operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship
16449 description: Response codes found in [response codes](https://wiki.onap.org/).
16451 - name: global-customer-id
16453 description: Global customer id used across ECOMP to uniquely identify customer.
16456 example: __GLOBAL-CUSTOMER-ID__
16459 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomer.json)
16462 $ref: "#/definitions/relationship"
16466 summary: delete an existing relationship
16467 description: delete an existing relationship
16468 operationId: deleteBusinessCustomersCustomerRelationshipListRelationship
16477 description: Response codes found in [response codes](https://wiki.onap.org/).
16479 - name: global-customer-id
16481 description: Global customer id used across ECOMP to uniquely identify customer.
16484 example: __GLOBAL-CUSTOMER-ID__
16485 /business/customers/customer/{global-customer-id}:
16489 summary: returns customer
16490 description: returns customer
16491 operationId: getBusinessCustomersCustomer
16497 description: successful operation
16499 $ref: "#/getDefinitions/customer"
16501 description: Response codes found in [response codes](https://wiki.onap.org/).
16503 - name: global-customer-id
16505 description: Global customer id used across ECOMP to uniquely identify customer.
16508 example: __GLOBAL-CUSTOMER-ID__
16512 summary: create or update an existing customer
16514 Create or update an existing customer.
16516 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16517 operationId: createOrUpdateBusinessCustomersCustomer
16526 description: Response codes found in [response codes](https://wiki.onap.org/).
16528 - name: global-customer-id
16530 description: Global customer id used across ECOMP to uniquely identify customer.
16533 example: __GLOBAL-CUSTOMER-ID__
16536 description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessCustomersCustomer.json)
16539 $ref: "#/definitions/customer"
16543 summary: update an existing customer
16545 Update an existing customer
16547 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16548 The PUT operation will entirely replace an existing object.
16549 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16551 Other differences between PUT and PATCH are:
16553 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16554 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16555 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16556 operationId: UpdateBusinessCustomersCustomer
16565 description: Response codes found in [response codes](https://wiki.onap.org/).
16567 - name: global-customer-id
16569 description: Global customer id used across ECOMP to uniquely identify customer.
16572 example: __GLOBAL-CUSTOMER-ID__
16575 description: customer object that needs to be updated.
16578 $ref: "#/patchDefinitions/customer"
16582 summary: delete an existing customer
16583 description: delete an existing customer
16584 operationId: deleteBusinessCustomersCustomer
16593 description: Response codes found in [response codes](https://wiki.onap.org/).
16595 - name: global-customer-id
16597 description: Global customer id used across ECOMP to uniquely identify customer.
16600 example: __GLOBAL-CUSTOMER-ID__
16601 - name: resource-version
16603 description: resource-version for concurrency
16606 /business/customers:
16610 summary: returns customers
16611 description: returns customers
16612 operationId: getBusinessCustomers
16618 description: successful operation
16620 $ref: "#/getDefinitions/customers"
16622 description: Response codes found in [response codes](https://wiki.onap.org/).
16624 - name: global-customer-id
16629 - name: subscriber-name
16634 - name: subscriber-type
16639 /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship:
16643 summary: see node definition for valid relationships
16644 operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
16653 description: Response codes found in [response codes](https://wiki.onap.org/).
16655 - name: line-of-business-name
16657 description: Name of the line-of-business (product)
16660 example: __LINE-OF-BUSINESS-NAME__
16663 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessLinesOfBusinessLineOfBusiness.json)
16666 $ref: "#/definitions/relationship"
16670 summary: delete an existing relationship
16671 description: delete an existing relationship
16672 operationId: deleteBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
16681 description: Response codes found in [response codes](https://wiki.onap.org/).
16683 - name: line-of-business-name
16685 description: Name of the line-of-business (product)
16688 example: __LINE-OF-BUSINESS-NAME__
16689 /business/lines-of-business/line-of-business/{line-of-business-name}:
16693 summary: returns line-of-business
16694 description: returns line-of-business
16695 operationId: getBusinessLinesOfBusinessLineOfBusiness
16701 description: successful operation
16703 $ref: "#/getDefinitions/line-of-business"
16705 description: Response codes found in [response codes](https://wiki.onap.org/).
16707 - name: line-of-business-name
16709 description: Name of the line-of-business (product)
16712 example: __LINE-OF-BUSINESS-NAME__
16716 summary: create or update an existing line-of-business
16718 Create or update an existing line-of-business.
16720 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16721 operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusiness
16730 description: Response codes found in [response codes](https://wiki.onap.org/).
16732 - name: line-of-business-name
16734 description: Name of the line-of-business (product)
16737 example: __LINE-OF-BUSINESS-NAME__
16740 description: line-of-business object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessLinesOfBusinessLineOfBusiness.json)
16743 $ref: "#/definitions/line-of-business"
16747 summary: update an existing line-of-business
16749 Update an existing line-of-business
16751 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16752 The PUT operation will entirely replace an existing object.
16753 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16755 Other differences between PUT and PATCH are:
16757 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16758 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16759 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16760 operationId: UpdateBusinessLinesOfBusinessLineOfBusiness
16769 description: Response codes found in [response codes](https://wiki.onap.org/).
16771 - name: line-of-business-name
16773 description: Name of the line-of-business (product)
16776 example: __LINE-OF-BUSINESS-NAME__
16779 description: line-of-business object that needs to be updated.
16782 $ref: "#/patchDefinitions/line-of-business"
16786 summary: delete an existing line-of-business
16787 description: delete an existing line-of-business
16788 operationId: deleteBusinessLinesOfBusinessLineOfBusiness
16797 description: Response codes found in [response codes](https://wiki.onap.org/).
16799 - name: line-of-business-name
16801 description: Name of the line-of-business (product)
16804 example: __LINE-OF-BUSINESS-NAME__
16805 - name: resource-version
16807 description: resource-version for concurrency
16810 /business/lines-of-business:
16814 summary: returns lines-of-business
16815 description: returns lines-of-business
16816 operationId: getBusinessLinesOfBusiness
16822 description: successful operation
16824 $ref: "#/getDefinitions/lines-of-business"
16826 description: Response codes found in [response codes](https://wiki.onap.org/).
16828 - name: line-of-business-name
16833 /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship:
16837 summary: see node definition for valid relationships
16838 operationId: createOrUpdateBusinessOwningEntitiesOwningEntityRelationshipListRelationship
16847 description: Response codes found in [response codes](https://wiki.onap.org/).
16849 - name: owning-entity-id
16851 description: UUID of an owning entity
16854 example: __OWNING-ENTITY-ID__
16857 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessOwningEntitiesOwningEntity.json)
16860 $ref: "#/definitions/relationship"
16864 summary: delete an existing relationship
16865 description: delete an existing relationship
16866 operationId: deleteBusinessOwningEntitiesOwningEntityRelationshipListRelationship
16875 description: Response codes found in [response codes](https://wiki.onap.org/).
16877 - name: owning-entity-id
16879 description: UUID of an owning entity
16882 example: __OWNING-ENTITY-ID__
16883 /business/owning-entities/owning-entity/{owning-entity-id}:
16887 summary: returns owning-entity
16888 description: returns owning-entity
16889 operationId: getBusinessOwningEntitiesOwningEntity
16895 description: successful operation
16897 $ref: "#/getDefinitions/owning-entity"
16899 description: Response codes found in [response codes](https://wiki.onap.org/).
16901 - name: owning-entity-id
16903 description: UUID of an owning entity
16906 example: __OWNING-ENTITY-ID__
16910 summary: create or update an existing owning-entity
16912 Create or update an existing owning-entity.
16914 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16915 operationId: createOrUpdateBusinessOwningEntitiesOwningEntity
16924 description: Response codes found in [response codes](https://wiki.onap.org/).
16926 - name: owning-entity-id
16928 description: UUID of an owning entity
16931 example: __OWNING-ENTITY-ID__
16934 description: owning-entity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessOwningEntitiesOwningEntity.json)
16937 $ref: "#/definitions/owning-entity"
16941 summary: update an existing owning-entity
16943 Update an existing owning-entity
16945 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16946 The PUT operation will entirely replace an existing object.
16947 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16949 Other differences between PUT and PATCH are:
16951 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16952 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16953 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16954 operationId: UpdateBusinessOwningEntitiesOwningEntity
16963 description: Response codes found in [response codes](https://wiki.onap.org/).
16965 - name: owning-entity-id
16967 description: UUID of an owning entity
16970 example: __OWNING-ENTITY-ID__
16973 description: owning-entity object that needs to be updated.
16976 $ref: "#/patchDefinitions/owning-entity"
16980 summary: delete an existing owning-entity
16981 description: delete an existing owning-entity
16982 operationId: deleteBusinessOwningEntitiesOwningEntity
16991 description: Response codes found in [response codes](https://wiki.onap.org/).
16993 - name: owning-entity-id
16995 description: UUID of an owning entity
16998 example: __OWNING-ENTITY-ID__
16999 - name: resource-version
17001 description: resource-version for concurrency
17004 /business/owning-entities:
17008 summary: returns owning-entities
17009 description: returns owning-entities
17010 operationId: getBusinessOwningEntities
17016 description: successful operation
17018 $ref: "#/getDefinitions/owning-entities"
17020 description: Response codes found in [response codes](https://wiki.onap.org/).
17022 - name: owning-entity-id
17027 /business/platforms/platform/{platform-name}/relationship-list/relationship:
17031 summary: see node definition for valid relationships
17032 operationId: createOrUpdateBusinessPlatformsPlatformRelationshipListRelationship
17041 description: Response codes found in [response codes](https://wiki.onap.org/).
17043 - name: platform-name
17045 description: Name of the platform
17048 example: __PLATFORM-NAME__
17051 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessPlatformsPlatform.json)
17054 $ref: "#/definitions/relationship"
17058 summary: delete an existing relationship
17059 description: delete an existing relationship
17060 operationId: deleteBusinessPlatformsPlatformRelationshipListRelationship
17069 description: Response codes found in [response codes](https://wiki.onap.org/).
17071 - name: platform-name
17073 description: Name of the platform
17076 example: __PLATFORM-NAME__
17077 /business/platforms/platform/{platform-name}:
17081 summary: returns platform
17082 description: returns platform
17083 operationId: getBusinessPlatformsPlatform
17089 description: successful operation
17091 $ref: "#/getDefinitions/platform"
17093 description: Response codes found in [response codes](https://wiki.onap.org/).
17095 - name: platform-name
17097 description: Name of the platform
17100 example: __PLATFORM-NAME__
17104 summary: create or update an existing platform
17106 Create or update an existing platform.
17108 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17109 operationId: createOrUpdateBusinessPlatformsPlatform
17118 description: Response codes found in [response codes](https://wiki.onap.org/).
17120 - name: platform-name
17122 description: Name of the platform
17125 example: __PLATFORM-NAME__
17128 description: platform object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessPlatformsPlatform.json)
17131 $ref: "#/definitions/platform"
17135 summary: update an existing platform
17137 Update an existing platform
17139 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17140 The PUT operation will entirely replace an existing object.
17141 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17143 Other differences between PUT and PATCH are:
17145 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17146 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17147 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17148 operationId: UpdateBusinessPlatformsPlatform
17157 description: Response codes found in [response codes](https://wiki.onap.org/).
17159 - name: platform-name
17161 description: Name of the platform
17164 example: __PLATFORM-NAME__
17167 description: platform object that needs to be updated.
17170 $ref: "#/patchDefinitions/platform"
17174 summary: delete an existing platform
17175 description: delete an existing platform
17176 operationId: deleteBusinessPlatformsPlatform
17185 description: Response codes found in [response codes](https://wiki.onap.org/).
17187 - name: platform-name
17189 description: Name of the platform
17192 example: __PLATFORM-NAME__
17193 - name: resource-version
17195 description: resource-version for concurrency
17198 /business/platforms:
17202 summary: returns platforms
17203 description: returns platforms
17204 operationId: getBusinessPlatforms
17210 description: successful operation
17212 $ref: "#/getDefinitions/platforms"
17214 description: Response codes found in [response codes](https://wiki.onap.org/).
17216 - name: platform-name
17221 /business/projects/project/{project-name}/relationship-list/relationship:
17225 summary: see node definition for valid relationships
17226 operationId: createOrUpdateBusinessProjectsProjectRelationshipListRelationship
17235 description: Response codes found in [response codes](https://wiki.onap.org/).
17237 - name: project-name
17239 description: Name of the project deploying a service
17242 example: __PROJECT-NAME__
17245 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessProjectsProject.json)
17248 $ref: "#/definitions/relationship"
17252 summary: delete an existing relationship
17253 description: delete an existing relationship
17254 operationId: deleteBusinessProjectsProjectRelationshipListRelationship
17263 description: Response codes found in [response codes](https://wiki.onap.org/).
17265 - name: project-name
17267 description: Name of the project deploying a service
17270 example: __PROJECT-NAME__
17271 /business/projects/project/{project-name}:
17275 summary: returns project
17276 description: returns project
17277 operationId: getBusinessProjectsProject
17283 description: successful operation
17285 $ref: "#/getDefinitions/project"
17287 description: Response codes found in [response codes](https://wiki.onap.org/).
17289 - name: project-name
17291 description: Name of the project deploying a service
17294 example: __PROJECT-NAME__
17298 summary: create or update an existing project
17300 Create or update an existing project.
17302 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17303 operationId: createOrUpdateBusinessProjectsProject
17312 description: Response codes found in [response codes](https://wiki.onap.org/).
17314 - name: project-name
17316 description: Name of the project deploying a service
17319 example: __PROJECT-NAME__
17322 description: project object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/BusinessProjectsProject.json)
17325 $ref: "#/definitions/project"
17329 summary: update an existing project
17331 Update an existing project
17333 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17334 The PUT operation will entirely replace an existing object.
17335 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17337 Other differences between PUT and PATCH are:
17339 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17340 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17341 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17342 operationId: UpdateBusinessProjectsProject
17351 description: Response codes found in [response codes](https://wiki.onap.org/).
17353 - name: project-name
17355 description: Name of the project deploying a service
17358 example: __PROJECT-NAME__
17361 description: project object that needs to be updated.
17364 $ref: "#/patchDefinitions/project"
17368 summary: delete an existing project
17369 description: delete an existing project
17370 operationId: deleteBusinessProjectsProject
17379 description: Response codes found in [response codes](https://wiki.onap.org/).
17381 - name: project-name
17383 description: Name of the project deploying a service
17386 example: __PROJECT-NAME__
17387 - name: resource-version
17389 description: resource-version for concurrency
17392 /business/projects:
17396 summary: returns projects
17397 description: returns projects
17398 operationId: getBusinessProjects
17404 description: successful operation
17406 $ref: "#/getDefinitions/projects"
17408 description: Response codes found in [response codes](https://wiki.onap.org/).
17410 - name: project-name
17415 /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
17418 - ServiceDesignAndCreation
17419 summary: see node definition for valid relationships
17420 operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
17429 description: Response codes found in [response codes](https://wiki.onap.org/).
17431 - name: vnf-image-uuid
17433 description: Unique ID of this asset
17436 example: __VNF-IMAGE-UUID__
17439 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationVnfImagesVnfImage.json)
17442 $ref: "#/definitions/relationship"
17445 - ServiceDesignAndCreation
17446 summary: delete an existing relationship
17447 description: delete an existing relationship
17448 operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
17457 description: Response codes found in [response codes](https://wiki.onap.org/).
17459 - name: vnf-image-uuid
17461 description: Unique ID of this asset
17464 example: __VNF-IMAGE-UUID__
17465 /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}:
17468 - ServiceDesignAndCreation
17469 summary: returns vnf-image
17470 description: returns vnf-image
17471 operationId: getServiceDesignAndCreationVnfImagesVnfImage
17477 description: successful operation
17479 $ref: "#/getDefinitions/vnf-image"
17481 description: Response codes found in [response codes](https://wiki.onap.org/).
17483 - name: vnf-image-uuid
17485 description: Unique ID of this asset
17488 example: __VNF-IMAGE-UUID__
17491 - ServiceDesignAndCreation
17492 summary: create or update an existing vnf-image
17494 Create or update an existing vnf-image.
17496 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17497 operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage
17506 description: Response codes found in [response codes](https://wiki.onap.org/).
17508 - name: vnf-image-uuid
17510 description: Unique ID of this asset
17513 example: __VNF-IMAGE-UUID__
17516 description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationVnfImagesVnfImage.json)
17519 $ref: "#/definitions/vnf-image"
17522 - ServiceDesignAndCreation
17523 summary: update an existing vnf-image
17525 Update an existing vnf-image
17527 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17528 The PUT operation will entirely replace an existing object.
17529 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17531 Other differences between PUT and PATCH are:
17533 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17534 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17535 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17536 operationId: UpdateServiceDesignAndCreationVnfImagesVnfImage
17545 description: Response codes found in [response codes](https://wiki.onap.org/).
17547 - name: vnf-image-uuid
17549 description: Unique ID of this asset
17552 example: __VNF-IMAGE-UUID__
17555 description: vnf-image object that needs to be updated.
17558 $ref: "#/patchDefinitions/vnf-image"
17561 - ServiceDesignAndCreation
17562 summary: delete an existing vnf-image
17563 description: delete an existing vnf-image
17564 operationId: deleteServiceDesignAndCreationVnfImagesVnfImage
17573 description: Response codes found in [response codes](https://wiki.onap.org/).
17575 - name: vnf-image-uuid
17577 description: Unique ID of this asset
17580 example: __VNF-IMAGE-UUID__
17581 - name: resource-version
17583 description: resource-version for concurrency
17586 /service-design-and-creation/vnf-images:
17589 - ServiceDesignAndCreation
17590 summary: returns vnf-images
17591 description: returns vnf-images
17592 operationId: getServiceDesignAndCreationVnfImages
17598 description: successful operation
17600 $ref: "#/getDefinitions/vnf-images"
17602 description: Response codes found in [response codes](https://wiki.onap.org/).
17604 - name: vnf-image-uuid
17609 - name: application
17614 - name: application-vendor
17619 - name: application-version
17624 /service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
17627 - ServiceDesignAndCreation
17628 summary: see node definition for valid relationships
17629 operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship
17638 description: Response codes found in [response codes](https://wiki.onap.org/).
17642 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17645 example: __SERVICE-ID__
17648 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServicesService.json)
17651 $ref: "#/definitions/relationship"
17654 - ServiceDesignAndCreation
17655 summary: delete an existing relationship
17656 description: delete an existing relationship
17657 operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship
17666 description: Response codes found in [response codes](https://wiki.onap.org/).
17670 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17673 example: __SERVICE-ID__
17674 /service-design-and-creation/services/service/{service-id}:
17677 - ServiceDesignAndCreation
17678 summary: returns service
17679 description: returns service
17680 operationId: getServiceDesignAndCreationServicesService
17686 description: successful operation
17688 $ref: "#/getDefinitions/service"
17690 description: Response codes found in [response codes](https://wiki.onap.org/).
17694 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17697 example: __SERVICE-ID__
17700 - ServiceDesignAndCreation
17701 summary: create or update an existing service
17703 Create or update an existing service.
17705 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17706 operationId: createOrUpdateServiceDesignAndCreationServicesService
17715 description: Response codes found in [response codes](https://wiki.onap.org/).
17719 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17722 example: __SERVICE-ID__
17725 description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServicesService.json)
17728 $ref: "#/definitions/service"
17731 - ServiceDesignAndCreation
17732 summary: update an existing service
17734 Update an existing service
17736 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17737 The PUT operation will entirely replace an existing object.
17738 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17740 Other differences between PUT and PATCH are:
17742 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17743 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17744 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17745 operationId: UpdateServiceDesignAndCreationServicesService
17754 description: Response codes found in [response codes](https://wiki.onap.org/).
17758 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17761 example: __SERVICE-ID__
17764 description: service object that needs to be updated.
17767 $ref: "#/patchDefinitions/service"
17770 - ServiceDesignAndCreation
17771 summary: delete an existing service
17772 description: delete an existing service
17773 operationId: deleteServiceDesignAndCreationServicesService
17782 description: Response codes found in [response codes](https://wiki.onap.org/).
17786 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17789 example: __SERVICE-ID__
17790 - name: resource-version
17792 description: resource-version for concurrency
17795 /service-design-and-creation/services:
17798 - ServiceDesignAndCreation
17799 summary: returns services
17800 description: returns services
17801 operationId: getServiceDesignAndCreationServices
17807 description: successful operation
17809 $ref: "#/getDefinitions/services"
17811 description: Response codes found in [response codes](https://wiki.onap.org/).
17818 - name: service-description
17823 /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
17826 - ServiceDesignAndCreation
17827 summary: see node definition for valid relationships
17828 operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
17837 description: Response codes found in [response codes](https://wiki.onap.org/).
17839 - name: service-type
17841 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17844 example: __SERVICE-TYPE__
17847 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.
17850 example: __VNF-TYPE__
17853 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
17856 $ref: "#/definitions/relationship"
17859 - ServiceDesignAndCreation
17860 summary: delete an existing relationship
17861 description: delete an existing relationship
17862 operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
17871 description: Response codes found in [response codes](https://wiki.onap.org/).
17873 - name: service-type
17875 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17878 example: __SERVICE-TYPE__
17881 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.
17884 example: __VNF-TYPE__
17885 /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
17888 - ServiceDesignAndCreation
17889 summary: returns service-capability
17890 description: returns service-capability
17891 operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability
17897 description: successful operation
17899 $ref: "#/getDefinitions/service-capability"
17901 description: Response codes found in [response codes](https://wiki.onap.org/).
17903 - name: service-type
17905 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17908 example: __SERVICE-TYPE__
17911 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.
17914 example: __VNF-TYPE__
17917 - ServiceDesignAndCreation
17918 summary: create or update an existing service-capability
17920 Create or update an existing service-capability.
17922 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17923 operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
17932 description: Response codes found in [response codes](https://wiki.onap.org/).
17934 - name: service-type
17936 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17939 example: __SERVICE-TYPE__
17942 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.
17945 example: __VNF-TYPE__
17948 description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
17951 $ref: "#/definitions/service-capability"
17954 - ServiceDesignAndCreation
17955 summary: update an existing service-capability
17957 Update an existing service-capability
17959 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17960 The PUT operation will entirely replace an existing object.
17961 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17963 Other differences between PUT and PATCH are:
17965 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17966 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17967 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17968 operationId: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
17977 description: Response codes found in [response codes](https://wiki.onap.org/).
17979 - name: service-type
17981 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17984 example: __SERVICE-TYPE__
17987 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.
17990 example: __VNF-TYPE__
17993 description: service-capability object that needs to be updated.
17996 $ref: "#/patchDefinitions/service-capability"
17999 - ServiceDesignAndCreation
18000 summary: delete an existing service-capability
18001 description: delete an existing service-capability
18002 operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
18011 description: Response codes found in [response codes](https://wiki.onap.org/).
18013 - name: service-type
18015 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18018 example: __SERVICE-TYPE__
18021 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.
18024 example: __VNF-TYPE__
18025 - name: resource-version
18027 description: resource-version for concurrency
18030 /service-design-and-creation/service-capabilities:
18033 - ServiceDesignAndCreation
18034 summary: returns service-capabilities
18035 description: returns service-capabilities
18036 operationId: getServiceDesignAndCreationServiceCapabilities
18042 description: successful operation
18044 $ref: "#/getDefinitions/service-capabilities"
18046 description: Response codes found in [response codes](https://wiki.onap.org/).
18048 - name: service-type
18058 /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:
18061 - ServiceDesignAndCreation
18062 summary: see node definition for valid relationships
18063 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
18072 description: Response codes found in [response codes](https://wiki.onap.org/).
18074 - name: model-invariant-id
18076 description: Unique identifier corresponding to the main definition of a model in ASDC
18079 example: __MODEL-INVARIANT-ID__
18080 - name: model-version-id
18082 description: Unique identifier corresponding to one version of a model in ASDC
18085 example: __MODEL-VERSION-ID__
18086 - name: model-element-uuid
18090 example: __MODEL-ELEMENT-UUID__
18091 - name: model-constraint-uuid
18095 example: __MODEL-CONSTRAINT-UUID__
18096 - name: constrained-element-set-uuid
18100 example: __CONSTRAINED-ELEMENT-SET-UUID__
18101 - name: element-choice-set-uuid
18105 example: __ELEMENT-CHOICE-SET-UUID__
18108 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
18111 $ref: "#/definitions/relationship"
18114 - ServiceDesignAndCreation
18115 summary: delete an existing relationship
18116 description: delete an existing relationship
18117 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
18126 description: Response codes found in [response codes](https://wiki.onap.org/).
18128 - name: model-invariant-id
18130 description: Unique identifier corresponding to the main definition of a model in ASDC
18133 example: __MODEL-INVARIANT-ID__
18134 - name: model-version-id
18136 description: Unique identifier corresponding to one version of a model in ASDC
18139 example: __MODEL-VERSION-ID__
18140 - name: model-element-uuid
18144 example: __MODEL-ELEMENT-UUID__
18145 - name: model-constraint-uuid
18149 example: __MODEL-CONSTRAINT-UUID__
18150 - name: constrained-element-set-uuid
18154 example: __CONSTRAINED-ELEMENT-SET-UUID__
18155 - name: element-choice-set-uuid
18159 example: __ELEMENT-CHOICE-SET-UUID__
18160 /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}:
18163 - ServiceDesignAndCreation
18164 summary: returns element-choice-set
18165 description: returns element-choice-set
18166 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
18172 description: successful operation
18174 $ref: "#/getDefinitions/element-choice-set"
18176 description: Response codes found in [response codes](https://wiki.onap.org/).
18178 - name: model-invariant-id
18180 description: Unique identifier corresponding to the main definition of a model in ASDC
18183 example: __MODEL-INVARIANT-ID__
18184 - name: model-version-id
18186 description: Unique identifier corresponding to one version of a model in ASDC
18189 example: __MODEL-VERSION-ID__
18190 - name: model-element-uuid
18194 example: __MODEL-ELEMENT-UUID__
18195 - name: model-constraint-uuid
18199 example: __MODEL-CONSTRAINT-UUID__
18200 - name: constrained-element-set-uuid
18204 example: __CONSTRAINED-ELEMENT-SET-UUID__
18205 - name: element-choice-set-uuid
18209 example: __ELEMENT-CHOICE-SET-UUID__
18212 - ServiceDesignAndCreation
18213 summary: create or update an existing element-choice-set
18215 Create or update an existing element-choice-set.
18217 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18218 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
18227 description: Response codes found in [response codes](https://wiki.onap.org/).
18229 - name: model-invariant-id
18231 description: Unique identifier corresponding to the main definition of a model in ASDC
18234 example: __MODEL-INVARIANT-ID__
18235 - name: model-version-id
18237 description: Unique identifier corresponding to one version of a model in ASDC
18240 example: __MODEL-VERSION-ID__
18241 - name: model-element-uuid
18245 example: __MODEL-ELEMENT-UUID__
18246 - name: model-constraint-uuid
18250 example: __MODEL-CONSTRAINT-UUID__
18251 - name: constrained-element-set-uuid
18255 example: __CONSTRAINED-ELEMENT-SET-UUID__
18256 - name: element-choice-set-uuid
18260 example: __ELEMENT-CHOICE-SET-UUID__
18263 description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
18266 $ref: "#/definitions/element-choice-set"
18269 - ServiceDesignAndCreation
18270 summary: update an existing element-choice-set
18272 Update an existing element-choice-set
18274 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18275 The PUT operation will entirely replace an existing object.
18276 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18278 Other differences between PUT and PATCH are:
18280 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18281 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18282 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18283 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
18292 description: Response codes found in [response codes](https://wiki.onap.org/).
18294 - name: model-invariant-id
18296 description: Unique identifier corresponding to the main definition of a model in ASDC
18299 example: __MODEL-INVARIANT-ID__
18300 - name: model-version-id
18302 description: Unique identifier corresponding to one version of a model in ASDC
18305 example: __MODEL-VERSION-ID__
18306 - name: model-element-uuid
18310 example: __MODEL-ELEMENT-UUID__
18311 - name: model-constraint-uuid
18315 example: __MODEL-CONSTRAINT-UUID__
18316 - name: constrained-element-set-uuid
18320 example: __CONSTRAINED-ELEMENT-SET-UUID__
18321 - name: element-choice-set-uuid
18325 example: __ELEMENT-CHOICE-SET-UUID__
18328 description: element-choice-set object that needs to be updated.
18331 $ref: "#/patchDefinitions/element-choice-set"
18334 - ServiceDesignAndCreation
18335 summary: delete an existing element-choice-set
18336 description: delete an existing element-choice-set
18337 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
18346 description: Response codes found in [response codes](https://wiki.onap.org/).
18348 - name: model-invariant-id
18350 description: Unique identifier corresponding to the main definition of a model in ASDC
18353 example: __MODEL-INVARIANT-ID__
18354 - name: model-version-id
18356 description: Unique identifier corresponding to one version of a model in ASDC
18359 example: __MODEL-VERSION-ID__
18360 - name: model-element-uuid
18364 example: __MODEL-ELEMENT-UUID__
18365 - name: model-constraint-uuid
18369 example: __MODEL-CONSTRAINT-UUID__
18370 - name: constrained-element-set-uuid
18374 example: __CONSTRAINED-ELEMENT-SET-UUID__
18375 - name: element-choice-set-uuid
18379 example: __ELEMENT-CHOICE-SET-UUID__
18380 - name: resource-version
18382 description: resource-version for concurrency
18385 /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:
18388 - ServiceDesignAndCreation
18389 summary: returns element-choice-sets
18390 description: returns element-choice-sets
18391 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
18397 description: successful operation
18399 $ref: "#/getDefinitions/element-choice-sets"
18401 description: Response codes found in [response codes](https://wiki.onap.org/).
18403 - name: model-invariant-id
18405 description: Unique identifier corresponding to the main definition of a model in ASDC
18408 example: __MODEL-INVARIANT-ID__
18409 - name: model-version-id
18411 description: Unique identifier corresponding to one version of a model in ASDC
18414 example: __MODEL-VERSION-ID__
18415 - name: model-element-uuid
18419 example: __MODEL-ELEMENT-UUID__
18420 - name: model-constraint-uuid
18424 example: __MODEL-CONSTRAINT-UUID__
18425 - name: constrained-element-set-uuid
18429 example: __CONSTRAINED-ELEMENT-SET-UUID__
18430 - name: element-choice-set-uuid
18435 /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:
18438 - ServiceDesignAndCreation
18439 summary: see node definition for valid relationships
18440 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
18449 description: Response codes found in [response codes](https://wiki.onap.org/).
18451 - name: model-invariant-id
18453 description: Unique identifier corresponding to the main definition of a model in ASDC
18456 example: __MODEL-INVARIANT-ID__
18457 - name: model-version-id
18459 description: Unique identifier corresponding to one version of a model in ASDC
18462 example: __MODEL-VERSION-ID__
18463 - name: model-element-uuid
18467 example: __MODEL-ELEMENT-UUID__
18468 - name: model-constraint-uuid
18472 example: __MODEL-CONSTRAINT-UUID__
18473 - name: constrained-element-set-uuid
18477 example: __CONSTRAINED-ELEMENT-SET-UUID__
18480 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
18483 $ref: "#/definitions/relationship"
18486 - ServiceDesignAndCreation
18487 summary: delete an existing relationship
18488 description: delete an existing relationship
18489 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
18498 description: Response codes found in [response codes](https://wiki.onap.org/).
18500 - name: model-invariant-id
18502 description: Unique identifier corresponding to the main definition of a model in ASDC
18505 example: __MODEL-INVARIANT-ID__
18506 - name: model-version-id
18508 description: Unique identifier corresponding to one version of a model in ASDC
18511 example: __MODEL-VERSION-ID__
18512 - name: model-element-uuid
18516 example: __MODEL-ELEMENT-UUID__
18517 - name: model-constraint-uuid
18521 example: __MODEL-CONSTRAINT-UUID__
18522 - name: constrained-element-set-uuid
18526 example: __CONSTRAINED-ELEMENT-SET-UUID__
18527 /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}:
18530 - ServiceDesignAndCreation
18531 summary: returns constrained-element-set
18532 description: returns constrained-element-set
18533 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
18539 description: successful operation
18541 $ref: "#/getDefinitions/constrained-element-set"
18543 description: Response codes found in [response codes](https://wiki.onap.org/).
18545 - name: model-invariant-id
18547 description: Unique identifier corresponding to the main definition of a model in ASDC
18550 example: __MODEL-INVARIANT-ID__
18551 - name: model-version-id
18553 description: Unique identifier corresponding to one version of a model in ASDC
18556 example: __MODEL-VERSION-ID__
18557 - name: model-element-uuid
18561 example: __MODEL-ELEMENT-UUID__
18562 - name: model-constraint-uuid
18566 example: __MODEL-CONSTRAINT-UUID__
18567 - name: constrained-element-set-uuid
18571 example: __CONSTRAINED-ELEMENT-SET-UUID__
18574 - ServiceDesignAndCreation
18575 summary: create or update an existing constrained-element-set
18577 Create or update an existing constrained-element-set.
18579 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18580 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
18589 description: Response codes found in [response codes](https://wiki.onap.org/).
18591 - name: model-invariant-id
18593 description: Unique identifier corresponding to the main definition of a model in ASDC
18596 example: __MODEL-INVARIANT-ID__
18597 - name: model-version-id
18599 description: Unique identifier corresponding to one version of a model in ASDC
18602 example: __MODEL-VERSION-ID__
18603 - name: model-element-uuid
18607 example: __MODEL-ELEMENT-UUID__
18608 - name: model-constraint-uuid
18612 example: __MODEL-CONSTRAINT-UUID__
18613 - name: constrained-element-set-uuid
18617 example: __CONSTRAINED-ELEMENT-SET-UUID__
18620 description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
18623 $ref: "#/definitions/constrained-element-set"
18626 - ServiceDesignAndCreation
18627 summary: update an existing constrained-element-set
18629 Update an existing constrained-element-set
18631 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18632 The PUT operation will entirely replace an existing object.
18633 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18635 Other differences between PUT and PATCH are:
18637 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18638 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18639 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18640 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
18649 description: Response codes found in [response codes](https://wiki.onap.org/).
18651 - name: model-invariant-id
18653 description: Unique identifier corresponding to the main definition of a model in ASDC
18656 example: __MODEL-INVARIANT-ID__
18657 - name: model-version-id
18659 description: Unique identifier corresponding to one version of a model in ASDC
18662 example: __MODEL-VERSION-ID__
18663 - name: model-element-uuid
18667 example: __MODEL-ELEMENT-UUID__
18668 - name: model-constraint-uuid
18672 example: __MODEL-CONSTRAINT-UUID__
18673 - name: constrained-element-set-uuid
18677 example: __CONSTRAINED-ELEMENT-SET-UUID__
18680 description: constrained-element-set object that needs to be updated.
18683 $ref: "#/patchDefinitions/constrained-element-set"
18686 - ServiceDesignAndCreation
18687 summary: delete an existing constrained-element-set
18688 description: delete an existing constrained-element-set
18689 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
18698 description: Response codes found in [response codes](https://wiki.onap.org/).
18700 - name: model-invariant-id
18702 description: Unique identifier corresponding to the main definition of a model in ASDC
18705 example: __MODEL-INVARIANT-ID__
18706 - name: model-version-id
18708 description: Unique identifier corresponding to one version of a model in ASDC
18711 example: __MODEL-VERSION-ID__
18712 - name: model-element-uuid
18716 example: __MODEL-ELEMENT-UUID__
18717 - name: model-constraint-uuid
18721 example: __MODEL-CONSTRAINT-UUID__
18722 - name: constrained-element-set-uuid
18726 example: __CONSTRAINED-ELEMENT-SET-UUID__
18727 - name: resource-version
18729 description: resource-version for concurrency
18732 /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:
18735 - ServiceDesignAndCreation
18736 summary: returns constrained-element-sets
18737 description: returns constrained-element-sets
18738 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
18744 description: successful operation
18746 $ref: "#/getDefinitions/constrained-element-sets"
18748 description: Response codes found in [response codes](https://wiki.onap.org/).
18750 - name: model-invariant-id
18752 description: Unique identifier corresponding to the main definition of a model in ASDC
18755 example: __MODEL-INVARIANT-ID__
18756 - name: model-version-id
18758 description: Unique identifier corresponding to one version of a model in ASDC
18761 example: __MODEL-VERSION-ID__
18762 - name: model-element-uuid
18766 example: __MODEL-ELEMENT-UUID__
18767 - name: model-constraint-uuid
18771 example: __MODEL-CONSTRAINT-UUID__
18772 - name: constrained-element-set-uuid
18777 /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}:
18780 - ServiceDesignAndCreation
18781 summary: returns model-constraint
18782 description: returns model-constraint
18783 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
18789 description: successful operation
18791 $ref: "#/getDefinitions/model-constraint"
18793 description: Response codes found in [response codes](https://wiki.onap.org/).
18795 - name: model-invariant-id
18797 description: Unique identifier corresponding to the main definition of a model in ASDC
18800 example: __MODEL-INVARIANT-ID__
18801 - name: model-version-id
18803 description: Unique identifier corresponding to one version of a model in ASDC
18806 example: __MODEL-VERSION-ID__
18807 - name: model-element-uuid
18811 example: __MODEL-ELEMENT-UUID__
18812 - name: model-constraint-uuid
18816 example: __MODEL-CONSTRAINT-UUID__
18819 - ServiceDesignAndCreation
18820 summary: create or update an existing model-constraint
18822 Create or update an existing model-constraint.
18824 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18825 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
18834 description: Response codes found in [response codes](https://wiki.onap.org/).
18836 - name: model-invariant-id
18838 description: Unique identifier corresponding to the main definition of a model in ASDC
18841 example: __MODEL-INVARIANT-ID__
18842 - name: model-version-id
18844 description: Unique identifier corresponding to one version of a model in ASDC
18847 example: __MODEL-VERSION-ID__
18848 - name: model-element-uuid
18852 example: __MODEL-ELEMENT-UUID__
18853 - name: model-constraint-uuid
18857 example: __MODEL-CONSTRAINT-UUID__
18860 description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)
18863 $ref: "#/definitions/model-constraint"
18866 - ServiceDesignAndCreation
18867 summary: update an existing model-constraint
18869 Update an existing model-constraint
18871 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18872 The PUT operation will entirely replace an existing object.
18873 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18875 Other differences between PUT and PATCH are:
18877 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18878 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18879 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18880 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
18889 description: Response codes found in [response codes](https://wiki.onap.org/).
18891 - name: model-invariant-id
18893 description: Unique identifier corresponding to the main definition of a model in ASDC
18896 example: __MODEL-INVARIANT-ID__
18897 - name: model-version-id
18899 description: Unique identifier corresponding to one version of a model in ASDC
18902 example: __MODEL-VERSION-ID__
18903 - name: model-element-uuid
18907 example: __MODEL-ELEMENT-UUID__
18908 - name: model-constraint-uuid
18912 example: __MODEL-CONSTRAINT-UUID__
18915 description: model-constraint object that needs to be updated.
18918 $ref: "#/patchDefinitions/model-constraint"
18921 - ServiceDesignAndCreation
18922 summary: delete an existing model-constraint
18923 description: delete an existing model-constraint
18924 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
18933 description: Response codes found in [response codes](https://wiki.onap.org/).
18935 - name: model-invariant-id
18937 description: Unique identifier corresponding to the main definition of a model in ASDC
18940 example: __MODEL-INVARIANT-ID__
18941 - name: model-version-id
18943 description: Unique identifier corresponding to one version of a model in ASDC
18946 example: __MODEL-VERSION-ID__
18947 - name: model-element-uuid
18951 example: __MODEL-ELEMENT-UUID__
18952 - name: model-constraint-uuid
18956 example: __MODEL-CONSTRAINT-UUID__
18957 - name: resource-version
18959 description: resource-version for concurrency
18962 /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:
18965 - ServiceDesignAndCreation
18966 summary: returns model-constraints
18967 description: returns model-constraints
18968 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints
18974 description: successful operation
18976 $ref: "#/getDefinitions/model-constraints"
18978 description: Response codes found in [response codes](https://wiki.onap.org/).
18980 - name: model-invariant-id
18982 description: Unique identifier corresponding to the main definition of a model in ASDC
18985 example: __MODEL-INVARIANT-ID__
18986 - name: model-version-id
18988 description: Unique identifier corresponding to one version of a model in ASDC
18991 example: __MODEL-VERSION-ID__
18992 - name: model-element-uuid
18996 example: __MODEL-ELEMENT-UUID__
18997 - name: model-constraint-uuid
19002 /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:
19005 - ServiceDesignAndCreation
19006 summary: see node definition for valid relationships
19007 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
19016 description: Response codes found in [response codes](https://wiki.onap.org/).
19018 - name: model-invariant-id
19020 description: Unique identifier corresponding to the main definition of a model in ASDC
19023 example: __MODEL-INVARIANT-ID__
19024 - name: model-version-id
19026 description: Unique identifier corresponding to one version of a model in ASDC
19029 example: __MODEL-VERSION-ID__
19030 - name: model-element-uuid
19034 example: __MODEL-ELEMENT-UUID__
19037 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
19040 $ref: "#/definitions/relationship"
19043 - ServiceDesignAndCreation
19044 summary: delete an existing relationship
19045 description: delete an existing relationship
19046 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
19055 description: Response codes found in [response codes](https://wiki.onap.org/).
19057 - name: model-invariant-id
19059 description: Unique identifier corresponding to the main definition of a model in ASDC
19062 example: __MODEL-INVARIANT-ID__
19063 - name: model-version-id
19065 description: Unique identifier corresponding to one version of a model in ASDC
19068 example: __MODEL-VERSION-ID__
19069 - name: model-element-uuid
19073 example: __MODEL-ELEMENT-UUID__
19074 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}:
19077 - ServiceDesignAndCreation
19078 summary: returns model-element
19079 description: returns model-element
19080 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
19086 description: successful operation
19088 $ref: "#/getDefinitions/model-element"
19090 description: Response codes found in [response codes](https://wiki.onap.org/).
19092 - name: model-invariant-id
19094 description: Unique identifier corresponding to the main definition of a model in ASDC
19097 example: __MODEL-INVARIANT-ID__
19098 - name: model-version-id
19100 description: Unique identifier corresponding to one version of a model in ASDC
19103 example: __MODEL-VERSION-ID__
19104 - name: model-element-uuid
19108 example: __MODEL-ELEMENT-UUID__
19111 - ServiceDesignAndCreation
19112 summary: create or update an existing model-element
19114 Create or update an existing model-element.
19116 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19117 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
19126 description: Response codes found in [response codes](https://wiki.onap.org/).
19128 - name: model-invariant-id
19130 description: Unique identifier corresponding to the main definition of a model in ASDC
19133 example: __MODEL-INVARIANT-ID__
19134 - name: model-version-id
19136 description: Unique identifier corresponding to one version of a model in ASDC
19139 example: __MODEL-VERSION-ID__
19140 - name: model-element-uuid
19144 example: __MODEL-ELEMENT-UUID__
19147 description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
19150 $ref: "#/definitions/model-element"
19153 - ServiceDesignAndCreation
19154 summary: update an existing model-element
19156 Update an existing model-element
19158 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19159 The PUT operation will entirely replace an existing object.
19160 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19162 Other differences between PUT and PATCH are:
19164 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19165 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19166 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19167 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
19176 description: Response codes found in [response codes](https://wiki.onap.org/).
19178 - name: model-invariant-id
19180 description: Unique identifier corresponding to the main definition of a model in ASDC
19183 example: __MODEL-INVARIANT-ID__
19184 - name: model-version-id
19186 description: Unique identifier corresponding to one version of a model in ASDC
19189 example: __MODEL-VERSION-ID__
19190 - name: model-element-uuid
19194 example: __MODEL-ELEMENT-UUID__
19197 description: model-element object that needs to be updated.
19200 $ref: "#/patchDefinitions/model-element"
19203 - ServiceDesignAndCreation
19204 summary: delete an existing model-element
19205 description: delete an existing model-element
19206 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
19215 description: Response codes found in [response codes](https://wiki.onap.org/).
19217 - name: model-invariant-id
19219 description: Unique identifier corresponding to the main definition of a model in ASDC
19222 example: __MODEL-INVARIANT-ID__
19223 - name: model-version-id
19225 description: Unique identifier corresponding to one version of a model in ASDC
19228 example: __MODEL-VERSION-ID__
19229 - name: model-element-uuid
19233 example: __MODEL-ELEMENT-UUID__
19234 - name: resource-version
19236 description: resource-version for concurrency
19239 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements:
19242 - ServiceDesignAndCreation
19243 summary: returns model-elements
19244 description: returns model-elements
19245 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements
19251 description: successful operation
19253 $ref: "#/getDefinitions/model-elements"
19255 description: Response codes found in [response codes](https://wiki.onap.org/).
19257 - name: model-invariant-id
19259 description: Unique identifier corresponding to the main definition of a model in ASDC
19262 example: __MODEL-INVARIANT-ID__
19263 - name: model-version-id
19265 description: Unique identifier corresponding to one version of a model in ASDC
19268 example: __MODEL-VERSION-ID__
19269 - name: model-element-uuid
19274 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}:
19277 - ServiceDesignAndCreation
19278 summary: returns metadatum
19279 description: returns metadatum
19280 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
19286 description: successful operation
19288 $ref: "#/getDefinitions/metadatum"
19290 description: Response codes found in [response codes](https://wiki.onap.org/).
19292 - name: model-invariant-id
19294 description: Unique identifier corresponding to the main definition of a model in ASDC
19297 example: __MODEL-INVARIANT-ID__
19298 - name: model-version-id
19300 description: Unique identifier corresponding to one version of a model in ASDC
19303 example: __MODEL-VERSION-ID__
19308 example: __METANAME__
19311 - ServiceDesignAndCreation
19312 summary: create or update an existing metadatum
19314 Create or update an existing metadatum.
19316 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19317 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
19326 description: Response codes found in [response codes](https://wiki.onap.org/).
19328 - name: model-invariant-id
19330 description: Unique identifier corresponding to the main definition of a model in ASDC
19333 example: __MODEL-INVARIANT-ID__
19334 - name: model-version-id
19336 description: Unique identifier corresponding to one version of a model in ASDC
19339 example: __MODEL-VERSION-ID__
19344 example: __METANAME__
19347 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json)
19350 $ref: "#/definitions/metadatum"
19353 - ServiceDesignAndCreation
19354 summary: update an existing metadatum
19356 Update an existing metadatum
19358 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19359 The PUT operation will entirely replace an existing object.
19360 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19362 Other differences between PUT and PATCH are:
19364 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19365 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19366 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19367 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
19376 description: Response codes found in [response codes](https://wiki.onap.org/).
19378 - name: model-invariant-id
19380 description: Unique identifier corresponding to the main definition of a model in ASDC
19383 example: __MODEL-INVARIANT-ID__
19384 - name: model-version-id
19386 description: Unique identifier corresponding to one version of a model in ASDC
19389 example: __MODEL-VERSION-ID__
19394 example: __METANAME__
19397 description: metadatum object that needs to be updated.
19400 $ref: "#/patchDefinitions/metadatum"
19403 - ServiceDesignAndCreation
19404 summary: delete an existing metadatum
19405 description: delete an existing metadatum
19406 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
19415 description: Response codes found in [response codes](https://wiki.onap.org/).
19417 - name: model-invariant-id
19419 description: Unique identifier corresponding to the main definition of a model in ASDC
19422 example: __MODEL-INVARIANT-ID__
19423 - name: model-version-id
19425 description: Unique identifier corresponding to one version of a model in ASDC
19428 example: __MODEL-VERSION-ID__
19433 example: __METANAME__
19434 - name: resource-version
19436 description: resource-version for concurrency
19439 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata:
19442 - ServiceDesignAndCreation
19443 summary: returns metadata
19444 description: returns metadata
19445 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata
19451 description: successful operation
19453 $ref: "#/getDefinitions/metadata"
19455 description: Response codes found in [response codes](https://wiki.onap.org/).
19457 - name: model-invariant-id
19459 description: Unique identifier corresponding to the main definition of a model in ASDC
19462 example: __MODEL-INVARIANT-ID__
19463 - name: model-version-id
19465 description: Unique identifier corresponding to one version of a model in ASDC
19468 example: __MODEL-VERSION-ID__
19474 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship:
19477 - ServiceDesignAndCreation
19478 summary: see node definition for valid relationships
19479 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
19488 description: Response codes found in [response codes](https://wiki.onap.org/).
19490 - name: model-invariant-id
19492 description: Unique identifier corresponding to the main definition of a model in ASDC
19495 example: __MODEL-INVARIANT-ID__
19496 - name: model-version-id
19498 description: Unique identifier corresponding to one version of a model in ASDC
19501 example: __MODEL-VERSION-ID__
19504 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
19507 $ref: "#/definitions/relationship"
19510 - ServiceDesignAndCreation
19511 summary: delete an existing relationship
19512 description: delete an existing relationship
19513 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
19522 description: Response codes found in [response codes](https://wiki.onap.org/).
19524 - name: model-invariant-id
19526 description: Unique identifier corresponding to the main definition of a model in ASDC
19529 example: __MODEL-INVARIANT-ID__
19530 - name: model-version-id
19532 description: Unique identifier corresponding to one version of a model in ASDC
19535 example: __MODEL-VERSION-ID__
19536 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}:
19539 - ServiceDesignAndCreation
19540 summary: returns model-ver
19541 description: returns model-ver
19542 operationId: getServiceDesignAndCreationModelsModelModelVersModelVer
19548 description: successful operation
19550 $ref: "#/getDefinitions/model-ver"
19552 description: Response codes found in [response codes](https://wiki.onap.org/).
19554 - name: model-invariant-id
19556 description: Unique identifier corresponding to the main definition of a model in ASDC
19559 example: __MODEL-INVARIANT-ID__
19560 - name: model-version-id
19562 description: Unique identifier corresponding to one version of a model in ASDC
19565 example: __MODEL-VERSION-ID__
19568 - ServiceDesignAndCreation
19569 summary: create or update an existing model-ver
19571 Create or update an existing model-ver.
19573 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19574 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer
19583 description: Response codes found in [response codes](https://wiki.onap.org/).
19585 - name: model-invariant-id
19587 description: Unique identifier corresponding to the main definition of a model in ASDC
19590 example: __MODEL-INVARIANT-ID__
19591 - name: model-version-id
19593 description: Unique identifier corresponding to one version of a model in ASDC
19596 example: __MODEL-VERSION-ID__
19599 description: model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
19602 $ref: "#/definitions/model-ver"
19605 - ServiceDesignAndCreation
19606 summary: update an existing model-ver
19608 Update an existing model-ver
19610 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19611 The PUT operation will entirely replace an existing object.
19612 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19614 Other differences between PUT and PATCH are:
19616 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19617 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19618 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19619 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVer
19628 description: Response codes found in [response codes](https://wiki.onap.org/).
19630 - name: model-invariant-id
19632 description: Unique identifier corresponding to the main definition of a model in ASDC
19635 example: __MODEL-INVARIANT-ID__
19636 - name: model-version-id
19638 description: Unique identifier corresponding to one version of a model in ASDC
19641 example: __MODEL-VERSION-ID__
19644 description: model-ver object that needs to be updated.
19647 $ref: "#/patchDefinitions/model-ver"
19650 - ServiceDesignAndCreation
19651 summary: delete an existing model-ver
19652 description: delete an existing model-ver
19653 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVer
19662 description: Response codes found in [response codes](https://wiki.onap.org/).
19664 - name: model-invariant-id
19666 description: Unique identifier corresponding to the main definition of a model in ASDC
19669 example: __MODEL-INVARIANT-ID__
19670 - name: model-version-id
19672 description: Unique identifier corresponding to one version of a model in ASDC
19675 example: __MODEL-VERSION-ID__
19676 - name: resource-version
19678 description: resource-version for concurrency
19681 /service-design-and-creation/models/model/{model-invariant-id}/model-vers:
19684 - ServiceDesignAndCreation
19685 summary: returns model-vers
19686 description: returns model-vers
19687 operationId: getServiceDesignAndCreationModelsModelModelVers
19693 description: successful operation
19695 $ref: "#/getDefinitions/model-vers"
19697 description: Response codes found in [response codes](https://wiki.onap.org/).
19699 - name: model-invariant-id
19701 description: Unique identifier corresponding to the main definition of a model in ASDC
19704 example: __MODEL-INVARIANT-ID__
19705 - name: model-version-id
19715 - name: model-version
19720 - name: distribution-status
19725 /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship:
19728 - ServiceDesignAndCreation
19729 summary: see node definition for valid relationships
19730 operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship
19739 description: Response codes found in [response codes](https://wiki.onap.org/).
19741 - name: model-invariant-id
19743 description: Unique identifier corresponding to the main definition of a model in ASDC
19746 example: __MODEL-INVARIANT-ID__
19749 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModel.json)
19752 $ref: "#/definitions/relationship"
19755 - ServiceDesignAndCreation
19756 summary: delete an existing relationship
19757 description: delete an existing relationship
19758 operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship
19767 description: Response codes found in [response codes](https://wiki.onap.org/).
19769 - name: model-invariant-id
19771 description: Unique identifier corresponding to the main definition of a model in ASDC
19774 example: __MODEL-INVARIANT-ID__
19775 /service-design-and-creation/models/model/{model-invariant-id}:
19778 - ServiceDesignAndCreation
19779 summary: returns model
19780 description: returns model
19781 operationId: getServiceDesignAndCreationModelsModel
19787 description: successful operation
19789 $ref: "#/getDefinitions/model"
19791 description: Response codes found in [response codes](https://wiki.onap.org/).
19793 - name: model-invariant-id
19795 description: Unique identifier corresponding to the main definition of a model in ASDC
19798 example: __MODEL-INVARIANT-ID__
19801 - ServiceDesignAndCreation
19802 summary: create or update an existing model
19804 Create or update an existing model.
19806 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19807 operationId: createOrUpdateServiceDesignAndCreationModelsModel
19816 description: Response codes found in [response codes](https://wiki.onap.org/).
19818 - name: model-invariant-id
19820 description: Unique identifier corresponding to the main definition of a model in ASDC
19823 example: __MODEL-INVARIANT-ID__
19826 description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationModelsModel.json)
19829 $ref: "#/definitions/model"
19832 - ServiceDesignAndCreation
19833 summary: update an existing model
19835 Update an existing model
19837 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19838 The PUT operation will entirely replace an existing object.
19839 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19841 Other differences between PUT and PATCH are:
19843 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19844 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19845 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19846 operationId: UpdateServiceDesignAndCreationModelsModel
19855 description: Response codes found in [response codes](https://wiki.onap.org/).
19857 - name: model-invariant-id
19859 description: Unique identifier corresponding to the main definition of a model in ASDC
19862 example: __MODEL-INVARIANT-ID__
19865 description: model object that needs to be updated.
19868 $ref: "#/patchDefinitions/model"
19871 - ServiceDesignAndCreation
19872 summary: delete an existing model
19873 description: delete an existing model
19874 operationId: deleteServiceDesignAndCreationModelsModel
19883 description: Response codes found in [response codes](https://wiki.onap.org/).
19885 - name: model-invariant-id
19887 description: Unique identifier corresponding to the main definition of a model in ASDC
19890 example: __MODEL-INVARIANT-ID__
19891 - name: resource-version
19893 description: resource-version for concurrency
19896 /service-design-and-creation/models:
19899 - ServiceDesignAndCreation
19900 summary: returns models
19901 description: returns models
19902 operationId: getServiceDesignAndCreationModels
19908 description: successful operation
19910 $ref: "#/getDefinitions/models"
19912 description: Response codes found in [response codes](https://wiki.onap.org/).
19914 - name: model-invariant-id
19924 /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:
19927 - ServiceDesignAndCreation
19928 summary: see node definition for valid relationships
19929 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
19938 description: Response codes found in [response codes](https://wiki.onap.org/).
19940 - name: named-query-uuid
19944 example: __NAMED-QUERY-UUID__
19945 - name: named-query-element-uuid
19949 example: __NAMED-QUERY-ELEMENT-UUID__
19950 - name: related-lookup-uuid
19954 example: __RELATED-LOOKUP-UUID__
19957 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
19960 $ref: "#/definitions/relationship"
19963 - ServiceDesignAndCreation
19964 summary: delete an existing relationship
19965 description: delete an existing relationship
19966 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
19975 description: Response codes found in [response codes](https://wiki.onap.org/).
19977 - name: named-query-uuid
19981 example: __NAMED-QUERY-UUID__
19982 - name: named-query-element-uuid
19986 example: __NAMED-QUERY-ELEMENT-UUID__
19987 - name: related-lookup-uuid
19991 example: __RELATED-LOOKUP-UUID__
19992 /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}:
19995 - ServiceDesignAndCreation
19996 summary: returns related-lookup
19997 description: returns related-lookup
19998 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
20004 description: successful operation
20006 $ref: "#/getDefinitions/related-lookup"
20008 description: Response codes found in [response codes](https://wiki.onap.org/).
20010 - name: named-query-uuid
20014 example: __NAMED-QUERY-UUID__
20015 - name: named-query-element-uuid
20019 example: __NAMED-QUERY-ELEMENT-UUID__
20020 - name: related-lookup-uuid
20024 example: __RELATED-LOOKUP-UUID__
20027 - ServiceDesignAndCreation
20028 summary: create or update an existing related-lookup
20030 Create or update an existing related-lookup.
20032 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20033 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
20042 description: Response codes found in [response codes](https://wiki.onap.org/).
20044 - name: named-query-uuid
20048 example: __NAMED-QUERY-UUID__
20049 - name: named-query-element-uuid
20053 example: __NAMED-QUERY-ELEMENT-UUID__
20054 - name: related-lookup-uuid
20058 example: __RELATED-LOOKUP-UUID__
20061 description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
20064 $ref: "#/definitions/related-lookup"
20067 - ServiceDesignAndCreation
20068 summary: update an existing related-lookup
20070 Update an existing related-lookup
20072 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20073 The PUT operation will entirely replace an existing object.
20074 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20076 Other differences between PUT and PATCH are:
20078 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20079 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20080 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20081 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
20090 description: Response codes found in [response codes](https://wiki.onap.org/).
20092 - name: named-query-uuid
20096 example: __NAMED-QUERY-UUID__
20097 - name: named-query-element-uuid
20101 example: __NAMED-QUERY-ELEMENT-UUID__
20102 - name: related-lookup-uuid
20106 example: __RELATED-LOOKUP-UUID__
20109 description: related-lookup object that needs to be updated.
20112 $ref: "#/patchDefinitions/related-lookup"
20115 - ServiceDesignAndCreation
20116 summary: delete an existing related-lookup
20117 description: delete an existing related-lookup
20118 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
20127 description: Response codes found in [response codes](https://wiki.onap.org/).
20129 - name: named-query-uuid
20133 example: __NAMED-QUERY-UUID__
20134 - name: named-query-element-uuid
20138 example: __NAMED-QUERY-ELEMENT-UUID__
20139 - name: related-lookup-uuid
20143 example: __RELATED-LOOKUP-UUID__
20144 - name: resource-version
20146 description: resource-version for concurrency
20149 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups:
20152 - ServiceDesignAndCreation
20153 summary: returns related-lookups
20154 description: returns related-lookups
20155 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups
20161 description: successful operation
20163 $ref: "#/getDefinitions/related-lookups"
20165 description: Response codes found in [response codes](https://wiki.onap.org/).
20167 - name: named-query-uuid
20171 example: __NAMED-QUERY-UUID__
20172 - name: named-query-element-uuid
20176 example: __NAMED-QUERY-ELEMENT-UUID__
20177 - name: related-lookup-uuid
20182 /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}:
20185 - ServiceDesignAndCreation
20186 summary: returns property-constraint
20187 description: returns property-constraint
20188 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
20194 description: successful operation
20196 $ref: "#/getDefinitions/property-constraint"
20198 description: Response codes found in [response codes](https://wiki.onap.org/).
20200 - name: named-query-uuid
20204 example: __NAMED-QUERY-UUID__
20205 - name: named-query-element-uuid
20209 example: __NAMED-QUERY-ELEMENT-UUID__
20210 - name: property-constraint-uuid
20214 example: __PROPERTY-CONSTRAINT-UUID__
20217 - ServiceDesignAndCreation
20218 summary: create or update an existing property-constraint
20220 Create or update an existing property-constraint.
20222 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20223 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
20232 description: Response codes found in [response codes](https://wiki.onap.org/).
20234 - name: named-query-uuid
20238 example: __NAMED-QUERY-UUID__
20239 - name: named-query-element-uuid
20243 example: __NAMED-QUERY-ELEMENT-UUID__
20244 - name: property-constraint-uuid
20248 example: __PROPERTY-CONSTRAINT-UUID__
20251 description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)
20254 $ref: "#/definitions/property-constraint"
20257 - ServiceDesignAndCreation
20258 summary: update an existing property-constraint
20260 Update an existing property-constraint
20262 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20263 The PUT operation will entirely replace an existing object.
20264 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20266 Other differences between PUT and PATCH are:
20268 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20269 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20270 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20271 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
20280 description: Response codes found in [response codes](https://wiki.onap.org/).
20282 - name: named-query-uuid
20286 example: __NAMED-QUERY-UUID__
20287 - name: named-query-element-uuid
20291 example: __NAMED-QUERY-ELEMENT-UUID__
20292 - name: property-constraint-uuid
20296 example: __PROPERTY-CONSTRAINT-UUID__
20299 description: property-constraint object that needs to be updated.
20302 $ref: "#/patchDefinitions/property-constraint"
20305 - ServiceDesignAndCreation
20306 summary: delete an existing property-constraint
20307 description: delete an existing property-constraint
20308 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
20317 description: Response codes found in [response codes](https://wiki.onap.org/).
20319 - name: named-query-uuid
20323 example: __NAMED-QUERY-UUID__
20324 - name: named-query-element-uuid
20328 example: __NAMED-QUERY-ELEMENT-UUID__
20329 - name: property-constraint-uuid
20333 example: __PROPERTY-CONSTRAINT-UUID__
20334 - name: resource-version
20336 description: resource-version for concurrency
20339 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints:
20342 - ServiceDesignAndCreation
20343 summary: returns property-constraints
20344 description: returns property-constraints
20345 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints
20351 description: successful operation
20353 $ref: "#/getDefinitions/property-constraints"
20355 description: Response codes found in [response codes](https://wiki.onap.org/).
20357 - name: named-query-uuid
20361 example: __NAMED-QUERY-UUID__
20362 - name: named-query-element-uuid
20366 example: __NAMED-QUERY-ELEMENT-UUID__
20367 - name: property-constraint-uuid
20372 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship:
20375 - ServiceDesignAndCreation
20376 summary: see node definition for valid relationships
20377 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
20386 description: Response codes found in [response codes](https://wiki.onap.org/).
20388 - name: named-query-uuid
20392 example: __NAMED-QUERY-UUID__
20393 - name: named-query-element-uuid
20397 example: __NAMED-QUERY-ELEMENT-UUID__
20400 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
20403 $ref: "#/definitions/relationship"
20406 - ServiceDesignAndCreation
20407 summary: delete an existing relationship
20408 description: delete an existing relationship
20409 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
20418 description: Response codes found in [response codes](https://wiki.onap.org/).
20420 - name: named-query-uuid
20424 example: __NAMED-QUERY-UUID__
20425 - name: named-query-element-uuid
20429 example: __NAMED-QUERY-ELEMENT-UUID__
20430 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}:
20433 - ServiceDesignAndCreation
20434 summary: returns named-query-element
20435 description: returns named-query-element
20436 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
20442 description: successful operation
20444 $ref: "#/getDefinitions/named-query-element"
20446 description: Response codes found in [response codes](https://wiki.onap.org/).
20448 - name: named-query-uuid
20452 example: __NAMED-QUERY-UUID__
20453 - name: named-query-element-uuid
20457 example: __NAMED-QUERY-ELEMENT-UUID__
20460 - ServiceDesignAndCreation
20461 summary: create or update an existing named-query-element
20463 Create or update an existing named-query-element.
20465 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20466 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
20475 description: Response codes found in [response codes](https://wiki.onap.org/).
20477 - name: named-query-uuid
20481 example: __NAMED-QUERY-UUID__
20482 - name: named-query-element-uuid
20486 example: __NAMED-QUERY-ELEMENT-UUID__
20489 description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
20492 $ref: "#/definitions/named-query-element"
20495 - ServiceDesignAndCreation
20496 summary: update an existing named-query-element
20498 Update an existing named-query-element
20500 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20501 The PUT operation will entirely replace an existing object.
20502 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20504 Other differences between PUT and PATCH are:
20506 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20507 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20508 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20509 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
20518 description: Response codes found in [response codes](https://wiki.onap.org/).
20520 - name: named-query-uuid
20524 example: __NAMED-QUERY-UUID__
20525 - name: named-query-element-uuid
20529 example: __NAMED-QUERY-ELEMENT-UUID__
20532 description: named-query-element object that needs to be updated.
20535 $ref: "#/patchDefinitions/named-query-element"
20538 - ServiceDesignAndCreation
20539 summary: delete an existing named-query-element
20540 description: delete an existing named-query-element
20541 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
20550 description: Response codes found in [response codes](https://wiki.onap.org/).
20552 - name: named-query-uuid
20556 example: __NAMED-QUERY-UUID__
20557 - name: named-query-element-uuid
20561 example: __NAMED-QUERY-ELEMENT-UUID__
20562 - name: resource-version
20564 description: resource-version for concurrency
20567 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements:
20570 - ServiceDesignAndCreation
20571 summary: returns named-query-elements
20572 description: returns named-query-elements
20573 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements
20579 description: successful operation
20581 $ref: "#/getDefinitions/named-query-elements"
20583 description: Response codes found in [response codes](https://wiki.onap.org/).
20585 - name: named-query-uuid
20589 example: __NAMED-QUERY-UUID__
20590 - name: named-query-element-uuid
20595 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship:
20598 - ServiceDesignAndCreation
20599 summary: see node definition for valid relationships
20600 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
20609 description: Response codes found in [response codes](https://wiki.onap.org/).
20611 - name: named-query-uuid
20615 example: __NAMED-QUERY-UUID__
20618 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
20621 $ref: "#/definitions/relationship"
20624 - ServiceDesignAndCreation
20625 summary: delete an existing relationship
20626 description: delete an existing relationship
20627 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
20636 description: Response codes found in [response codes](https://wiki.onap.org/).
20638 - name: named-query-uuid
20642 example: __NAMED-QUERY-UUID__
20643 /service-design-and-creation/named-queries/named-query/{named-query-uuid}:
20646 - ServiceDesignAndCreation
20647 summary: returns named-query
20648 description: returns named-query
20649 operationId: getServiceDesignAndCreationNamedQueriesNamedQuery
20655 description: successful operation
20657 $ref: "#/getDefinitions/named-query"
20659 description: Response codes found in [response codes](https://wiki.onap.org/).
20661 - name: named-query-uuid
20665 example: __NAMED-QUERY-UUID__
20668 - ServiceDesignAndCreation
20669 summary: create or update an existing named-query
20671 Create or update an existing named-query.
20673 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20674 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery
20683 description: Response codes found in [response codes](https://wiki.onap.org/).
20685 - name: named-query-uuid
20689 example: __NAMED-QUERY-UUID__
20692 description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
20695 $ref: "#/definitions/named-query"
20698 - ServiceDesignAndCreation
20699 summary: update an existing named-query
20701 Update an existing named-query
20703 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20704 The PUT operation will entirely replace an existing object.
20705 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20707 Other differences between PUT and PATCH are:
20709 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20710 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20711 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20712 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQuery
20721 description: Response codes found in [response codes](https://wiki.onap.org/).
20723 - name: named-query-uuid
20727 example: __NAMED-QUERY-UUID__
20730 description: named-query object that needs to be updated.
20733 $ref: "#/patchDefinitions/named-query"
20736 - ServiceDesignAndCreation
20737 summary: delete an existing named-query
20738 description: delete an existing named-query
20739 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery
20748 description: Response codes found in [response codes](https://wiki.onap.org/).
20750 - name: named-query-uuid
20754 example: __NAMED-QUERY-UUID__
20755 - name: resource-version
20757 description: resource-version for concurrency
20760 /service-design-and-creation/named-queries:
20763 - ServiceDesignAndCreation
20764 summary: returns named-queries
20765 description: returns named-queries
20766 operationId: getServiceDesignAndCreationNamedQueries
20772 description: successful operation
20774 $ref: "#/getDefinitions/named-queries"
20776 description: Response codes found in [response codes](https://wiki.onap.org/).
20778 - name: named-query-uuid
20783 - name: named-query-name
20788 /network/logical-links/logical-link/{link-name}/relationship-list/relationship:
20792 summary: see node definition for valid relationships
20793 operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship
20802 description: Response codes found in [response codes](https://wiki.onap.org/).
20806 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20809 example: __LINK-NAME__
20812 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkLogicalLinksLogicalLink.json)
20815 $ref: "#/definitions/relationship"
20819 summary: delete an existing relationship
20820 description: delete an existing relationship
20821 operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship
20830 description: Response codes found in [response codes](https://wiki.onap.org/).
20834 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20837 example: __LINK-NAME__
20838 /network/logical-links/logical-link/{link-name}:
20842 summary: returns logical-link
20843 description: returns logical-link
20844 operationId: getNetworkLogicalLinksLogicalLink
20850 description: successful operation
20852 $ref: "#/getDefinitions/logical-link"
20854 description: Response codes found in [response codes](https://wiki.onap.org/).
20858 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20861 example: __LINK-NAME__
20865 summary: create or update an existing logical-link
20867 Create or update an existing logical-link.
20869 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20870 operationId: createOrUpdateNetworkLogicalLinksLogicalLink
20879 description: Response codes found in [response codes](https://wiki.onap.org/).
20883 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20886 example: __LINK-NAME__
20889 description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkLogicalLinksLogicalLink.json)
20892 $ref: "#/definitions/logical-link"
20896 summary: update an existing logical-link
20898 Update an existing logical-link
20900 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20901 The PUT operation will entirely replace an existing object.
20902 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20904 Other differences between PUT and PATCH are:
20906 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20907 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20908 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20909 operationId: UpdateNetworkLogicalLinksLogicalLink
20918 description: Response codes found in [response codes](https://wiki.onap.org/).
20922 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20925 example: __LINK-NAME__
20928 description: logical-link object that needs to be updated.
20931 $ref: "#/patchDefinitions/logical-link"
20935 summary: delete an existing logical-link
20936 description: delete an existing logical-link
20937 operationId: deleteNetworkLogicalLinksLogicalLink
20946 description: Response codes found in [response codes](https://wiki.onap.org/).
20950 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20953 example: __LINK-NAME__
20954 - name: resource-version
20956 description: resource-version for concurrency
20959 /network/logical-links:
20963 summary: returns logical-links
20964 description: returns logical-links
20965 operationId: getNetworkLogicalLinks
20971 description: successful operation
20973 $ref: "#/getDefinitions/logical-links"
20975 description: Response codes found in [response codes](https://wiki.onap.org/).
20982 - name: model-invariant-id
20987 - name: model-version-id
20992 - name: widget-model-id
20997 - name: widget-model-version
21002 - name: prov-status
21022 /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:
21026 summary: see node definition for valid relationships
21027 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
21036 description: Response codes found in [response codes](https://wiki.onap.org/).
21038 - name: site-pair-set-id
21040 description: Unique id of site pair set.
21043 example: __SITE-PAIR-SET-ID__
21044 - name: routing-instance-id
21046 description: Unique id of routing instance
21049 example: __ROUTING-INSTANCE-ID__
21050 - name: site-pair-id
21052 description: unique identifier of probe
21055 example: __SITE-PAIR-ID__
21058 description: unique identifier of probe
21064 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
21067 $ref: "#/definitions/relationship"
21071 summary: delete an existing relationship
21072 description: delete an existing relationship
21073 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
21082 description: Response codes found in [response codes](https://wiki.onap.org/).
21084 - name: site-pair-set-id
21086 description: Unique id of site pair set.
21089 example: __SITE-PAIR-SET-ID__
21090 - name: routing-instance-id
21092 description: Unique id of routing instance
21095 example: __ROUTING-INSTANCE-ID__
21096 - name: site-pair-id
21098 description: unique identifier of probe
21101 example: __SITE-PAIR-ID__
21104 description: unique identifier of probe
21108 /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}:
21112 summary: returns class-of-service
21113 description: returns class-of-service
21114 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
21120 description: successful operation
21122 $ref: "#/getDefinitions/class-of-service"
21124 description: Response codes found in [response codes](https://wiki.onap.org/).
21126 - name: site-pair-set-id
21128 description: Unique id of site pair set.
21131 example: __SITE-PAIR-SET-ID__
21132 - name: routing-instance-id
21134 description: Unique id of routing instance
21137 example: __ROUTING-INSTANCE-ID__
21138 - name: site-pair-id
21140 description: unique identifier of probe
21143 example: __SITE-PAIR-ID__
21146 description: unique identifier of probe
21153 summary: create or update an existing class-of-service
21155 Create or update an existing class-of-service.
21157 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21158 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
21167 description: Response codes found in [response codes](https://wiki.onap.org/).
21169 - name: site-pair-set-id
21171 description: Unique id of site pair set.
21174 example: __SITE-PAIR-SET-ID__
21175 - name: routing-instance-id
21177 description: Unique id of routing instance
21180 example: __ROUTING-INSTANCE-ID__
21181 - name: site-pair-id
21183 description: unique identifier of probe
21186 example: __SITE-PAIR-ID__
21189 description: unique identifier of probe
21195 description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
21198 $ref: "#/definitions/class-of-service"
21202 summary: update an existing class-of-service
21204 Update an existing class-of-service
21206 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21207 The PUT operation will entirely replace an existing object.
21208 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21210 Other differences between PUT and PATCH are:
21212 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21213 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21214 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21215 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
21224 description: Response codes found in [response codes](https://wiki.onap.org/).
21226 - name: site-pair-set-id
21228 description: Unique id of site pair set.
21231 example: __SITE-PAIR-SET-ID__
21232 - name: routing-instance-id
21234 description: Unique id of routing instance
21237 example: __ROUTING-INSTANCE-ID__
21238 - name: site-pair-id
21240 description: unique identifier of probe
21243 example: __SITE-PAIR-ID__
21246 description: unique identifier of probe
21252 description: class-of-service object that needs to be updated.
21255 $ref: "#/patchDefinitions/class-of-service"
21259 summary: delete an existing class-of-service
21260 description: delete an existing class-of-service
21261 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
21270 description: Response codes found in [response codes](https://wiki.onap.org/).
21272 - name: site-pair-set-id
21274 description: Unique id of site pair set.
21277 example: __SITE-PAIR-SET-ID__
21278 - name: routing-instance-id
21280 description: Unique id of routing instance
21283 example: __ROUTING-INSTANCE-ID__
21284 - name: site-pair-id
21286 description: unique identifier of probe
21289 example: __SITE-PAIR-ID__
21292 description: unique identifier of probe
21296 - name: resource-version
21298 description: resource-version for concurrency
21301 /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:
21305 summary: returns classes-of-service
21306 description: returns classes-of-service
21307 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService
21313 description: successful operation
21315 $ref: "#/getDefinitions/classes-of-service"
21317 description: Response codes found in [response codes](https://wiki.onap.org/).
21319 - name: site-pair-set-id
21321 description: Unique id of site pair set.
21324 example: __SITE-PAIR-SET-ID__
21325 - name: routing-instance-id
21327 description: Unique id of routing instance
21330 example: __ROUTING-INSTANCE-ID__
21331 - name: site-pair-id
21333 description: unique identifier of probe
21336 example: __SITE-PAIR-ID__
21342 /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:
21346 summary: see node definition for valid relationships
21347 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
21356 description: Response codes found in [response codes](https://wiki.onap.org/).
21358 - name: site-pair-set-id
21360 description: Unique id of site pair set.
21363 example: __SITE-PAIR-SET-ID__
21364 - name: routing-instance-id
21366 description: Unique id of routing instance
21369 example: __ROUTING-INSTANCE-ID__
21370 - name: site-pair-id
21372 description: unique identifier of probe
21375 example: __SITE-PAIR-ID__
21378 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
21381 $ref: "#/definitions/relationship"
21385 summary: delete an existing relationship
21386 description: delete an existing relationship
21387 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
21396 description: Response codes found in [response codes](https://wiki.onap.org/).
21398 - name: site-pair-set-id
21400 description: Unique id of site pair set.
21403 example: __SITE-PAIR-SET-ID__
21404 - name: routing-instance-id
21406 description: Unique id of routing instance
21409 example: __ROUTING-INSTANCE-ID__
21410 - name: site-pair-id
21412 description: unique identifier of probe
21415 example: __SITE-PAIR-ID__
21416 /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}:
21420 summary: returns site-pair
21421 description: returns site-pair
21422 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
21428 description: successful operation
21430 $ref: "#/getDefinitions/site-pair"
21432 description: Response codes found in [response codes](https://wiki.onap.org/).
21434 - name: site-pair-set-id
21436 description: Unique id of site pair set.
21439 example: __SITE-PAIR-SET-ID__
21440 - name: routing-instance-id
21442 description: Unique id of routing instance
21445 example: __ROUTING-INSTANCE-ID__
21446 - name: site-pair-id
21448 description: unique identifier of probe
21451 example: __SITE-PAIR-ID__
21455 summary: create or update an existing site-pair
21457 Create or update an existing site-pair.
21459 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21460 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
21469 description: Response codes found in [response codes](https://wiki.onap.org/).
21471 - name: site-pair-set-id
21473 description: Unique id of site pair set.
21476 example: __SITE-PAIR-SET-ID__
21477 - name: routing-instance-id
21479 description: Unique id of routing instance
21482 example: __ROUTING-INSTANCE-ID__
21483 - name: site-pair-id
21485 description: unique identifier of probe
21488 example: __SITE-PAIR-ID__
21491 description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
21494 $ref: "#/definitions/site-pair"
21498 summary: update an existing site-pair
21500 Update an existing site-pair
21502 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21503 The PUT operation will entirely replace an existing object.
21504 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21506 Other differences between PUT and PATCH are:
21508 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21509 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21510 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21511 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
21520 description: Response codes found in [response codes](https://wiki.onap.org/).
21522 - name: site-pair-set-id
21524 description: Unique id of site pair set.
21527 example: __SITE-PAIR-SET-ID__
21528 - name: routing-instance-id
21530 description: Unique id of routing instance
21533 example: __ROUTING-INSTANCE-ID__
21534 - name: site-pair-id
21536 description: unique identifier of probe
21539 example: __SITE-PAIR-ID__
21542 description: site-pair object that needs to be updated.
21545 $ref: "#/patchDefinitions/site-pair"
21549 summary: delete an existing site-pair
21550 description: delete an existing site-pair
21551 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
21560 description: Response codes found in [response codes](https://wiki.onap.org/).
21562 - name: site-pair-set-id
21564 description: Unique id of site pair set.
21567 example: __SITE-PAIR-SET-ID__
21568 - name: routing-instance-id
21570 description: Unique id of routing instance
21573 example: __ROUTING-INSTANCE-ID__
21574 - name: site-pair-id
21576 description: unique identifier of probe
21579 example: __SITE-PAIR-ID__
21580 - name: resource-version
21582 description: resource-version for concurrency
21585 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs:
21589 summary: returns site-pairs
21590 description: returns site-pairs
21591 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs
21597 description: successful operation
21599 $ref: "#/getDefinitions/site-pairs"
21601 description: Response codes found in [response codes](https://wiki.onap.org/).
21603 - name: site-pair-set-id
21605 description: Unique id of site pair set.
21608 example: __SITE-PAIR-SET-ID__
21609 - name: routing-instance-id
21611 description: Unique id of routing instance
21614 example: __ROUTING-INSTANCE-ID__
21615 - name: site-pair-id
21620 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship:
21624 summary: see node definition for valid relationships
21625 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
21634 description: Response codes found in [response codes](https://wiki.onap.org/).
21636 - name: site-pair-set-id
21638 description: Unique id of site pair set.
21641 example: __SITE-PAIR-SET-ID__
21642 - name: routing-instance-id
21644 description: Unique id of routing instance
21647 example: __ROUTING-INSTANCE-ID__
21650 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
21653 $ref: "#/definitions/relationship"
21657 summary: delete an existing relationship
21658 description: delete an existing relationship
21659 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
21668 description: Response codes found in [response codes](https://wiki.onap.org/).
21670 - name: site-pair-set-id
21672 description: Unique id of site pair set.
21675 example: __SITE-PAIR-SET-ID__
21676 - name: routing-instance-id
21678 description: Unique id of routing instance
21681 example: __ROUTING-INSTANCE-ID__
21682 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}:
21686 summary: returns routing-instance
21687 description: returns routing-instance
21688 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
21694 description: successful operation
21696 $ref: "#/getDefinitions/routing-instance"
21698 description: Response codes found in [response codes](https://wiki.onap.org/).
21700 - name: site-pair-set-id
21702 description: Unique id of site pair set.
21705 example: __SITE-PAIR-SET-ID__
21706 - name: routing-instance-id
21708 description: Unique id of routing instance
21711 example: __ROUTING-INSTANCE-ID__
21715 summary: create or update an existing routing-instance
21717 Create or update an existing routing-instance.
21719 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21720 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
21729 description: Response codes found in [response codes](https://wiki.onap.org/).
21731 - name: site-pair-set-id
21733 description: Unique id of site pair set.
21736 example: __SITE-PAIR-SET-ID__
21737 - name: routing-instance-id
21739 description: Unique id of routing instance
21742 example: __ROUTING-INSTANCE-ID__
21745 description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
21748 $ref: "#/definitions/routing-instance"
21752 summary: update an existing routing-instance
21754 Update an existing routing-instance
21756 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21757 The PUT operation will entirely replace an existing object.
21758 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21760 Other differences between PUT and PATCH are:
21762 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21763 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21764 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21765 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
21774 description: Response codes found in [response codes](https://wiki.onap.org/).
21776 - name: site-pair-set-id
21778 description: Unique id of site pair set.
21781 example: __SITE-PAIR-SET-ID__
21782 - name: routing-instance-id
21784 description: Unique id of routing instance
21787 example: __ROUTING-INSTANCE-ID__
21790 description: routing-instance object that needs to be updated.
21793 $ref: "#/patchDefinitions/routing-instance"
21797 summary: delete an existing routing-instance
21798 description: delete an existing routing-instance
21799 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
21808 description: Response codes found in [response codes](https://wiki.onap.org/).
21810 - name: site-pair-set-id
21812 description: Unique id of site pair set.
21815 example: __SITE-PAIR-SET-ID__
21816 - name: routing-instance-id
21818 description: Unique id of routing instance
21821 example: __ROUTING-INSTANCE-ID__
21822 - name: resource-version
21824 description: resource-version for concurrency
21827 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances:
21831 summary: returns routing-instances
21832 description: returns routing-instances
21833 operationId: getNetworkSitePairSetsSitePairSetRoutingInstances
21839 description: successful operation
21841 $ref: "#/getDefinitions/routing-instances"
21843 description: Response codes found in [response codes](https://wiki.onap.org/).
21845 - name: site-pair-set-id
21847 description: Unique id of site pair set.
21850 example: __SITE-PAIR-SET-ID__
21851 - name: routing-instance-id
21856 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship:
21860 summary: see node definition for valid relationships
21861 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship
21870 description: Response codes found in [response codes](https://wiki.onap.org/).
21872 - name: site-pair-set-id
21874 description: Unique id of site pair set.
21877 example: __SITE-PAIR-SET-ID__
21880 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSet.json)
21883 $ref: "#/definitions/relationship"
21887 summary: delete an existing relationship
21888 description: delete an existing relationship
21889 operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship
21898 description: Response codes found in [response codes](https://wiki.onap.org/).
21900 - name: site-pair-set-id
21902 description: Unique id of site pair set.
21905 example: __SITE-PAIR-SET-ID__
21906 /network/site-pair-sets/site-pair-set/{site-pair-set-id}:
21910 summary: returns site-pair-set
21911 description: returns site-pair-set
21912 operationId: getNetworkSitePairSetsSitePairSet
21918 description: successful operation
21920 $ref: "#/getDefinitions/site-pair-set"
21922 description: Response codes found in [response codes](https://wiki.onap.org/).
21924 - name: site-pair-set-id
21926 description: Unique id of site pair set.
21929 example: __SITE-PAIR-SET-ID__
21933 summary: create or update an existing site-pair-set
21935 Create or update an existing site-pair-set.
21937 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21938 operationId: createOrUpdateNetworkSitePairSetsSitePairSet
21947 description: Response codes found in [response codes](https://wiki.onap.org/).
21949 - name: site-pair-set-id
21951 description: Unique id of site pair set.
21954 example: __SITE-PAIR-SET-ID__
21957 description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkSitePairSetsSitePairSet.json)
21960 $ref: "#/definitions/site-pair-set"
21964 summary: update an existing site-pair-set
21966 Update an existing site-pair-set
21968 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21969 The PUT operation will entirely replace an existing object.
21970 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21972 Other differences between PUT and PATCH are:
21974 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21975 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21976 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21977 operationId: UpdateNetworkSitePairSetsSitePairSet
21986 description: Response codes found in [response codes](https://wiki.onap.org/).
21988 - name: site-pair-set-id
21990 description: Unique id of site pair set.
21993 example: __SITE-PAIR-SET-ID__
21996 description: site-pair-set object that needs to be updated.
21999 $ref: "#/patchDefinitions/site-pair-set"
22003 summary: delete an existing site-pair-set
22004 description: delete an existing site-pair-set
22005 operationId: deleteNetworkSitePairSetsSitePairSet
22014 description: Response codes found in [response codes](https://wiki.onap.org/).
22016 - name: site-pair-set-id
22018 description: Unique id of site pair set.
22021 example: __SITE-PAIR-SET-ID__
22022 - name: resource-version
22024 description: resource-version for concurrency
22027 /network/site-pair-sets:
22031 summary: returns site-pair-sets
22032 description: returns site-pair-sets
22033 operationId: getNetworkSitePairSets
22039 description: successful operation
22041 $ref: "#/getDefinitions/site-pair-sets"
22043 description: Response codes found in [response codes](https://wiki.onap.org/).
22045 - name: site-pair-set-id
22050 /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship:
22054 summary: see node definition for valid relationships
22055 operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
22064 description: Response codes found in [response codes](https://wiki.onap.org/).
22068 description: VPN ID, globally unique within A&AI
22071 example: __VPN-ID__
22072 - name: global-route-target
22074 description: Number used to identify an RT, globally unique in the network
22077 example: __GLOBAL-ROUTE-TARGET__
22078 - name: route-target-role
22080 description: Role assigned to this route target
22083 example: __ROUTE-TARGET-ROLE__
22086 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
22089 $ref: "#/definitions/relationship"
22093 summary: delete an existing relationship
22094 description: delete an existing relationship
22095 operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
22104 description: Response codes found in [response codes](https://wiki.onap.org/).
22108 description: VPN ID, globally unique within A&AI
22111 example: __VPN-ID__
22112 - name: global-route-target
22114 description: Number used to identify an RT, globally unique in the network
22117 example: __GLOBAL-ROUTE-TARGET__
22118 - name: route-target-role
22120 description: Role assigned to this route target
22123 example: __ROUTE-TARGET-ROLE__
22124 /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}:
22128 summary: returns route-target
22129 description: returns route-target
22130 operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
22136 description: successful operation
22138 $ref: "#/getDefinitions/route-target"
22140 description: Response codes found in [response codes](https://wiki.onap.org/).
22144 description: VPN ID, globally unique within A&AI
22147 example: __VPN-ID__
22148 - name: global-route-target
22150 description: Number used to identify an RT, globally unique in the network
22153 example: __GLOBAL-ROUTE-TARGET__
22154 - name: route-target-role
22156 description: Role assigned to this route target
22159 example: __ROUTE-TARGET-ROLE__
22163 summary: create or update an existing route-target
22165 Create or update an existing route-target.
22167 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22168 operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
22177 description: Response codes found in [response codes](https://wiki.onap.org/).
22181 description: VPN ID, globally unique within A&AI
22184 example: __VPN-ID__
22185 - name: global-route-target
22187 description: Number used to identify an RT, globally unique in the network
22190 example: __GLOBAL-ROUTE-TARGET__
22191 - name: route-target-role
22193 description: Role assigned to this route target
22196 example: __ROUTE-TARGET-ROLE__
22199 description: route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
22202 $ref: "#/definitions/route-target"
22206 summary: update an existing route-target
22208 Update an existing route-target
22210 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22211 The PUT operation will entirely replace an existing object.
22212 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22214 Other differences between PUT and PATCH are:
22216 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22217 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22218 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22219 operationId: UpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
22228 description: Response codes found in [response codes](https://wiki.onap.org/).
22232 description: VPN ID, globally unique within A&AI
22235 example: __VPN-ID__
22236 - name: global-route-target
22238 description: Number used to identify an RT, globally unique in the network
22241 example: __GLOBAL-ROUTE-TARGET__
22242 - name: route-target-role
22244 description: Role assigned to this route target
22247 example: __ROUTE-TARGET-ROLE__
22250 description: route-target object that needs to be updated.
22253 $ref: "#/patchDefinitions/route-target"
22257 summary: delete an existing route-target
22258 description: delete an existing route-target
22259 operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
22268 description: Response codes found in [response codes](https://wiki.onap.org/).
22272 description: VPN ID, globally unique within A&AI
22275 example: __VPN-ID__
22276 - name: global-route-target
22278 description: Number used to identify an RT, globally unique in the network
22281 example: __GLOBAL-ROUTE-TARGET__
22282 - name: route-target-role
22284 description: Role assigned to this route target
22287 example: __ROUTE-TARGET-ROLE__
22288 - name: resource-version
22290 description: resource-version for concurrency
22293 /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets:
22297 summary: returns route-targets
22298 description: returns route-targets
22299 operationId: getNetworkVpnBindingsVpnBindingRouteTargets
22305 description: successful operation
22307 $ref: "#/getDefinitions/route-targets"
22309 description: Response codes found in [response codes](https://wiki.onap.org/).
22313 description: VPN ID, globally unique within A&AI
22316 example: __VPN-ID__
22317 /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship:
22321 summary: see node definition for valid relationships
22322 operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship
22331 description: Response codes found in [response codes](https://wiki.onap.org/).
22335 description: VPN ID, globally unique within A&AI
22338 example: __VPN-ID__
22341 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBinding.json)
22344 $ref: "#/definitions/relationship"
22348 summary: delete an existing relationship
22349 description: delete an existing relationship
22350 operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship
22359 description: Response codes found in [response codes](https://wiki.onap.org/).
22363 description: VPN ID, globally unique within A&AI
22366 example: __VPN-ID__
22367 /network/vpn-bindings/vpn-binding/{vpn-id}:
22371 summary: returns vpn-binding
22372 description: returns vpn-binding
22373 operationId: getNetworkVpnBindingsVpnBinding
22379 description: successful operation
22381 $ref: "#/getDefinitions/vpn-binding"
22383 description: Response codes found in [response codes](https://wiki.onap.org/).
22387 description: VPN ID, globally unique within A&AI
22390 example: __VPN-ID__
22394 summary: create or update an existing vpn-binding
22396 Create or update an existing vpn-binding.
22398 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22399 operationId: createOrUpdateNetworkVpnBindingsVpnBinding
22408 description: Response codes found in [response codes](https://wiki.onap.org/).
22412 description: VPN ID, globally unique within A&AI
22415 example: __VPN-ID__
22418 description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVpnBindingsVpnBinding.json)
22421 $ref: "#/definitions/vpn-binding"
22425 summary: update an existing vpn-binding
22427 Update an existing vpn-binding
22429 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22430 The PUT operation will entirely replace an existing object.
22431 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22433 Other differences between PUT and PATCH are:
22435 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22436 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22437 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22438 operationId: UpdateNetworkVpnBindingsVpnBinding
22447 description: Response codes found in [response codes](https://wiki.onap.org/).
22451 description: VPN ID, globally unique within A&AI
22454 example: __VPN-ID__
22457 description: vpn-binding object that needs to be updated.
22460 $ref: "#/patchDefinitions/vpn-binding"
22464 summary: delete an existing vpn-binding
22465 description: delete an existing vpn-binding
22466 operationId: deleteNetworkVpnBindingsVpnBinding
22475 description: Response codes found in [response codes](https://wiki.onap.org/).
22479 description: VPN ID, globally unique within A&AI
22482 example: __VPN-ID__
22483 - name: resource-version
22485 description: resource-version for concurrency
22488 /network/vpn-bindings:
22492 summary: returns vpn-bindings
22493 description: returns vpn-bindings
22494 operationId: getNetworkVpnBindings
22500 description: successful operation
22502 $ref: "#/getDefinitions/vpn-bindings"
22504 description: Response codes found in [response codes](https://wiki.onap.org/).
22521 /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
22525 summary: see node definition for valid relationships
22526 operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship
22535 description: Response codes found in [response codes](https://wiki.onap.org/).
22537 - name: equipment-name
22541 example: __EQUIPMENT-NAME__
22544 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPe.json)
22547 $ref: "#/definitions/relationship"
22551 summary: delete an existing relationship
22552 description: delete an existing relationship
22553 operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship
22562 description: Response codes found in [response codes](https://wiki.onap.org/).
22564 - name: equipment-name
22568 example: __EQUIPMENT-NAME__
22569 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
22573 summary: see node definition for valid relationships
22574 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
22583 description: Response codes found in [response codes](https://wiki.onap.org/).
22585 - name: equipment-name
22589 example: __EQUIPMENT-NAME__
22590 - name: interface-name
22592 description: Name that identifies the physical interface
22595 example: __INTERFACE-NAME__
22598 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterface.json)
22601 $ref: "#/definitions/relationship"
22605 summary: delete an existing relationship
22606 description: delete an existing relationship
22607 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
22616 description: Response codes found in [response codes](https://wiki.onap.org/).
22618 - name: equipment-name
22622 example: __EQUIPMENT-NAME__
22623 - name: interface-name
22625 description: Name that identifies the physical interface
22628 example: __INTERFACE-NAME__
22629 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
22633 summary: see node definition for valid relationships
22634 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
22643 description: Response codes found in [response codes](https://wiki.onap.org/).
22645 - name: equipment-name
22649 example: __EQUIPMENT-NAME__
22650 - name: interface-name
22652 description: Name that identifies the physical interface
22655 example: __INTERFACE-NAME__
22658 description: Identifier for the sriov-pf
22661 example: __PF-PCI-ID__
22664 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)
22667 $ref: "#/definitions/relationship"
22671 summary: delete an existing relationship
22672 description: delete an existing relationship
22673 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
22682 description: Response codes found in [response codes](https://wiki.onap.org/).
22684 - name: equipment-name
22688 example: __EQUIPMENT-NAME__
22689 - name: interface-name
22691 description: Name that identifies the physical interface
22694 example: __INTERFACE-NAME__
22697 description: Identifier for the sriov-pf
22700 example: __PF-PCI-ID__
22701 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
22705 summary: returns sriov-pf
22706 description: returns sriov-pf
22707 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
22713 description: successful operation
22715 $ref: "#/getDefinitions/sriov-pf"
22717 description: Response codes found in [response codes](https://wiki.onap.org/).
22719 - name: equipment-name
22723 example: __EQUIPMENT-NAME__
22724 - name: interface-name
22726 description: Name that identifies the physical interface
22729 example: __INTERFACE-NAME__
22732 description: Identifier for the sriov-pf
22735 example: __PF-PCI-ID__
22739 summary: create or update an existing sriov-pf
22741 Create or update an existing sriov-pf.
22743 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22744 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
22753 description: Response codes found in [response codes](https://wiki.onap.org/).
22755 - name: equipment-name
22759 example: __EQUIPMENT-NAME__
22760 - name: interface-name
22762 description: Name that identifies the physical interface
22765 example: __INTERFACE-NAME__
22768 description: Identifier for the sriov-pf
22771 example: __PF-PCI-ID__
22774 description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)
22777 $ref: "#/definitions/sriov-pf"
22781 summary: update an existing sriov-pf
22783 Update an existing sriov-pf
22785 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22786 The PUT operation will entirely replace an existing object.
22787 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22789 Other differences between PUT and PATCH are:
22791 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22792 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22793 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22794 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
22803 description: Response codes found in [response codes](https://wiki.onap.org/).
22805 - name: equipment-name
22809 example: __EQUIPMENT-NAME__
22810 - name: interface-name
22812 description: Name that identifies the physical interface
22815 example: __INTERFACE-NAME__
22818 description: Identifier for the sriov-pf
22821 example: __PF-PCI-ID__
22824 description: sriov-pf object that needs to be updated.
22827 $ref: "#/patchDefinitions/sriov-pf"
22831 summary: delete an existing sriov-pf
22832 description: delete an existing sriov-pf
22833 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
22842 description: Response codes found in [response codes](https://wiki.onap.org/).
22844 - name: equipment-name
22848 example: __EQUIPMENT-NAME__
22849 - name: interface-name
22851 description: Name that identifies the physical interface
22854 example: __INTERFACE-NAME__
22857 description: Identifier for the sriov-pf
22860 example: __PF-PCI-ID__
22861 - name: resource-version
22863 description: resource-version for concurrency
22866 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
22870 summary: returns sriov-pfs
22871 description: returns sriov-pfs
22872 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfs
22878 description: successful operation
22880 $ref: "#/getDefinitions/sriov-pfs"
22882 description: Response codes found in [response codes](https://wiki.onap.org/).
22884 - name: equipment-name
22888 example: __EQUIPMENT-NAME__
22889 - name: interface-name
22891 description: Name that identifies the physical interface
22894 example: __INTERFACE-NAME__
22900 /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:
22904 summary: see node definition for valid relationships
22905 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
22914 description: Response codes found in [response codes](https://wiki.onap.org/).
22916 - name: equipment-name
22920 example: __EQUIPMENT-NAME__
22921 - name: interface-name
22923 description: Name that identifies the physical interface
22926 example: __INTERFACE-NAME__
22927 - name: interface-name
22929 description: Name given to the interface
22932 example: __INTERFACE-NAME__
22933 - name: vlan-interface
22935 description: String that identifies the interface
22938 example: __VLAN-INTERFACE__
22941 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
22944 $ref: "#/definitions/relationship"
22948 summary: delete an existing relationship
22949 description: delete an existing relationship
22950 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
22959 description: Response codes found in [response codes](https://wiki.onap.org/).
22961 - name: equipment-name
22965 example: __EQUIPMENT-NAME__
22966 - name: interface-name
22968 description: Name that identifies the physical interface
22971 example: __INTERFACE-NAME__
22972 - name: interface-name
22974 description: Name given to the interface
22977 example: __INTERFACE-NAME__
22978 - name: vlan-interface
22980 description: String that identifies the interface
22983 example: __VLAN-INTERFACE__
22984 /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:
22988 summary: see node definition for valid relationships
22989 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
22998 description: Response codes found in [response codes](https://wiki.onap.org/).
23000 - name: equipment-name
23004 example: __EQUIPMENT-NAME__
23005 - name: interface-name
23007 description: Name that identifies the physical interface
23010 example: __INTERFACE-NAME__
23011 - name: interface-name
23013 description: Name given to the interface
23016 example: __INTERFACE-NAME__
23017 - name: vlan-interface
23019 description: String that identifies the interface
23022 example: __VLAN-INTERFACE__
23023 - name: l3-interface-ipv4-address
23025 description: IP address
23028 example: __L3-INTERFACE-IPV4-ADDRESS__
23031 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
23034 $ref: "#/definitions/relationship"
23038 summary: delete an existing relationship
23039 description: delete an existing relationship
23040 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
23049 description: Response codes found in [response codes](https://wiki.onap.org/).
23051 - name: equipment-name
23055 example: __EQUIPMENT-NAME__
23056 - name: interface-name
23058 description: Name that identifies the physical interface
23061 example: __INTERFACE-NAME__
23062 - name: interface-name
23064 description: Name given to the interface
23067 example: __INTERFACE-NAME__
23068 - name: vlan-interface
23070 description: String that identifies the interface
23073 example: __VLAN-INTERFACE__
23074 - name: l3-interface-ipv4-address
23076 description: IP address
23079 example: __L3-INTERFACE-IPV4-ADDRESS__
23080 /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}:
23084 summary: returns l3-interface-ipv4-address-list
23085 description: returns l3-interface-ipv4-address-list
23086 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
23092 description: successful operation
23094 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
23096 description: Response codes found in [response codes](https://wiki.onap.org/).
23098 - name: equipment-name
23102 example: __EQUIPMENT-NAME__
23103 - name: interface-name
23105 description: Name that identifies the physical interface
23108 example: __INTERFACE-NAME__
23109 - name: interface-name
23111 description: Name given to the interface
23114 example: __INTERFACE-NAME__
23115 - name: vlan-interface
23117 description: String that identifies the interface
23120 example: __VLAN-INTERFACE__
23121 - name: l3-interface-ipv4-address
23123 description: IP address
23126 example: __L3-INTERFACE-IPV4-ADDRESS__
23130 summary: create or update an existing l3-interface-ipv4-address-list
23132 Create or update an existing l3-interface-ipv4-address-list.
23134 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23135 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
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 physical interface
23156 example: __INTERFACE-NAME__
23157 - name: interface-name
23159 description: Name given to the interface
23162 example: __INTERFACE-NAME__
23163 - name: vlan-interface
23165 description: String that identifies the interface
23168 example: __VLAN-INTERFACE__
23169 - name: l3-interface-ipv4-address
23171 description: IP address
23174 example: __L3-INTERFACE-IPV4-ADDRESS__
23177 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
23180 $ref: "#/definitions/l3-interface-ipv4-address-list"
23184 summary: update an existing l3-interface-ipv4-address-list
23186 Update an existing l3-interface-ipv4-address-list
23188 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23189 The PUT operation will entirely replace an existing object.
23190 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23192 Other differences between PUT and PATCH are:
23194 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23195 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23196 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23197 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
23206 description: Response codes found in [response codes](https://wiki.onap.org/).
23208 - name: equipment-name
23212 example: __EQUIPMENT-NAME__
23213 - name: interface-name
23215 description: Name that identifies the physical interface
23218 example: __INTERFACE-NAME__
23219 - name: interface-name
23221 description: Name given to the interface
23224 example: __INTERFACE-NAME__
23225 - name: vlan-interface
23227 description: String that identifies the interface
23230 example: __VLAN-INTERFACE__
23231 - name: l3-interface-ipv4-address
23233 description: IP address
23236 example: __L3-INTERFACE-IPV4-ADDRESS__
23239 description: l3-interface-ipv4-address-list object that needs to be updated.
23242 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
23246 summary: delete an existing l3-interface-ipv4-address-list
23247 description: delete an existing l3-interface-ipv4-address-list
23248 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
23257 description: Response codes found in [response codes](https://wiki.onap.org/).
23259 - name: equipment-name
23263 example: __EQUIPMENT-NAME__
23264 - name: interface-name
23266 description: Name that identifies the physical interface
23269 example: __INTERFACE-NAME__
23270 - name: interface-name
23272 description: Name given to the interface
23275 example: __INTERFACE-NAME__
23276 - name: vlan-interface
23278 description: String that identifies the interface
23281 example: __VLAN-INTERFACE__
23282 - name: l3-interface-ipv4-address
23284 description: IP address
23287 example: __L3-INTERFACE-IPV4-ADDRESS__
23288 - name: resource-version
23290 description: resource-version for concurrency
23293 /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:
23297 summary: see node definition for valid relationships
23298 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
23307 description: Response codes found in [response codes](https://wiki.onap.org/).
23309 - name: equipment-name
23313 example: __EQUIPMENT-NAME__
23314 - name: interface-name
23316 description: Name that identifies the physical interface
23319 example: __INTERFACE-NAME__
23320 - name: interface-name
23322 description: Name given to the interface
23325 example: __INTERFACE-NAME__
23326 - name: vlan-interface
23328 description: String that identifies the interface
23331 example: __VLAN-INTERFACE__
23332 - name: l3-interface-ipv6-address
23334 description: IP address
23337 example: __L3-INTERFACE-IPV6-ADDRESS__
23340 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
23343 $ref: "#/definitions/relationship"
23347 summary: delete an existing relationship
23348 description: delete an existing relationship
23349 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
23358 description: Response codes found in [response codes](https://wiki.onap.org/).
23360 - name: equipment-name
23364 example: __EQUIPMENT-NAME__
23365 - name: interface-name
23367 description: Name that identifies the physical interface
23370 example: __INTERFACE-NAME__
23371 - name: interface-name
23373 description: Name given to the interface
23376 example: __INTERFACE-NAME__
23377 - name: vlan-interface
23379 description: String that identifies the interface
23382 example: __VLAN-INTERFACE__
23383 - name: l3-interface-ipv6-address
23385 description: IP address
23388 example: __L3-INTERFACE-IPV6-ADDRESS__
23389 /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}:
23393 summary: returns l3-interface-ipv6-address-list
23394 description: returns l3-interface-ipv6-address-list
23395 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
23401 description: successful operation
23403 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
23405 description: Response codes found in [response codes](https://wiki.onap.org/).
23407 - name: equipment-name
23411 example: __EQUIPMENT-NAME__
23412 - name: interface-name
23414 description: Name that identifies the physical interface
23417 example: __INTERFACE-NAME__
23418 - name: interface-name
23420 description: Name given to the interface
23423 example: __INTERFACE-NAME__
23424 - name: vlan-interface
23426 description: String that identifies the interface
23429 example: __VLAN-INTERFACE__
23430 - name: l3-interface-ipv6-address
23432 description: IP address
23435 example: __L3-INTERFACE-IPV6-ADDRESS__
23439 summary: create or update an existing l3-interface-ipv6-address-list
23441 Create or update an existing l3-interface-ipv6-address-list.
23443 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23444 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
23453 description: Response codes found in [response codes](https://wiki.onap.org/).
23455 - name: equipment-name
23459 example: __EQUIPMENT-NAME__
23460 - name: interface-name
23462 description: Name that identifies the physical interface
23465 example: __INTERFACE-NAME__
23466 - name: interface-name
23468 description: Name given to the interface
23471 example: __INTERFACE-NAME__
23472 - name: vlan-interface
23474 description: String that identifies the interface
23477 example: __VLAN-INTERFACE__
23478 - name: l3-interface-ipv6-address
23480 description: IP address
23483 example: __L3-INTERFACE-IPV6-ADDRESS__
23486 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
23489 $ref: "#/definitions/l3-interface-ipv6-address-list"
23493 summary: update an existing l3-interface-ipv6-address-list
23495 Update an existing l3-interface-ipv6-address-list
23497 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23498 The PUT operation will entirely replace an existing object.
23499 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23501 Other differences between PUT and PATCH are:
23503 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23504 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23505 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23506 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
23515 description: Response codes found in [response codes](https://wiki.onap.org/).
23517 - name: equipment-name
23521 example: __EQUIPMENT-NAME__
23522 - name: interface-name
23524 description: Name that identifies the physical interface
23527 example: __INTERFACE-NAME__
23528 - name: interface-name
23530 description: Name given to the interface
23533 example: __INTERFACE-NAME__
23534 - name: vlan-interface
23536 description: String that identifies the interface
23539 example: __VLAN-INTERFACE__
23540 - name: l3-interface-ipv6-address
23542 description: IP address
23545 example: __L3-INTERFACE-IPV6-ADDRESS__
23548 description: l3-interface-ipv6-address-list object that needs to be updated.
23551 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
23555 summary: delete an existing l3-interface-ipv6-address-list
23556 description: delete an existing l3-interface-ipv6-address-list
23557 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
23566 description: Response codes found in [response codes](https://wiki.onap.org/).
23568 - name: equipment-name
23572 example: __EQUIPMENT-NAME__
23573 - name: interface-name
23575 description: Name that identifies the physical interface
23578 example: __INTERFACE-NAME__
23579 - name: interface-name
23581 description: Name given to the interface
23584 example: __INTERFACE-NAME__
23585 - name: vlan-interface
23587 description: String that identifies the interface
23590 example: __VLAN-INTERFACE__
23591 - name: l3-interface-ipv6-address
23593 description: IP address
23596 example: __L3-INTERFACE-IPV6-ADDRESS__
23597 - name: resource-version
23599 description: resource-version for concurrency
23602 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
23606 summary: returns vlan
23607 description: returns vlan
23608 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
23614 description: successful operation
23616 $ref: "#/getDefinitions/vlan"
23618 description: Response codes found in [response codes](https://wiki.onap.org/).
23620 - name: equipment-name
23624 example: __EQUIPMENT-NAME__
23625 - name: interface-name
23627 description: Name that identifies the physical interface
23630 example: __INTERFACE-NAME__
23631 - name: interface-name
23633 description: Name given to the interface
23636 example: __INTERFACE-NAME__
23637 - name: vlan-interface
23639 description: String that identifies the interface
23642 example: __VLAN-INTERFACE__
23646 summary: create or update an existing vlan
23648 Create or update an existing vlan.
23650 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23651 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
23660 description: Response codes found in [response codes](https://wiki.onap.org/).
23662 - name: equipment-name
23666 example: __EQUIPMENT-NAME__
23667 - name: interface-name
23669 description: Name that identifies the physical interface
23672 example: __INTERFACE-NAME__
23673 - name: interface-name
23675 description: Name given to the interface
23678 example: __INTERFACE-NAME__
23679 - name: vlan-interface
23681 description: String that identifies the interface
23684 example: __VLAN-INTERFACE__
23687 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
23690 $ref: "#/definitions/vlan"
23694 summary: update an existing vlan
23696 Update an existing vlan
23698 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23699 The PUT operation will entirely replace an existing object.
23700 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23702 Other differences between PUT and PATCH are:
23704 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23705 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23706 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23707 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
23716 description: Response codes found in [response codes](https://wiki.onap.org/).
23718 - name: equipment-name
23722 example: __EQUIPMENT-NAME__
23723 - name: interface-name
23725 description: Name that identifies the physical interface
23728 example: __INTERFACE-NAME__
23729 - name: interface-name
23731 description: Name given to the interface
23734 example: __INTERFACE-NAME__
23735 - name: vlan-interface
23737 description: String that identifies the interface
23740 example: __VLAN-INTERFACE__
23743 description: vlan object that needs to be updated.
23746 $ref: "#/patchDefinitions/vlan"
23750 summary: delete an existing vlan
23751 description: delete an existing vlan
23752 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
23761 description: Response codes found in [response codes](https://wiki.onap.org/).
23763 - name: equipment-name
23767 example: __EQUIPMENT-NAME__
23768 - name: interface-name
23770 description: Name that identifies the physical interface
23773 example: __INTERFACE-NAME__
23774 - name: interface-name
23776 description: Name given to the interface
23779 example: __INTERFACE-NAME__
23780 - name: vlan-interface
23782 description: String that identifies the interface
23785 example: __VLAN-INTERFACE__
23786 - name: resource-version
23788 description: resource-version for concurrency
23791 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
23795 summary: returns vlans
23796 description: returns vlans
23797 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans
23803 description: successful operation
23805 $ref: "#/getDefinitions/vlans"
23807 description: Response codes found in [response codes](https://wiki.onap.org/).
23809 - name: equipment-name
23813 example: __EQUIPMENT-NAME__
23814 - name: interface-name
23816 description: Name that identifies the physical interface
23819 example: __INTERFACE-NAME__
23820 - name: interface-name
23822 description: Name given to the interface
23825 example: __INTERFACE-NAME__
23826 - name: vlan-interface
23831 - name: vlan-id-inner
23842 /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:
23846 summary: see node definition for valid relationships
23847 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
23856 description: Response codes found in [response codes](https://wiki.onap.org/).
23858 - name: equipment-name
23862 example: __EQUIPMENT-NAME__
23863 - name: interface-name
23865 description: Name that identifies the physical interface
23868 example: __INTERFACE-NAME__
23869 - name: interface-name
23871 description: Name given to the interface
23874 example: __INTERFACE-NAME__
23877 description: PCI ID used to identify the sriov-vf
23880 example: __PCI-ID__
23883 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
23886 $ref: "#/definitions/relationship"
23890 summary: delete an existing relationship
23891 description: delete an existing relationship
23892 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
23901 description: Response codes found in [response codes](https://wiki.onap.org/).
23903 - name: equipment-name
23907 example: __EQUIPMENT-NAME__
23908 - name: interface-name
23910 description: Name that identifies the physical interface
23913 example: __INTERFACE-NAME__
23914 - name: interface-name
23916 description: Name given to the interface
23919 example: __INTERFACE-NAME__
23922 description: PCI ID used to identify the sriov-vf
23925 example: __PCI-ID__
23926 /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}:
23930 summary: returns sriov-vf
23931 description: returns sriov-vf
23932 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
23938 description: successful operation
23940 $ref: "#/getDefinitions/sriov-vf"
23942 description: Response codes found in [response codes](https://wiki.onap.org/).
23944 - name: equipment-name
23948 example: __EQUIPMENT-NAME__
23949 - name: interface-name
23951 description: Name that identifies the physical interface
23954 example: __INTERFACE-NAME__
23955 - name: interface-name
23957 description: Name given to the interface
23960 example: __INTERFACE-NAME__
23963 description: PCI ID used to identify the sriov-vf
23966 example: __PCI-ID__
23970 summary: create or update an existing sriov-vf
23972 Create or update an existing sriov-vf.
23974 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23975 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
23984 description: Response codes found in [response codes](https://wiki.onap.org/).
23986 - name: equipment-name
23990 example: __EQUIPMENT-NAME__
23991 - name: interface-name
23993 description: Name that identifies the physical interface
23996 example: __INTERFACE-NAME__
23997 - name: interface-name
23999 description: Name given to the interface
24002 example: __INTERFACE-NAME__
24005 description: PCI ID used to identify the sriov-vf
24008 example: __PCI-ID__
24011 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
24014 $ref: "#/definitions/sriov-vf"
24018 summary: update an existing sriov-vf
24020 Update an existing sriov-vf
24022 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24023 The PUT operation will entirely replace an existing object.
24024 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24026 Other differences between PUT and PATCH are:
24028 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24029 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24030 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24031 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
24040 description: Response codes found in [response codes](https://wiki.onap.org/).
24042 - name: equipment-name
24046 example: __EQUIPMENT-NAME__
24047 - name: interface-name
24049 description: Name that identifies the physical interface
24052 example: __INTERFACE-NAME__
24053 - name: interface-name
24055 description: Name given to the interface
24058 example: __INTERFACE-NAME__
24061 description: PCI ID used to identify the sriov-vf
24064 example: __PCI-ID__
24067 description: sriov-vf object that needs to be updated.
24070 $ref: "#/patchDefinitions/sriov-vf"
24074 summary: delete an existing sriov-vf
24075 description: delete an existing sriov-vf
24076 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
24085 description: Response codes found in [response codes](https://wiki.onap.org/).
24087 - name: equipment-name
24091 example: __EQUIPMENT-NAME__
24092 - name: interface-name
24094 description: Name that identifies the physical interface
24097 example: __INTERFACE-NAME__
24098 - name: interface-name
24100 description: Name given to the interface
24103 example: __INTERFACE-NAME__
24106 description: PCI ID used to identify the sriov-vf
24109 example: __PCI-ID__
24110 - name: resource-version
24112 description: resource-version for concurrency
24115 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
24119 summary: returns sriov-vfs
24120 description: returns sriov-vfs
24121 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
24127 description: successful operation
24129 $ref: "#/getDefinitions/sriov-vfs"
24131 description: Response codes found in [response codes](https://wiki.onap.org/).
24133 - name: equipment-name
24137 example: __EQUIPMENT-NAME__
24138 - name: interface-name
24140 description: Name that identifies the physical interface
24143 example: __INTERFACE-NAME__
24144 - name: interface-name
24146 description: Name given to the interface
24149 example: __INTERFACE-NAME__
24155 - name: vf-vlan-filter
24160 - name: vf-mac-filter
24165 - name: vf-vlan-strip
24170 - name: neutron-network-id
24175 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
24179 summary: see node definition for valid relationships
24180 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
24189 description: Response codes found in [response codes](https://wiki.onap.org/).
24191 - name: equipment-name
24195 example: __EQUIPMENT-NAME__
24196 - name: interface-name
24198 description: Name that identifies the physical interface
24201 example: __INTERFACE-NAME__
24202 - name: interface-name
24204 description: Name given to the interface
24207 example: __INTERFACE-NAME__
24210 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
24213 $ref: "#/definitions/relationship"
24217 summary: delete an existing relationship
24218 description: delete an existing relationship
24219 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
24228 description: Response codes found in [response codes](https://wiki.onap.org/).
24230 - name: equipment-name
24234 example: __EQUIPMENT-NAME__
24235 - name: interface-name
24237 description: Name that identifies the physical interface
24240 example: __INTERFACE-NAME__
24241 - name: interface-name
24243 description: Name given to the interface
24246 example: __INTERFACE-NAME__
24247 /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:
24251 summary: see node definition for valid relationships
24252 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
24261 description: Response codes found in [response codes](https://wiki.onap.org/).
24263 - name: equipment-name
24267 example: __EQUIPMENT-NAME__
24268 - name: interface-name
24270 description: Name that identifies the physical interface
24273 example: __INTERFACE-NAME__
24274 - name: interface-name
24276 description: Name given to the interface
24279 example: __INTERFACE-NAME__
24280 - name: l3-interface-ipv4-address
24282 description: IP address
24285 example: __L3-INTERFACE-IPV4-ADDRESS__
24288 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
24291 $ref: "#/definitions/relationship"
24295 summary: delete an existing relationship
24296 description: delete an existing relationship
24297 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
24306 description: Response codes found in [response codes](https://wiki.onap.org/).
24308 - name: equipment-name
24312 example: __EQUIPMENT-NAME__
24313 - name: interface-name
24315 description: Name that identifies the physical interface
24318 example: __INTERFACE-NAME__
24319 - name: interface-name
24321 description: Name given to the interface
24324 example: __INTERFACE-NAME__
24325 - name: l3-interface-ipv4-address
24327 description: IP address
24330 example: __L3-INTERFACE-IPV4-ADDRESS__
24331 /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}:
24335 summary: returns l3-interface-ipv4-address-list
24336 description: returns l3-interface-ipv4-address-list
24337 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
24343 description: successful operation
24345 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
24347 description: Response codes found in [response codes](https://wiki.onap.org/).
24349 - name: equipment-name
24353 example: __EQUIPMENT-NAME__
24354 - name: interface-name
24356 description: Name that identifies the physical interface
24359 example: __INTERFACE-NAME__
24360 - name: interface-name
24362 description: Name given to the interface
24365 example: __INTERFACE-NAME__
24366 - name: l3-interface-ipv4-address
24368 description: IP address
24371 example: __L3-INTERFACE-IPV4-ADDRESS__
24375 summary: create or update an existing l3-interface-ipv4-address-list
24377 Create or update an existing l3-interface-ipv4-address-list.
24379 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24380 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
24389 description: Response codes found in [response codes](https://wiki.onap.org/).
24391 - name: equipment-name
24395 example: __EQUIPMENT-NAME__
24396 - name: interface-name
24398 description: Name that identifies the physical interface
24401 example: __INTERFACE-NAME__
24402 - name: interface-name
24404 description: Name given to the interface
24407 example: __INTERFACE-NAME__
24408 - name: l3-interface-ipv4-address
24410 description: IP address
24413 example: __L3-INTERFACE-IPV4-ADDRESS__
24416 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
24419 $ref: "#/definitions/l3-interface-ipv4-address-list"
24423 summary: update an existing l3-interface-ipv4-address-list
24425 Update an existing l3-interface-ipv4-address-list
24427 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24428 The PUT operation will entirely replace an existing object.
24429 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24431 Other differences between PUT and PATCH are:
24433 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24434 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24435 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24436 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
24445 description: Response codes found in [response codes](https://wiki.onap.org/).
24447 - name: equipment-name
24451 example: __EQUIPMENT-NAME__
24452 - name: interface-name
24454 description: Name that identifies the physical interface
24457 example: __INTERFACE-NAME__
24458 - name: interface-name
24460 description: Name given to the interface
24463 example: __INTERFACE-NAME__
24464 - name: l3-interface-ipv4-address
24466 description: IP address
24469 example: __L3-INTERFACE-IPV4-ADDRESS__
24472 description: l3-interface-ipv4-address-list object that needs to be updated.
24475 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
24479 summary: delete an existing l3-interface-ipv4-address-list
24480 description: delete an existing l3-interface-ipv4-address-list
24481 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
24490 description: Response codes found in [response codes](https://wiki.onap.org/).
24492 - name: equipment-name
24496 example: __EQUIPMENT-NAME__
24497 - name: interface-name
24499 description: Name that identifies the physical interface
24502 example: __INTERFACE-NAME__
24503 - name: interface-name
24505 description: Name given to the interface
24508 example: __INTERFACE-NAME__
24509 - name: l3-interface-ipv4-address
24511 description: IP address
24514 example: __L3-INTERFACE-IPV4-ADDRESS__
24515 - name: resource-version
24517 description: resource-version for concurrency
24520 /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:
24524 summary: see node definition for valid relationships
24525 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
24534 description: Response codes found in [response codes](https://wiki.onap.org/).
24536 - name: equipment-name
24540 example: __EQUIPMENT-NAME__
24541 - name: interface-name
24543 description: Name that identifies the physical interface
24546 example: __INTERFACE-NAME__
24547 - name: interface-name
24549 description: Name given to the interface
24552 example: __INTERFACE-NAME__
24553 - name: l3-interface-ipv6-address
24555 description: IP address
24558 example: __L3-INTERFACE-IPV6-ADDRESS__
24561 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
24564 $ref: "#/definitions/relationship"
24568 summary: delete an existing relationship
24569 description: delete an existing relationship
24570 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
24579 description: Response codes found in [response codes](https://wiki.onap.org/).
24581 - name: equipment-name
24585 example: __EQUIPMENT-NAME__
24586 - name: interface-name
24588 description: Name that identifies the physical interface
24591 example: __INTERFACE-NAME__
24592 - name: interface-name
24594 description: Name given to the interface
24597 example: __INTERFACE-NAME__
24598 - name: l3-interface-ipv6-address
24600 description: IP address
24603 example: __L3-INTERFACE-IPV6-ADDRESS__
24604 /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}:
24608 summary: returns l3-interface-ipv6-address-list
24609 description: returns l3-interface-ipv6-address-list
24610 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
24616 description: successful operation
24618 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
24620 description: Response codes found in [response codes](https://wiki.onap.org/).
24622 - name: equipment-name
24626 example: __EQUIPMENT-NAME__
24627 - name: interface-name
24629 description: Name that identifies the physical interface
24632 example: __INTERFACE-NAME__
24633 - name: interface-name
24635 description: Name given to the interface
24638 example: __INTERFACE-NAME__
24639 - name: l3-interface-ipv6-address
24641 description: IP address
24644 example: __L3-INTERFACE-IPV6-ADDRESS__
24648 summary: create or update an existing l3-interface-ipv6-address-list
24650 Create or update an existing l3-interface-ipv6-address-list.
24652 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24653 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
24662 description: Response codes found in [response codes](https://wiki.onap.org/).
24664 - name: equipment-name
24668 example: __EQUIPMENT-NAME__
24669 - name: interface-name
24671 description: Name that identifies the physical interface
24674 example: __INTERFACE-NAME__
24675 - name: interface-name
24677 description: Name given to the interface
24680 example: __INTERFACE-NAME__
24681 - name: l3-interface-ipv6-address
24683 description: IP address
24686 example: __L3-INTERFACE-IPV6-ADDRESS__
24689 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
24692 $ref: "#/definitions/l3-interface-ipv6-address-list"
24696 summary: update an existing l3-interface-ipv6-address-list
24698 Update an existing l3-interface-ipv6-address-list
24700 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24701 The PUT operation will entirely replace an existing object.
24702 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24704 Other differences between PUT and PATCH are:
24706 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24707 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24708 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24709 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
24718 description: Response codes found in [response codes](https://wiki.onap.org/).
24720 - name: equipment-name
24724 example: __EQUIPMENT-NAME__
24725 - name: interface-name
24727 description: Name that identifies the physical interface
24730 example: __INTERFACE-NAME__
24731 - name: interface-name
24733 description: Name given to the interface
24736 example: __INTERFACE-NAME__
24737 - name: l3-interface-ipv6-address
24739 description: IP address
24742 example: __L3-INTERFACE-IPV6-ADDRESS__
24745 description: l3-interface-ipv6-address-list object that needs to be updated.
24748 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
24752 summary: delete an existing l3-interface-ipv6-address-list
24753 description: delete an existing l3-interface-ipv6-address-list
24754 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
24763 description: Response codes found in [response codes](https://wiki.onap.org/).
24765 - name: equipment-name
24769 example: __EQUIPMENT-NAME__
24770 - name: interface-name
24772 description: Name that identifies the physical interface
24775 example: __INTERFACE-NAME__
24776 - name: interface-name
24778 description: Name given to the interface
24781 example: __INTERFACE-NAME__
24782 - name: l3-interface-ipv6-address
24784 description: IP address
24787 example: __L3-INTERFACE-IPV6-ADDRESS__
24788 - name: resource-version
24790 description: resource-version for concurrency
24793 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
24797 summary: returns l-interface
24798 description: returns l-interface
24799 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
24805 description: successful operation
24807 $ref: "#/getDefinitions/l-interface"
24809 description: Response codes found in [response codes](https://wiki.onap.org/).
24811 - name: equipment-name
24815 example: __EQUIPMENT-NAME__
24816 - name: interface-name
24818 description: Name that identifies the physical interface
24821 example: __INTERFACE-NAME__
24822 - name: interface-name
24824 description: Name given to the interface
24827 example: __INTERFACE-NAME__
24831 summary: create or update an existing l-interface
24833 Create or update an existing l-interface.
24835 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24836 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
24845 description: Response codes found in [response codes](https://wiki.onap.org/).
24847 - name: equipment-name
24851 example: __EQUIPMENT-NAME__
24852 - name: interface-name
24854 description: Name that identifies the physical interface
24857 example: __INTERFACE-NAME__
24858 - name: interface-name
24860 description: Name given to the interface
24863 example: __INTERFACE-NAME__
24866 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
24869 $ref: "#/definitions/l-interface"
24873 summary: update an existing l-interface
24875 Update an existing l-interface
24877 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24878 The PUT operation will entirely replace an existing object.
24879 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24881 Other differences between PUT and PATCH are:
24883 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24884 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24885 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24886 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
24895 description: Response codes found in [response codes](https://wiki.onap.org/).
24897 - name: equipment-name
24901 example: __EQUIPMENT-NAME__
24902 - name: interface-name
24904 description: Name that identifies the physical interface
24907 example: __INTERFACE-NAME__
24908 - name: interface-name
24910 description: Name given to the interface
24913 example: __INTERFACE-NAME__
24916 description: l-interface object that needs to be updated.
24919 $ref: "#/patchDefinitions/l-interface"
24923 summary: delete an existing l-interface
24924 description: delete an existing l-interface
24925 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
24934 description: Response codes found in [response codes](https://wiki.onap.org/).
24936 - name: equipment-name
24940 example: __EQUIPMENT-NAME__
24941 - name: interface-name
24943 description: Name that identifies the physical interface
24946 example: __INTERFACE-NAME__
24947 - name: interface-name
24949 description: Name given to the interface
24952 example: __INTERFACE-NAME__
24953 - name: resource-version
24955 description: resource-version for concurrency
24958 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
24962 summary: returns l-interfaces
24963 description: returns l-interfaces
24964 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces
24970 description: successful operation
24972 $ref: "#/getDefinitions/l-interfaces"
24974 description: Response codes found in [response codes](https://wiki.onap.org/).
24976 - name: equipment-name
24980 example: __EQUIPMENT-NAME__
24981 - name: interface-name
24983 description: Name that identifies the physical interface
24986 example: __INTERFACE-NAME__
24987 - name: interface-name
24992 - name: interface-id
25002 - name: network-name
25007 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}:
25011 summary: returns p-interface
25012 description: returns p-interface
25013 operationId: getNetworkVplsPesVplsPePInterfacesPInterface
25019 description: successful operation
25021 $ref: "#/getDefinitions/p-interface"
25023 description: Response codes found in [response codes](https://wiki.onap.org/).
25025 - name: equipment-name
25029 example: __EQUIPMENT-NAME__
25030 - name: interface-name
25032 description: Name that identifies the physical interface
25035 example: __INTERFACE-NAME__
25039 summary: create or update an existing p-interface
25041 Create or update an existing p-interface.
25043 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25044 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface
25053 description: Response codes found in [response codes](https://wiki.onap.org/).
25055 - name: equipment-name
25059 example: __EQUIPMENT-NAME__
25060 - name: interface-name
25062 description: Name that identifies the physical interface
25065 example: __INTERFACE-NAME__
25068 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPePInterfacesPInterface.json)
25071 $ref: "#/definitions/p-interface"
25075 summary: update an existing p-interface
25077 Update an existing p-interface
25079 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25080 The PUT operation will entirely replace an existing object.
25081 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25083 Other differences between PUT and PATCH are:
25085 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25086 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25087 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25088 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterface
25097 description: Response codes found in [response codes](https://wiki.onap.org/).
25099 - name: equipment-name
25103 example: __EQUIPMENT-NAME__
25104 - name: interface-name
25106 description: Name that identifies the physical interface
25109 example: __INTERFACE-NAME__
25112 description: p-interface object that needs to be updated.
25115 $ref: "#/patchDefinitions/p-interface"
25119 summary: delete an existing p-interface
25120 description: delete an existing p-interface
25121 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface
25130 description: Response codes found in [response codes](https://wiki.onap.org/).
25132 - name: equipment-name
25136 example: __EQUIPMENT-NAME__
25137 - name: interface-name
25139 description: Name that identifies the physical interface
25142 example: __INTERFACE-NAME__
25143 - name: resource-version
25145 description: resource-version for concurrency
25148 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces:
25152 summary: returns p-interfaces
25153 description: returns p-interfaces
25154 operationId: getNetworkVplsPesVplsPePInterfaces
25160 description: successful operation
25162 $ref: "#/getDefinitions/p-interfaces"
25164 description: Response codes found in [response codes](https://wiki.onap.org/).
25166 - name: equipment-name
25170 example: __EQUIPMENT-NAME__
25171 - name: interface-name
25176 - name: prov-status
25181 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
25185 summary: see node definition for valid relationships
25186 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
25195 description: Response codes found in [response codes](https://wiki.onap.org/).
25197 - name: equipment-name
25201 example: __EQUIPMENT-NAME__
25202 - name: interface-name
25204 description: Name that identifies the link aggregate interface
25207 example: __INTERFACE-NAME__
25210 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
25213 $ref: "#/definitions/relationship"
25217 summary: delete an existing relationship
25218 description: delete an existing relationship
25219 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
25228 description: Response codes found in [response codes](https://wiki.onap.org/).
25230 - name: equipment-name
25234 example: __EQUIPMENT-NAME__
25235 - name: interface-name
25237 description: Name that identifies the link aggregate interface
25240 example: __INTERFACE-NAME__
25241 /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:
25245 summary: see node definition for valid relationships
25246 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
25255 description: Response codes found in [response codes](https://wiki.onap.org/).
25257 - name: equipment-name
25261 example: __EQUIPMENT-NAME__
25262 - name: interface-name
25264 description: Name that identifies the link aggregate interface
25267 example: __INTERFACE-NAME__
25268 - name: interface-name
25270 description: Name given to the interface
25273 example: __INTERFACE-NAME__
25274 - name: vlan-interface
25276 description: String that identifies the interface
25279 example: __VLAN-INTERFACE__
25282 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
25285 $ref: "#/definitions/relationship"
25289 summary: delete an existing relationship
25290 description: delete an existing relationship
25291 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
25300 description: Response codes found in [response codes](https://wiki.onap.org/).
25302 - name: equipment-name
25306 example: __EQUIPMENT-NAME__
25307 - name: interface-name
25309 description: Name that identifies the link aggregate interface
25312 example: __INTERFACE-NAME__
25313 - name: interface-name
25315 description: Name given to the interface
25318 example: __INTERFACE-NAME__
25319 - name: vlan-interface
25321 description: String that identifies the interface
25324 example: __VLAN-INTERFACE__
25325 /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:
25329 summary: see node definition for valid relationships
25330 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
25339 description: Response codes found in [response codes](https://wiki.onap.org/).
25341 - name: equipment-name
25345 example: __EQUIPMENT-NAME__
25346 - name: interface-name
25348 description: Name that identifies the link aggregate interface
25351 example: __INTERFACE-NAME__
25352 - name: interface-name
25354 description: Name given to the interface
25357 example: __INTERFACE-NAME__
25358 - name: vlan-interface
25360 description: String that identifies the interface
25363 example: __VLAN-INTERFACE__
25364 - name: l3-interface-ipv4-address
25366 description: IP address
25369 example: __L3-INTERFACE-IPV4-ADDRESS__
25372 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
25375 $ref: "#/definitions/relationship"
25379 summary: delete an existing relationship
25380 description: delete an existing relationship
25381 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
25390 description: Response codes found in [response codes](https://wiki.onap.org/).
25392 - name: equipment-name
25396 example: __EQUIPMENT-NAME__
25397 - name: interface-name
25399 description: Name that identifies the link aggregate interface
25402 example: __INTERFACE-NAME__
25403 - name: interface-name
25405 description: Name given to the interface
25408 example: __INTERFACE-NAME__
25409 - name: vlan-interface
25411 description: String that identifies the interface
25414 example: __VLAN-INTERFACE__
25415 - name: l3-interface-ipv4-address
25417 description: IP address
25420 example: __L3-INTERFACE-IPV4-ADDRESS__
25421 /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}:
25425 summary: returns l3-interface-ipv4-address-list
25426 description: returns l3-interface-ipv4-address-list
25427 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25433 description: successful operation
25435 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
25437 description: Response codes found in [response codes](https://wiki.onap.org/).
25439 - name: equipment-name
25443 example: __EQUIPMENT-NAME__
25444 - name: interface-name
25446 description: Name that identifies the link aggregate interface
25449 example: __INTERFACE-NAME__
25450 - name: interface-name
25452 description: Name given to the interface
25455 example: __INTERFACE-NAME__
25456 - name: vlan-interface
25458 description: String that identifies the interface
25461 example: __VLAN-INTERFACE__
25462 - name: l3-interface-ipv4-address
25464 description: IP address
25467 example: __L3-INTERFACE-IPV4-ADDRESS__
25471 summary: create or update an existing l3-interface-ipv4-address-list
25473 Create or update an existing l3-interface-ipv4-address-list.
25475 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25476 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25485 description: Response codes found in [response codes](https://wiki.onap.org/).
25487 - name: equipment-name
25491 example: __EQUIPMENT-NAME__
25492 - name: interface-name
25494 description: Name that identifies the link aggregate interface
25497 example: __INTERFACE-NAME__
25498 - name: interface-name
25500 description: Name given to the interface
25503 example: __INTERFACE-NAME__
25504 - name: vlan-interface
25506 description: String that identifies the interface
25509 example: __VLAN-INTERFACE__
25510 - name: l3-interface-ipv4-address
25512 description: IP address
25515 example: __L3-INTERFACE-IPV4-ADDRESS__
25518 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
25521 $ref: "#/definitions/l3-interface-ipv4-address-list"
25525 summary: update an existing l3-interface-ipv4-address-list
25527 Update an existing l3-interface-ipv4-address-list
25529 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25530 The PUT operation will entirely replace an existing object.
25531 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25533 Other differences between PUT and PATCH are:
25535 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25536 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25537 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25538 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25547 description: Response codes found in [response codes](https://wiki.onap.org/).
25549 - name: equipment-name
25553 example: __EQUIPMENT-NAME__
25554 - name: interface-name
25556 description: Name that identifies the link aggregate interface
25559 example: __INTERFACE-NAME__
25560 - name: interface-name
25562 description: Name given to the interface
25565 example: __INTERFACE-NAME__
25566 - name: vlan-interface
25568 description: String that identifies the interface
25571 example: __VLAN-INTERFACE__
25572 - name: l3-interface-ipv4-address
25574 description: IP address
25577 example: __L3-INTERFACE-IPV4-ADDRESS__
25580 description: l3-interface-ipv4-address-list object that needs to be updated.
25583 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
25587 summary: delete an existing l3-interface-ipv4-address-list
25588 description: delete an existing l3-interface-ipv4-address-list
25589 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25598 description: Response codes found in [response codes](https://wiki.onap.org/).
25600 - name: equipment-name
25604 example: __EQUIPMENT-NAME__
25605 - name: interface-name
25607 description: Name that identifies the link aggregate interface
25610 example: __INTERFACE-NAME__
25611 - name: interface-name
25613 description: Name given to the interface
25616 example: __INTERFACE-NAME__
25617 - name: vlan-interface
25619 description: String that identifies the interface
25622 example: __VLAN-INTERFACE__
25623 - name: l3-interface-ipv4-address
25625 description: IP address
25628 example: __L3-INTERFACE-IPV4-ADDRESS__
25629 - name: resource-version
25631 description: resource-version for concurrency
25634 /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:
25638 summary: see node definition for valid relationships
25639 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
25648 description: Response codes found in [response codes](https://wiki.onap.org/).
25650 - name: equipment-name
25654 example: __EQUIPMENT-NAME__
25655 - name: interface-name
25657 description: Name that identifies the link aggregate interface
25660 example: __INTERFACE-NAME__
25661 - name: interface-name
25663 description: Name given to the interface
25666 example: __INTERFACE-NAME__
25667 - name: vlan-interface
25669 description: String that identifies the interface
25672 example: __VLAN-INTERFACE__
25673 - name: l3-interface-ipv6-address
25675 description: IP address
25678 example: __L3-INTERFACE-IPV6-ADDRESS__
25681 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
25684 $ref: "#/definitions/relationship"
25688 summary: delete an existing relationship
25689 description: delete an existing relationship
25690 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
25699 description: Response codes found in [response codes](https://wiki.onap.org/).
25701 - name: equipment-name
25705 example: __EQUIPMENT-NAME__
25706 - name: interface-name
25708 description: Name that identifies the link aggregate interface
25711 example: __INTERFACE-NAME__
25712 - name: interface-name
25714 description: Name given to the interface
25717 example: __INTERFACE-NAME__
25718 - name: vlan-interface
25720 description: String that identifies the interface
25723 example: __VLAN-INTERFACE__
25724 - name: l3-interface-ipv6-address
25726 description: IP address
25729 example: __L3-INTERFACE-IPV6-ADDRESS__
25730 /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}:
25734 summary: returns l3-interface-ipv6-address-list
25735 description: returns l3-interface-ipv6-address-list
25736 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25742 description: successful operation
25744 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
25746 description: Response codes found in [response codes](https://wiki.onap.org/).
25748 - name: equipment-name
25752 example: __EQUIPMENT-NAME__
25753 - name: interface-name
25755 description: Name that identifies the link aggregate interface
25758 example: __INTERFACE-NAME__
25759 - name: interface-name
25761 description: Name given to the interface
25764 example: __INTERFACE-NAME__
25765 - name: vlan-interface
25767 description: String that identifies the interface
25770 example: __VLAN-INTERFACE__
25771 - name: l3-interface-ipv6-address
25773 description: IP address
25776 example: __L3-INTERFACE-IPV6-ADDRESS__
25780 summary: create or update an existing l3-interface-ipv6-address-list
25782 Create or update an existing l3-interface-ipv6-address-list.
25784 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25785 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25794 description: Response codes found in [response codes](https://wiki.onap.org/).
25796 - name: equipment-name
25800 example: __EQUIPMENT-NAME__
25801 - name: interface-name
25803 description: Name that identifies the link aggregate interface
25806 example: __INTERFACE-NAME__
25807 - name: interface-name
25809 description: Name given to the interface
25812 example: __INTERFACE-NAME__
25813 - name: vlan-interface
25815 description: String that identifies the interface
25818 example: __VLAN-INTERFACE__
25819 - name: l3-interface-ipv6-address
25821 description: IP address
25824 example: __L3-INTERFACE-IPV6-ADDRESS__
25827 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
25830 $ref: "#/definitions/l3-interface-ipv6-address-list"
25834 summary: update an existing l3-interface-ipv6-address-list
25836 Update an existing l3-interface-ipv6-address-list
25838 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25839 The PUT operation will entirely replace an existing object.
25840 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25842 Other differences between PUT and PATCH are:
25844 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25845 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25846 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25847 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25856 description: Response codes found in [response codes](https://wiki.onap.org/).
25858 - name: equipment-name
25862 example: __EQUIPMENT-NAME__
25863 - name: interface-name
25865 description: Name that identifies the link aggregate interface
25868 example: __INTERFACE-NAME__
25869 - name: interface-name
25871 description: Name given to the interface
25874 example: __INTERFACE-NAME__
25875 - name: vlan-interface
25877 description: String that identifies the interface
25880 example: __VLAN-INTERFACE__
25881 - name: l3-interface-ipv6-address
25883 description: IP address
25886 example: __L3-INTERFACE-IPV6-ADDRESS__
25889 description: l3-interface-ipv6-address-list object that needs to be updated.
25892 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
25896 summary: delete an existing l3-interface-ipv6-address-list
25897 description: delete an existing l3-interface-ipv6-address-list
25898 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25907 description: Response codes found in [response codes](https://wiki.onap.org/).
25909 - name: equipment-name
25913 example: __EQUIPMENT-NAME__
25914 - name: interface-name
25916 description: Name that identifies the link aggregate interface
25919 example: __INTERFACE-NAME__
25920 - name: interface-name
25922 description: Name given to the interface
25925 example: __INTERFACE-NAME__
25926 - name: vlan-interface
25928 description: String that identifies the interface
25931 example: __VLAN-INTERFACE__
25932 - name: l3-interface-ipv6-address
25934 description: IP address
25937 example: __L3-INTERFACE-IPV6-ADDRESS__
25938 - name: resource-version
25940 description: resource-version for concurrency
25943 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
25947 summary: returns vlan
25948 description: returns vlan
25949 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
25955 description: successful operation
25957 $ref: "#/getDefinitions/vlan"
25959 description: Response codes found in [response codes](https://wiki.onap.org/).
25961 - name: equipment-name
25965 example: __EQUIPMENT-NAME__
25966 - name: interface-name
25968 description: Name that identifies the link aggregate interface
25971 example: __INTERFACE-NAME__
25972 - name: interface-name
25974 description: Name given to the interface
25977 example: __INTERFACE-NAME__
25978 - name: vlan-interface
25980 description: String that identifies the interface
25983 example: __VLAN-INTERFACE__
25987 summary: create or update an existing vlan
25989 Create or update an existing vlan.
25991 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25992 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
26001 description: Response codes found in [response codes](https://wiki.onap.org/).
26003 - name: equipment-name
26007 example: __EQUIPMENT-NAME__
26008 - name: interface-name
26010 description: Name that identifies the link aggregate interface
26013 example: __INTERFACE-NAME__
26014 - name: interface-name
26016 description: Name given to the interface
26019 example: __INTERFACE-NAME__
26020 - name: vlan-interface
26022 description: String that identifies the interface
26025 example: __VLAN-INTERFACE__
26028 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
26031 $ref: "#/definitions/vlan"
26035 summary: update an existing vlan
26037 Update an existing vlan
26039 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26040 The PUT operation will entirely replace an existing object.
26041 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26043 Other differences between PUT and PATCH are:
26045 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26046 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26047 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26048 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
26057 description: Response codes found in [response codes](https://wiki.onap.org/).
26059 - name: equipment-name
26063 example: __EQUIPMENT-NAME__
26064 - name: interface-name
26066 description: Name that identifies the link aggregate interface
26069 example: __INTERFACE-NAME__
26070 - name: interface-name
26072 description: Name given to the interface
26075 example: __INTERFACE-NAME__
26076 - name: vlan-interface
26078 description: String that identifies the interface
26081 example: __VLAN-INTERFACE__
26084 description: vlan object that needs to be updated.
26087 $ref: "#/patchDefinitions/vlan"
26091 summary: delete an existing vlan
26092 description: delete an existing vlan
26093 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
26102 description: Response codes found in [response codes](https://wiki.onap.org/).
26104 - name: equipment-name
26108 example: __EQUIPMENT-NAME__
26109 - name: interface-name
26111 description: Name that identifies the link aggregate interface
26114 example: __INTERFACE-NAME__
26115 - name: interface-name
26117 description: Name given to the interface
26120 example: __INTERFACE-NAME__
26121 - name: vlan-interface
26123 description: String that identifies the interface
26126 example: __VLAN-INTERFACE__
26127 - name: resource-version
26129 description: resource-version for concurrency
26132 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
26136 summary: returns vlans
26137 description: returns vlans
26138 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
26144 description: successful operation
26146 $ref: "#/getDefinitions/vlans"
26148 description: Response codes found in [response codes](https://wiki.onap.org/).
26150 - name: equipment-name
26154 example: __EQUIPMENT-NAME__
26155 - name: interface-name
26157 description: Name that identifies the link aggregate interface
26160 example: __INTERFACE-NAME__
26161 - name: interface-name
26163 description: Name given to the interface
26166 example: __INTERFACE-NAME__
26167 - name: vlan-interface
26172 - name: vlan-id-inner
26183 /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:
26187 summary: see node definition for valid relationships
26188 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
26197 description: Response codes found in [response codes](https://wiki.onap.org/).
26199 - name: equipment-name
26203 example: __EQUIPMENT-NAME__
26204 - name: interface-name
26206 description: Name that identifies the link aggregate interface
26209 example: __INTERFACE-NAME__
26210 - name: interface-name
26212 description: Name given to the interface
26215 example: __INTERFACE-NAME__
26218 description: PCI ID used to identify the sriov-vf
26221 example: __PCI-ID__
26224 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
26227 $ref: "#/definitions/relationship"
26231 summary: delete an existing relationship
26232 description: delete an existing relationship
26233 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
26242 description: Response codes found in [response codes](https://wiki.onap.org/).
26244 - name: equipment-name
26248 example: __EQUIPMENT-NAME__
26249 - name: interface-name
26251 description: Name that identifies the link aggregate interface
26254 example: __INTERFACE-NAME__
26255 - name: interface-name
26257 description: Name given to the interface
26260 example: __INTERFACE-NAME__
26263 description: PCI ID used to identify the sriov-vf
26266 example: __PCI-ID__
26267 /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}:
26271 summary: returns sriov-vf
26272 description: returns sriov-vf
26273 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
26279 description: successful operation
26281 $ref: "#/getDefinitions/sriov-vf"
26283 description: Response codes found in [response codes](https://wiki.onap.org/).
26285 - name: equipment-name
26289 example: __EQUIPMENT-NAME__
26290 - name: interface-name
26292 description: Name that identifies the link aggregate interface
26295 example: __INTERFACE-NAME__
26296 - name: interface-name
26298 description: Name given to the interface
26301 example: __INTERFACE-NAME__
26304 description: PCI ID used to identify the sriov-vf
26307 example: __PCI-ID__
26311 summary: create or update an existing sriov-vf
26313 Create or update an existing sriov-vf.
26315 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26316 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
26325 description: Response codes found in [response codes](https://wiki.onap.org/).
26327 - name: equipment-name
26331 example: __EQUIPMENT-NAME__
26332 - name: interface-name
26334 description: Name that identifies the link aggregate interface
26337 example: __INTERFACE-NAME__
26338 - name: interface-name
26340 description: Name given to the interface
26343 example: __INTERFACE-NAME__
26346 description: PCI ID used to identify the sriov-vf
26349 example: __PCI-ID__
26352 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
26355 $ref: "#/definitions/sriov-vf"
26359 summary: update an existing sriov-vf
26361 Update an existing sriov-vf
26363 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26364 The PUT operation will entirely replace an existing object.
26365 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26367 Other differences between PUT and PATCH are:
26369 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26370 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26371 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26372 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
26381 description: Response codes found in [response codes](https://wiki.onap.org/).
26383 - name: equipment-name
26387 example: __EQUIPMENT-NAME__
26388 - name: interface-name
26390 description: Name that identifies the link aggregate interface
26393 example: __INTERFACE-NAME__
26394 - name: interface-name
26396 description: Name given to the interface
26399 example: __INTERFACE-NAME__
26402 description: PCI ID used to identify the sriov-vf
26405 example: __PCI-ID__
26408 description: sriov-vf object that needs to be updated.
26411 $ref: "#/patchDefinitions/sriov-vf"
26415 summary: delete an existing sriov-vf
26416 description: delete an existing sriov-vf
26417 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
26426 description: Response codes found in [response codes](https://wiki.onap.org/).
26428 - name: equipment-name
26432 example: __EQUIPMENT-NAME__
26433 - name: interface-name
26435 description: Name that identifies the link aggregate interface
26438 example: __INTERFACE-NAME__
26439 - name: interface-name
26441 description: Name given to the interface
26444 example: __INTERFACE-NAME__
26447 description: PCI ID used to identify the sriov-vf
26450 example: __PCI-ID__
26451 - name: resource-version
26453 description: resource-version for concurrency
26456 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
26460 summary: returns sriov-vfs
26461 description: returns sriov-vfs
26462 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
26468 description: successful operation
26470 $ref: "#/getDefinitions/sriov-vfs"
26472 description: Response codes found in [response codes](https://wiki.onap.org/).
26474 - name: equipment-name
26478 example: __EQUIPMENT-NAME__
26479 - name: interface-name
26481 description: Name that identifies the link aggregate interface
26484 example: __INTERFACE-NAME__
26485 - name: interface-name
26487 description: Name given to the interface
26490 example: __INTERFACE-NAME__
26496 - name: vf-vlan-filter
26501 - name: vf-mac-filter
26506 - name: vf-vlan-strip
26511 - name: neutron-network-id
26516 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
26520 summary: see node definition for valid relationships
26521 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
26530 description: Response codes found in [response codes](https://wiki.onap.org/).
26532 - name: equipment-name
26536 example: __EQUIPMENT-NAME__
26537 - name: interface-name
26539 description: Name that identifies the link aggregate interface
26542 example: __INTERFACE-NAME__
26543 - name: interface-name
26545 description: Name given to the interface
26548 example: __INTERFACE-NAME__
26551 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
26554 $ref: "#/definitions/relationship"
26558 summary: delete an existing relationship
26559 description: delete an existing relationship
26560 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
26569 description: Response codes found in [response codes](https://wiki.onap.org/).
26571 - name: equipment-name
26575 example: __EQUIPMENT-NAME__
26576 - name: interface-name
26578 description: Name that identifies the link aggregate interface
26581 example: __INTERFACE-NAME__
26582 - name: interface-name
26584 description: Name given to the interface
26587 example: __INTERFACE-NAME__
26588 /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:
26592 summary: see node definition for valid relationships
26593 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
26602 description: Response codes found in [response codes](https://wiki.onap.org/).
26604 - name: equipment-name
26608 example: __EQUIPMENT-NAME__
26609 - name: interface-name
26611 description: Name that identifies the link aggregate interface
26614 example: __INTERFACE-NAME__
26615 - name: interface-name
26617 description: Name given to the interface
26620 example: __INTERFACE-NAME__
26621 - name: l3-interface-ipv4-address
26623 description: IP address
26626 example: __L3-INTERFACE-IPV4-ADDRESS__
26629 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
26632 $ref: "#/definitions/relationship"
26636 summary: delete an existing relationship
26637 description: delete an existing relationship
26638 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
26647 description: Response codes found in [response codes](https://wiki.onap.org/).
26649 - name: equipment-name
26653 example: __EQUIPMENT-NAME__
26654 - name: interface-name
26656 description: Name that identifies the link aggregate interface
26659 example: __INTERFACE-NAME__
26660 - name: interface-name
26662 description: Name given to the interface
26665 example: __INTERFACE-NAME__
26666 - name: l3-interface-ipv4-address
26668 description: IP address
26671 example: __L3-INTERFACE-IPV4-ADDRESS__
26672 /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}:
26676 summary: returns l3-interface-ipv4-address-list
26677 description: returns l3-interface-ipv4-address-list
26678 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26684 description: successful operation
26686 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
26688 description: Response codes found in [response codes](https://wiki.onap.org/).
26690 - name: equipment-name
26694 example: __EQUIPMENT-NAME__
26695 - name: interface-name
26697 description: Name that identifies the link aggregate interface
26700 example: __INTERFACE-NAME__
26701 - name: interface-name
26703 description: Name given to the interface
26706 example: __INTERFACE-NAME__
26707 - name: l3-interface-ipv4-address
26709 description: IP address
26712 example: __L3-INTERFACE-IPV4-ADDRESS__
26716 summary: create or update an existing l3-interface-ipv4-address-list
26718 Create or update an existing l3-interface-ipv4-address-list.
26720 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26721 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26730 description: Response codes found in [response codes](https://wiki.onap.org/).
26732 - name: equipment-name
26736 example: __EQUIPMENT-NAME__
26737 - name: interface-name
26739 description: Name that identifies the link aggregate interface
26742 example: __INTERFACE-NAME__
26743 - name: interface-name
26745 description: Name given to the interface
26748 example: __INTERFACE-NAME__
26749 - name: l3-interface-ipv4-address
26751 description: IP address
26754 example: __L3-INTERFACE-IPV4-ADDRESS__
26757 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
26760 $ref: "#/definitions/l3-interface-ipv4-address-list"
26764 summary: update an existing l3-interface-ipv4-address-list
26766 Update an existing l3-interface-ipv4-address-list
26768 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26769 The PUT operation will entirely replace an existing object.
26770 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26772 Other differences between PUT and PATCH are:
26774 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26775 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26776 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26777 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26786 description: Response codes found in [response codes](https://wiki.onap.org/).
26788 - name: equipment-name
26792 example: __EQUIPMENT-NAME__
26793 - name: interface-name
26795 description: Name that identifies the link aggregate interface
26798 example: __INTERFACE-NAME__
26799 - name: interface-name
26801 description: Name given to the interface
26804 example: __INTERFACE-NAME__
26805 - name: l3-interface-ipv4-address
26807 description: IP address
26810 example: __L3-INTERFACE-IPV4-ADDRESS__
26813 description: l3-interface-ipv4-address-list object that needs to be updated.
26816 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
26820 summary: delete an existing l3-interface-ipv4-address-list
26821 description: delete an existing l3-interface-ipv4-address-list
26822 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26831 description: Response codes found in [response codes](https://wiki.onap.org/).
26833 - name: equipment-name
26837 example: __EQUIPMENT-NAME__
26838 - name: interface-name
26840 description: Name that identifies the link aggregate interface
26843 example: __INTERFACE-NAME__
26844 - name: interface-name
26846 description: Name given to the interface
26849 example: __INTERFACE-NAME__
26850 - name: l3-interface-ipv4-address
26852 description: IP address
26855 example: __L3-INTERFACE-IPV4-ADDRESS__
26856 - name: resource-version
26858 description: resource-version for concurrency
26861 /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:
26865 summary: see node definition for valid relationships
26866 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
26875 description: Response codes found in [response codes](https://wiki.onap.org/).
26877 - name: equipment-name
26881 example: __EQUIPMENT-NAME__
26882 - name: interface-name
26884 description: Name that identifies the link aggregate interface
26887 example: __INTERFACE-NAME__
26888 - name: interface-name
26890 description: Name given to the interface
26893 example: __INTERFACE-NAME__
26894 - name: l3-interface-ipv6-address
26896 description: IP address
26899 example: __L3-INTERFACE-IPV6-ADDRESS__
26902 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
26905 $ref: "#/definitions/relationship"
26909 summary: delete an existing relationship
26910 description: delete an existing relationship
26911 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
26920 description: Response codes found in [response codes](https://wiki.onap.org/).
26922 - name: equipment-name
26926 example: __EQUIPMENT-NAME__
26927 - name: interface-name
26929 description: Name that identifies the link aggregate interface
26932 example: __INTERFACE-NAME__
26933 - name: interface-name
26935 description: Name given to the interface
26938 example: __INTERFACE-NAME__
26939 - name: l3-interface-ipv6-address
26941 description: IP address
26944 example: __L3-INTERFACE-IPV6-ADDRESS__
26945 /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}:
26949 summary: returns l3-interface-ipv6-address-list
26950 description: returns l3-interface-ipv6-address-list
26951 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26957 description: successful operation
26959 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
26961 description: Response codes found in [response codes](https://wiki.onap.org/).
26963 - name: equipment-name
26967 example: __EQUIPMENT-NAME__
26968 - name: interface-name
26970 description: Name that identifies the link aggregate interface
26973 example: __INTERFACE-NAME__
26974 - name: interface-name
26976 description: Name given to the interface
26979 example: __INTERFACE-NAME__
26980 - name: l3-interface-ipv6-address
26982 description: IP address
26985 example: __L3-INTERFACE-IPV6-ADDRESS__
26989 summary: create or update an existing l3-interface-ipv6-address-list
26991 Create or update an existing l3-interface-ipv6-address-list.
26993 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26994 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
27003 description: Response codes found in [response codes](https://wiki.onap.org/).
27005 - name: equipment-name
27009 example: __EQUIPMENT-NAME__
27010 - name: interface-name
27012 description: Name that identifies the link aggregate interface
27015 example: __INTERFACE-NAME__
27016 - name: interface-name
27018 description: Name given to the interface
27021 example: __INTERFACE-NAME__
27022 - name: l3-interface-ipv6-address
27024 description: IP address
27027 example: __L3-INTERFACE-IPV6-ADDRESS__
27030 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
27033 $ref: "#/definitions/l3-interface-ipv6-address-list"
27037 summary: update an existing l3-interface-ipv6-address-list
27039 Update an existing l3-interface-ipv6-address-list
27041 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27042 The PUT operation will entirely replace an existing object.
27043 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27045 Other differences between PUT and PATCH are:
27047 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27048 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27049 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27050 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
27059 description: Response codes found in [response codes](https://wiki.onap.org/).
27061 - name: equipment-name
27065 example: __EQUIPMENT-NAME__
27066 - name: interface-name
27068 description: Name that identifies the link aggregate interface
27071 example: __INTERFACE-NAME__
27072 - name: interface-name
27074 description: Name given to the interface
27077 example: __INTERFACE-NAME__
27078 - name: l3-interface-ipv6-address
27080 description: IP address
27083 example: __L3-INTERFACE-IPV6-ADDRESS__
27086 description: l3-interface-ipv6-address-list object that needs to be updated.
27089 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
27093 summary: delete an existing l3-interface-ipv6-address-list
27094 description: delete an existing l3-interface-ipv6-address-list
27095 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
27104 description: Response codes found in [response codes](https://wiki.onap.org/).
27106 - name: equipment-name
27110 example: __EQUIPMENT-NAME__
27111 - name: interface-name
27113 description: Name that identifies the link aggregate interface
27116 example: __INTERFACE-NAME__
27117 - name: interface-name
27119 description: Name given to the interface
27122 example: __INTERFACE-NAME__
27123 - name: l3-interface-ipv6-address
27125 description: IP address
27128 example: __L3-INTERFACE-IPV6-ADDRESS__
27129 - name: resource-version
27131 description: resource-version for concurrency
27134 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
27138 summary: returns l-interface
27139 description: returns l-interface
27140 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
27146 description: successful operation
27148 $ref: "#/getDefinitions/l-interface"
27150 description: Response codes found in [response codes](https://wiki.onap.org/).
27152 - name: equipment-name
27156 example: __EQUIPMENT-NAME__
27157 - name: interface-name
27159 description: Name that identifies the link aggregate interface
27162 example: __INTERFACE-NAME__
27163 - name: interface-name
27165 description: Name given to the interface
27168 example: __INTERFACE-NAME__
27172 summary: create or update an existing l-interface
27174 Create or update an existing l-interface.
27176 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27177 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
27186 description: Response codes found in [response codes](https://wiki.onap.org/).
27188 - name: equipment-name
27192 example: __EQUIPMENT-NAME__
27193 - name: interface-name
27195 description: Name that identifies the link aggregate interface
27198 example: __INTERFACE-NAME__
27199 - name: interface-name
27201 description: Name given to the interface
27204 example: __INTERFACE-NAME__
27207 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
27210 $ref: "#/definitions/l-interface"
27214 summary: update an existing l-interface
27216 Update an existing l-interface
27218 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27219 The PUT operation will entirely replace an existing object.
27220 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27222 Other differences between PUT and PATCH are:
27224 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27225 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27226 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27227 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
27236 description: Response codes found in [response codes](https://wiki.onap.org/).
27238 - name: equipment-name
27242 example: __EQUIPMENT-NAME__
27243 - name: interface-name
27245 description: Name that identifies the link aggregate interface
27248 example: __INTERFACE-NAME__
27249 - name: interface-name
27251 description: Name given to the interface
27254 example: __INTERFACE-NAME__
27257 description: l-interface object that needs to be updated.
27260 $ref: "#/patchDefinitions/l-interface"
27264 summary: delete an existing l-interface
27265 description: delete an existing l-interface
27266 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
27275 description: Response codes found in [response codes](https://wiki.onap.org/).
27277 - name: equipment-name
27281 example: __EQUIPMENT-NAME__
27282 - name: interface-name
27284 description: Name that identifies the link aggregate interface
27287 example: __INTERFACE-NAME__
27288 - name: interface-name
27290 description: Name given to the interface
27293 example: __INTERFACE-NAME__
27294 - name: resource-version
27296 description: resource-version for concurrency
27299 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
27303 summary: returns l-interfaces
27304 description: returns l-interfaces
27305 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces
27311 description: successful operation
27313 $ref: "#/getDefinitions/l-interfaces"
27315 description: Response codes found in [response codes](https://wiki.onap.org/).
27317 - name: equipment-name
27321 example: __EQUIPMENT-NAME__
27322 - name: interface-name
27324 description: Name that identifies the link aggregate interface
27327 example: __INTERFACE-NAME__
27328 - name: interface-name
27333 - name: interface-id
27343 - name: network-name
27348 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}:
27352 summary: returns lag-interface
27353 description: returns lag-interface
27354 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface
27360 description: successful operation
27362 $ref: "#/getDefinitions/lag-interface"
27364 description: Response codes found in [response codes](https://wiki.onap.org/).
27366 - name: equipment-name
27370 example: __EQUIPMENT-NAME__
27371 - name: interface-name
27373 description: Name that identifies the link aggregate interface
27376 example: __INTERFACE-NAME__
27380 summary: create or update an existing lag-interface
27382 Create or update an existing lag-interface.
27384 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27385 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
27394 description: Response codes found in [response codes](https://wiki.onap.org/).
27396 - name: equipment-name
27400 example: __EQUIPMENT-NAME__
27401 - name: interface-name
27403 description: Name that identifies the link aggregate interface
27406 example: __INTERFACE-NAME__
27409 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
27412 $ref: "#/definitions/lag-interface"
27416 summary: update an existing lag-interface
27418 Update an existing lag-interface
27420 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27421 The PUT operation will entirely replace an existing object.
27422 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27424 Other differences between PUT and PATCH are:
27426 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27427 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27428 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27429 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
27438 description: Response codes found in [response codes](https://wiki.onap.org/).
27440 - name: equipment-name
27444 example: __EQUIPMENT-NAME__
27445 - name: interface-name
27447 description: Name that identifies the link aggregate interface
27450 example: __INTERFACE-NAME__
27453 description: lag-interface object that needs to be updated.
27456 $ref: "#/patchDefinitions/lag-interface"
27460 summary: delete an existing lag-interface
27461 description: delete an existing lag-interface
27462 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface
27471 description: Response codes found in [response codes](https://wiki.onap.org/).
27473 - name: equipment-name
27477 example: __EQUIPMENT-NAME__
27478 - name: interface-name
27480 description: Name that identifies the link aggregate interface
27483 example: __INTERFACE-NAME__
27484 - name: resource-version
27486 description: resource-version for concurrency
27489 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces:
27493 summary: returns lag-interfaces
27494 description: returns lag-interfaces
27495 operationId: getNetworkVplsPesVplsPeLagInterfaces
27501 description: successful operation
27503 $ref: "#/getDefinitions/lag-interfaces"
27505 description: Response codes found in [response codes](https://wiki.onap.org/).
27507 - name: equipment-name
27511 example: __EQUIPMENT-NAME__
27512 - name: interface-name
27517 - name: interface-id
27522 - name: interface-role
27527 /network/vpls-pes/vpls-pe/{equipment-name}:
27531 summary: returns vpls-pe
27532 description: returns vpls-pe
27533 operationId: getNetworkVplsPesVplsPe
27539 description: successful operation
27541 $ref: "#/getDefinitions/vpls-pe"
27543 description: Response codes found in [response codes](https://wiki.onap.org/).
27545 - name: equipment-name
27549 example: __EQUIPMENT-NAME__
27553 summary: create or update an existing vpls-pe
27555 Create or update an existing vpls-pe.
27557 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27558 operationId: createOrUpdateNetworkVplsPesVplsPe
27567 description: Response codes found in [response codes](https://wiki.onap.org/).
27569 - name: equipment-name
27573 example: __EQUIPMENT-NAME__
27576 description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVplsPesVplsPe.json)
27579 $ref: "#/definitions/vpls-pe"
27583 summary: update an existing vpls-pe
27585 Update an existing vpls-pe
27587 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27588 The PUT operation will entirely replace an existing object.
27589 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27591 Other differences between PUT and PATCH are:
27593 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27594 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27595 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27596 operationId: UpdateNetworkVplsPesVplsPe
27605 description: Response codes found in [response codes](https://wiki.onap.org/).
27607 - name: equipment-name
27611 example: __EQUIPMENT-NAME__
27614 description: vpls-pe object that needs to be updated.
27617 $ref: "#/patchDefinitions/vpls-pe"
27621 summary: delete an existing vpls-pe
27622 description: delete an existing vpls-pe
27623 operationId: deleteNetworkVplsPesVplsPe
27632 description: Response codes found in [response codes](https://wiki.onap.org/).
27634 - name: equipment-name
27638 example: __EQUIPMENT-NAME__
27639 - name: resource-version
27641 description: resource-version for concurrency
27648 summary: returns vpls-pes
27649 description: returns vpls-pes
27650 operationId: getNetworkVplsPes
27656 description: successful operation
27658 $ref: "#/getDefinitions/vpls-pes"
27660 description: Response codes found in [response codes](https://wiki.onap.org/).
27662 - name: equipment-name
27667 - name: prov-status
27672 /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
27676 summary: see node definition for valid relationships
27677 operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
27686 description: Response codes found in [response codes](https://wiki.onap.org/).
27688 - name: multicast-configuration-id
27690 description: Unique id of multicast configuration.
27693 example: __MULTICAST-CONFIGURATION-ID__
27696 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkMulticastConfigurationsMulticastConfiguration.json)
27699 $ref: "#/definitions/relationship"
27703 summary: delete an existing relationship
27704 description: delete an existing relationship
27705 operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
27714 description: Response codes found in [response codes](https://wiki.onap.org/).
27716 - name: multicast-configuration-id
27718 description: Unique id of multicast configuration.
27721 example: __MULTICAST-CONFIGURATION-ID__
27722 /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}:
27726 summary: returns multicast-configuration
27727 description: returns multicast-configuration
27728 operationId: getNetworkMulticastConfigurationsMulticastConfiguration
27734 description: successful operation
27736 $ref: "#/getDefinitions/multicast-configuration"
27738 description: Response codes found in [response codes](https://wiki.onap.org/).
27740 - name: multicast-configuration-id
27742 description: Unique id of multicast configuration.
27745 example: __MULTICAST-CONFIGURATION-ID__
27749 summary: create or update an existing multicast-configuration
27751 Create or update an existing multicast-configuration.
27753 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27754 operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration
27763 description: Response codes found in [response codes](https://wiki.onap.org/).
27765 - name: multicast-configuration-id
27767 description: Unique id of multicast configuration.
27770 example: __MULTICAST-CONFIGURATION-ID__
27773 description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkMulticastConfigurationsMulticastConfiguration.json)
27776 $ref: "#/definitions/multicast-configuration"
27780 summary: update an existing multicast-configuration
27782 Update an existing multicast-configuration
27784 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27785 The PUT operation will entirely replace an existing object.
27786 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27788 Other differences between PUT and PATCH are:
27790 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27791 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27792 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27793 operationId: UpdateNetworkMulticastConfigurationsMulticastConfiguration
27802 description: Response codes found in [response codes](https://wiki.onap.org/).
27804 - name: multicast-configuration-id
27806 description: Unique id of multicast configuration.
27809 example: __MULTICAST-CONFIGURATION-ID__
27812 description: multicast-configuration object that needs to be updated.
27815 $ref: "#/patchDefinitions/multicast-configuration"
27819 summary: delete an existing multicast-configuration
27820 description: delete an existing multicast-configuration
27821 operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration
27830 description: Response codes found in [response codes](https://wiki.onap.org/).
27832 - name: multicast-configuration-id
27834 description: Unique id of multicast configuration.
27837 example: __MULTICAST-CONFIGURATION-ID__
27838 - name: resource-version
27840 description: resource-version for concurrency
27843 /network/multicast-configurations:
27847 summary: returns multicast-configurations
27848 description: returns multicast-configurations
27849 operationId: getNetworkMulticastConfigurations
27855 description: successful operation
27857 $ref: "#/getDefinitions/multicast-configurations"
27859 description: Response codes found in [response codes](https://wiki.onap.org/).
27861 - name: multicast-configuration-id
27866 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship:
27870 summary: see node definition for valid relationships
27871 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
27880 description: Response codes found in [response codes](https://wiki.onap.org/).
27884 description: Unique id of VNF. This is unique across the graph.
27887 example: __VNF-ID__
27888 - name: interface-id
27890 description: Unique ID of the interface
27893 example: __INTERFACE-ID__
27896 description: See mis-na-virtualization-platform.yang
27900 example: __CVLAN-TAG__
27903 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
27906 $ref: "#/definitions/relationship"
27910 summary: delete an existing relationship
27911 description: delete an existing relationship
27912 operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
27921 description: Response codes found in [response codes](https://wiki.onap.org/).
27925 description: Unique id of VNF. This is unique across the graph.
27928 example: __VNF-ID__
27929 - name: interface-id
27931 description: Unique ID of the interface
27934 example: __INTERFACE-ID__
27937 description: See mis-na-virtualization-platform.yang
27941 example: __CVLAN-TAG__
27942 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
27946 summary: returns cvlan-tag-entry
27947 description: returns cvlan-tag-entry
27948 operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
27954 description: successful operation
27956 $ref: "#/getDefinitions/cvlan-tag-entry"
27958 description: Response codes found in [response codes](https://wiki.onap.org/).
27962 description: Unique id of VNF. This is unique across the graph.
27965 example: __VNF-ID__
27966 - name: interface-id
27968 description: Unique ID of the interface
27971 example: __INTERFACE-ID__
27974 description: See mis-na-virtualization-platform.yang
27978 example: __CVLAN-TAG__
27982 summary: create or update an existing cvlan-tag-entry
27984 Create or update an existing cvlan-tag-entry.
27986 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27987 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
27996 description: Response codes found in [response codes](https://wiki.onap.org/).
28000 description: Unique id of VNF. This is unique across the graph.
28003 example: __VNF-ID__
28004 - name: interface-id
28006 description: Unique ID of the interface
28009 example: __INTERFACE-ID__
28012 description: See mis-na-virtualization-platform.yang
28016 example: __CVLAN-TAG__
28019 description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
28022 $ref: "#/definitions/cvlan-tag-entry"
28026 summary: update an existing cvlan-tag-entry
28028 Update an existing cvlan-tag-entry
28030 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28031 The PUT operation will entirely replace an existing object.
28032 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28034 Other differences between PUT and PATCH are:
28036 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28037 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28038 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28039 operationId: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
28048 description: Response codes found in [response codes](https://wiki.onap.org/).
28052 description: Unique id of VNF. This is unique across the graph.
28055 example: __VNF-ID__
28056 - name: interface-id
28058 description: Unique ID of the interface
28061 example: __INTERFACE-ID__
28064 description: See mis-na-virtualization-platform.yang
28068 example: __CVLAN-TAG__
28071 description: cvlan-tag-entry object that needs to be updated.
28074 $ref: "#/patchDefinitions/cvlan-tag-entry"
28078 summary: delete an existing cvlan-tag-entry
28079 description: delete an existing cvlan-tag-entry
28080 operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
28089 description: Response codes found in [response codes](https://wiki.onap.org/).
28093 description: Unique id of VNF. This is unique across the graph.
28096 example: __VNF-ID__
28097 - name: interface-id
28099 description: Unique ID of the interface
28102 example: __INTERFACE-ID__
28105 description: See mis-na-virtualization-platform.yang
28109 example: __CVLAN-TAG__
28110 - name: resource-version
28112 description: resource-version for concurrency
28115 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags:
28119 summary: returns cvlan-tags
28120 description: returns cvlan-tags
28121 operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags
28127 description: successful operation
28129 $ref: "#/getDefinitions/cvlan-tags"
28131 description: Response codes found in [response codes](https://wiki.onap.org/).
28135 description: Unique id of VNF. This is unique across the graph.
28138 example: __VNF-ID__
28139 - name: interface-id
28141 description: Unique ID of the interface
28144 example: __INTERFACE-ID__
28151 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
28155 summary: see node definition for valid relationships
28156 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
28165 description: Response codes found in [response codes](https://wiki.onap.org/).
28169 description: Unique id of VNF. This is unique across the graph.
28172 example: __VNF-ID__
28173 - name: interface-id
28175 description: Unique ID of the interface
28178 example: __INTERFACE-ID__
28181 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroup.json)
28184 $ref: "#/definitions/relationship"
28188 summary: delete an existing relationship
28189 description: delete an existing relationship
28190 operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
28199 description: Response codes found in [response codes](https://wiki.onap.org/).
28203 description: Unique id of VNF. This is unique across the graph.
28206 example: __VNF-ID__
28207 - name: interface-id
28209 description: Unique ID of the interface
28212 example: __INTERFACE-ID__
28213 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
28217 summary: returns port-group
28218 description: returns port-group
28219 operationId: getNetworkVcesVcePortGroupsPortGroup
28225 description: successful operation
28227 $ref: "#/getDefinitions/port-group"
28229 description: Response codes found in [response codes](https://wiki.onap.org/).
28233 description: Unique id of VNF. This is unique across the graph.
28236 example: __VNF-ID__
28237 - name: interface-id
28239 description: Unique ID of the interface
28242 example: __INTERFACE-ID__
28246 summary: create or update an existing port-group
28248 Create or update an existing port-group.
28250 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28251 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
28260 description: Response codes found in [response codes](https://wiki.onap.org/).
28264 description: Unique id of VNF. This is unique across the graph.
28267 example: __VNF-ID__
28268 - name: interface-id
28270 description: Unique ID of the interface
28273 example: __INTERFACE-ID__
28276 description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVcePortGroupsPortGroup.json)
28279 $ref: "#/definitions/port-group"
28283 summary: update an existing port-group
28285 Update an existing port-group
28287 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28288 The PUT operation will entirely replace an existing object.
28289 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28291 Other differences between PUT and PATCH are:
28293 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28294 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28295 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28296 operationId: UpdateNetworkVcesVcePortGroupsPortGroup
28305 description: Response codes found in [response codes](https://wiki.onap.org/).
28309 description: Unique id of VNF. This is unique across the graph.
28312 example: __VNF-ID__
28313 - name: interface-id
28315 description: Unique ID of the interface
28318 example: __INTERFACE-ID__
28321 description: port-group object that needs to be updated.
28324 $ref: "#/patchDefinitions/port-group"
28328 summary: delete an existing port-group
28329 description: delete an existing port-group
28330 operationId: deleteNetworkVcesVcePortGroupsPortGroup
28339 description: Response codes found in [response codes](https://wiki.onap.org/).
28343 description: Unique id of VNF. This is unique across the graph.
28346 example: __VNF-ID__
28347 - name: interface-id
28349 description: Unique ID of the interface
28352 example: __INTERFACE-ID__
28353 - name: resource-version
28355 description: resource-version for concurrency
28358 /network/vces/vce/{vnf-id}/port-groups:
28362 summary: returns port-groups
28363 description: returns port-groups
28364 operationId: getNetworkVcesVcePortGroups
28370 description: successful operation
28372 $ref: "#/getDefinitions/port-groups"
28374 description: Response codes found in [response codes](https://wiki.onap.org/).
28378 description: Unique id of VNF. This is unique across the graph.
28381 example: __VNF-ID__
28382 - name: interface-id
28387 - name: port-group-id
28392 - name: switch-name
28397 - name: heat-stack-id
28402 /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
28406 summary: see node definition for valid relationships
28407 operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship
28416 description: Response codes found in [response codes](https://wiki.onap.org/).
28420 description: Unique id of VNF. This is unique across the graph.
28423 example: __VNF-ID__
28426 description: Unique ID for the license group the resource belongs to, should be uuid.
28429 example: __GROUP-UUID__
28430 - name: resource-uuid
28432 description: Unique ID of a license resource.
28435 example: __RESOURCE-UUID__
28438 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceLicensesLicense.json)
28441 $ref: "#/definitions/relationship"
28445 summary: delete an existing relationship
28446 description: delete an existing relationship
28447 operationId: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship
28456 description: Response codes found in [response codes](https://wiki.onap.org/).
28460 description: Unique id of VNF. This is unique across the graph.
28463 example: __VNF-ID__
28466 description: Unique ID for the license group the resource belongs to, should be uuid.
28469 example: __GROUP-UUID__
28470 - name: resource-uuid
28472 description: Unique ID of a license resource.
28475 example: __RESOURCE-UUID__
28476 /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
28480 summary: returns license
28481 description: returns license
28482 operationId: getNetworkVcesVceLicensesLicense
28488 description: successful operation
28490 $ref: "#/getDefinitions/license"
28492 description: Response codes found in [response codes](https://wiki.onap.org/).
28496 description: Unique id of VNF. This is unique across the graph.
28499 example: __VNF-ID__
28502 description: Unique ID for the license group the resource belongs to, should be uuid.
28505 example: __GROUP-UUID__
28506 - name: resource-uuid
28508 description: Unique ID of a license resource.
28511 example: __RESOURCE-UUID__
28515 summary: create or update an existing license
28517 Create or update an existing license.
28519 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28520 operationId: createOrUpdateNetworkVcesVceLicensesLicense
28529 description: Response codes found in [response codes](https://wiki.onap.org/).
28533 description: Unique id of VNF. This is unique across the graph.
28536 example: __VNF-ID__
28539 description: Unique ID for the license group the resource belongs to, should be uuid.
28542 example: __GROUP-UUID__
28543 - name: resource-uuid
28545 description: Unique ID of a license resource.
28548 example: __RESOURCE-UUID__
28551 description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceLicensesLicense.json)
28554 $ref: "#/definitions/license"
28558 summary: update an existing license
28560 Update an existing license
28562 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28563 The PUT operation will entirely replace an existing object.
28564 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28566 Other differences between PUT and PATCH are:
28568 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28569 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28570 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28571 operationId: UpdateNetworkVcesVceLicensesLicense
28580 description: Response codes found in [response codes](https://wiki.onap.org/).
28584 description: Unique id of VNF. This is unique across the graph.
28587 example: __VNF-ID__
28590 description: Unique ID for the license group the resource belongs to, should be uuid.
28593 example: __GROUP-UUID__
28594 - name: resource-uuid
28596 description: Unique ID of a license resource.
28599 example: __RESOURCE-UUID__
28602 description: license object that needs to be updated.
28605 $ref: "#/patchDefinitions/license"
28609 summary: delete an existing license
28610 description: delete an existing license
28611 operationId: deleteNetworkVcesVceLicensesLicense
28620 description: Response codes found in [response codes](https://wiki.onap.org/).
28624 description: Unique id of VNF. This is unique across the graph.
28627 example: __VNF-ID__
28630 description: Unique ID for the license group the resource belongs to, should be uuid.
28633 example: __GROUP-UUID__
28634 - name: resource-uuid
28636 description: Unique ID of a license resource.
28639 example: __RESOURCE-UUID__
28640 - name: resource-version
28642 description: resource-version for concurrency
28645 /network/vces/vce/{vnf-id}/licenses:
28649 summary: returns licenses
28650 description: returns licenses
28651 operationId: getNetworkVcesVceLicenses
28657 description: successful operation
28659 $ref: "#/getDefinitions/licenses"
28661 description: Response codes found in [response codes](https://wiki.onap.org/).
28665 description: Unique id of VNF. This is unique across the graph.
28668 example: __VNF-ID__
28674 - name: resource-uuid
28679 /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
28683 summary: see node definition for valid relationships
28684 operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
28693 description: Response codes found in [response codes](https://wiki.onap.org/).
28697 description: Unique id of VNF. This is unique across the graph.
28700 example: __VNF-ID__
28703 description: Unique ID for the entitlement group the resource comes from, should be uuid.
28706 example: __GROUP-UUID__
28707 - name: resource-uuid
28709 description: Unique ID of an entitlement resource.
28712 example: __RESOURCE-UUID__
28715 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceEntitlementsEntitlement.json)
28718 $ref: "#/definitions/relationship"
28722 summary: delete an existing relationship
28723 description: delete an existing relationship
28724 operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
28733 description: Response codes found in [response codes](https://wiki.onap.org/).
28737 description: Unique id of VNF. This is unique across the graph.
28740 example: __VNF-ID__
28743 description: Unique ID for the entitlement group the resource comes from, should be uuid.
28746 example: __GROUP-UUID__
28747 - name: resource-uuid
28749 description: Unique ID of an entitlement resource.
28752 example: __RESOURCE-UUID__
28753 /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
28757 summary: returns entitlement
28758 description: returns entitlement
28759 operationId: getNetworkVcesVceEntitlementsEntitlement
28765 description: successful operation
28767 $ref: "#/getDefinitions/entitlement"
28769 description: Response codes found in [response codes](https://wiki.onap.org/).
28773 description: Unique id of VNF. This is unique across the graph.
28776 example: __VNF-ID__
28779 description: Unique ID for the entitlement group the resource comes from, should be uuid.
28782 example: __GROUP-UUID__
28783 - name: resource-uuid
28785 description: Unique ID of an entitlement resource.
28788 example: __RESOURCE-UUID__
28792 summary: create or update an existing entitlement
28794 Create or update an existing entitlement.
28796 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28797 operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement
28806 description: Response codes found in [response codes](https://wiki.onap.org/).
28810 description: Unique id of VNF. This is unique across the graph.
28813 example: __VNF-ID__
28816 description: Unique ID for the entitlement group the resource comes from, should be uuid.
28819 example: __GROUP-UUID__
28820 - name: resource-uuid
28822 description: Unique ID of an entitlement resource.
28825 example: __RESOURCE-UUID__
28828 description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVceEntitlementsEntitlement.json)
28831 $ref: "#/definitions/entitlement"
28835 summary: update an existing entitlement
28837 Update an existing entitlement
28839 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28840 The PUT operation will entirely replace an existing object.
28841 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28843 Other differences between PUT and PATCH are:
28845 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28846 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28847 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28848 operationId: UpdateNetworkVcesVceEntitlementsEntitlement
28857 description: Response codes found in [response codes](https://wiki.onap.org/).
28861 description: Unique id of VNF. This is unique across the graph.
28864 example: __VNF-ID__
28867 description: Unique ID for the entitlement group the resource comes from, should be uuid.
28870 example: __GROUP-UUID__
28871 - name: resource-uuid
28873 description: Unique ID of an entitlement resource.
28876 example: __RESOURCE-UUID__
28879 description: entitlement object that needs to be updated.
28882 $ref: "#/patchDefinitions/entitlement"
28886 summary: delete an existing entitlement
28887 description: delete an existing entitlement
28888 operationId: deleteNetworkVcesVceEntitlementsEntitlement
28897 description: Response codes found in [response codes](https://wiki.onap.org/).
28901 description: Unique id of VNF. This is unique across the graph.
28904 example: __VNF-ID__
28907 description: Unique ID for the entitlement group the resource comes from, should be uuid.
28910 example: __GROUP-UUID__
28911 - name: resource-uuid
28913 description: Unique ID of an entitlement resource.
28916 example: __RESOURCE-UUID__
28917 - name: resource-version
28919 description: resource-version for concurrency
28922 /network/vces/vce/{vnf-id}/entitlements:
28926 summary: returns entitlements
28927 description: returns entitlements
28928 operationId: getNetworkVcesVceEntitlements
28934 description: successful operation
28936 $ref: "#/getDefinitions/entitlements"
28938 description: Response codes found in [response codes](https://wiki.onap.org/).
28942 description: Unique id of VNF. This is unique across the graph.
28945 example: __VNF-ID__
28951 - name: resource-uuid
28956 /network/vces/vce/{vnf-id}/relationship-list/relationship:
28960 summary: see node definition for valid relationships
28961 operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship
28970 description: Response codes found in [response codes](https://wiki.onap.org/).
28974 description: Unique id of VNF. This is unique across the graph.
28977 example: __VNF-ID__
28980 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVce.json)
28983 $ref: "#/definitions/relationship"
28987 summary: delete an existing relationship
28988 description: delete an existing relationship
28989 operationId: deleteNetworkVcesVceRelationshipListRelationship
28998 description: Response codes found in [response codes](https://wiki.onap.org/).
29002 description: Unique id of VNF. This is unique across the graph.
29005 example: __VNF-ID__
29006 /network/vces/vce/{vnf-id}:
29010 summary: returns vce
29011 description: returns vce
29012 operationId: getNetworkVcesVce
29018 description: successful operation
29020 $ref: "#/getDefinitions/vce"
29022 description: Response codes found in [response codes](https://wiki.onap.org/).
29026 description: Unique id of VNF. This is unique across the graph.
29029 example: __VNF-ID__
29033 summary: create or update an existing vce
29035 Create or update an existing vce.
29037 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29038 operationId: createOrUpdateNetworkVcesVce
29047 description: Response codes found in [response codes](https://wiki.onap.org/).
29051 description: Unique id of VNF. This is unique across the graph.
29054 example: __VNF-ID__
29057 description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVcesVce.json)
29060 $ref: "#/definitions/vce"
29064 summary: update an existing vce
29066 Update an existing vce
29068 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29069 The PUT operation will entirely replace an existing object.
29070 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29072 Other differences between PUT and PATCH are:
29074 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29075 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29076 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29077 operationId: UpdateNetworkVcesVce
29086 description: Response codes found in [response codes](https://wiki.onap.org/).
29090 description: Unique id of VNF. This is unique across the graph.
29093 example: __VNF-ID__
29096 description: vce object that needs to be updated.
29099 $ref: "#/patchDefinitions/vce"
29103 summary: delete an existing vce
29104 description: delete an existing vce
29105 operationId: deleteNetworkVcesVce
29114 description: Response codes found in [response codes](https://wiki.onap.org/).
29118 description: Unique id of VNF. This is unique across the graph.
29121 example: __VNF-ID__
29122 - name: resource-version
29124 description: resource-version for concurrency
29131 summary: returns vces
29132 description: returns vces
29133 operationId: getNetworkVces
29139 description: successful operation
29141 $ref: "#/getDefinitions/vces"
29143 description: Response codes found in [response codes](https://wiki.onap.org/).
29170 - name: regional-resource-zone
29175 - name: prov-status
29180 - name: heat-stack-id
29190 /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
29194 summary: see node definition for valid relationships
29195 operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship
29204 description: Response codes found in [response codes](https://wiki.onap.org/).
29208 description: Unique ID of vnfc.
29211 example: __VNFC-NAME__
29214 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfc.json)
29217 $ref: "#/definitions/relationship"
29221 summary: delete an existing relationship
29222 description: delete an existing relationship
29223 operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship
29232 description: Response codes found in [response codes](https://wiki.onap.org/).
29236 description: Unique ID of vnfc.
29239 example: __VNFC-NAME__
29240 /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
29244 summary: see node definition for valid relationships
29245 operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
29254 description: Response codes found in [response codes](https://wiki.onap.org/).
29258 description: Unique ID of vnfc.
29261 example: __VNFC-NAME__
29262 - name: l3-interface-ipv4-address
29264 description: IP address
29267 example: __L3-INTERFACE-IPV4-ADDRESS__
29270 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)
29273 $ref: "#/definitions/relationship"
29277 summary: delete an existing relationship
29278 description: delete an existing relationship
29279 operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
29288 description: Response codes found in [response codes](https://wiki.onap.org/).
29292 description: Unique ID of vnfc.
29295 example: __VNFC-NAME__
29296 - name: l3-interface-ipv4-address
29298 description: IP address
29301 example: __L3-INTERFACE-IPV4-ADDRESS__
29302 /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
29306 summary: returns l3-interface-ipv4-address-list
29307 description: returns l3-interface-ipv4-address-list
29308 operationId: getNetworkVnfcsVnfcL3InterfaceIpv4AddressList
29314 description: successful operation
29316 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
29318 description: Response codes found in [response codes](https://wiki.onap.org/).
29322 description: Unique ID of vnfc.
29325 example: __VNFC-NAME__
29326 - name: l3-interface-ipv4-address
29328 description: IP address
29331 example: __L3-INTERFACE-IPV4-ADDRESS__
29335 summary: create or update an existing l3-interface-ipv4-address-list
29337 Create or update an existing l3-interface-ipv4-address-list.
29339 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29340 operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
29349 description: Response codes found in [response codes](https://wiki.onap.org/).
29353 description: Unique ID of vnfc.
29356 example: __VNFC-NAME__
29357 - name: l3-interface-ipv4-address
29359 description: IP address
29362 example: __L3-INTERFACE-IPV4-ADDRESS__
29365 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)
29368 $ref: "#/definitions/l3-interface-ipv4-address-list"
29372 summary: update an existing l3-interface-ipv4-address-list
29374 Update an existing l3-interface-ipv4-address-list
29376 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29377 The PUT operation will entirely replace an existing object.
29378 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29380 Other differences between PUT and PATCH are:
29382 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29383 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29384 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29385 operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
29394 description: Response codes found in [response codes](https://wiki.onap.org/).
29398 description: Unique ID of vnfc.
29401 example: __VNFC-NAME__
29402 - name: l3-interface-ipv4-address
29404 description: IP address
29407 example: __L3-INTERFACE-IPV4-ADDRESS__
29410 description: l3-interface-ipv4-address-list object that needs to be updated.
29413 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
29417 summary: delete an existing l3-interface-ipv4-address-list
29418 description: delete an existing l3-interface-ipv4-address-list
29419 operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressList
29428 description: Response codes found in [response codes](https://wiki.onap.org/).
29432 description: Unique ID of vnfc.
29435 example: __VNFC-NAME__
29436 - name: l3-interface-ipv4-address
29438 description: IP address
29441 example: __L3-INTERFACE-IPV4-ADDRESS__
29442 - name: resource-version
29444 description: resource-version for concurrency
29447 /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
29451 summary: see node definition for valid relationships
29452 operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
29461 description: Response codes found in [response codes](https://wiki.onap.org/).
29465 description: Unique ID of vnfc.
29468 example: __VNFC-NAME__
29469 - name: l3-interface-ipv6-address
29471 description: IP address
29474 example: __L3-INTERFACE-IPV6-ADDRESS__
29477 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)
29480 $ref: "#/definitions/relationship"
29484 summary: delete an existing relationship
29485 description: delete an existing relationship
29486 operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
29495 description: Response codes found in [response codes](https://wiki.onap.org/).
29499 description: Unique ID of vnfc.
29502 example: __VNFC-NAME__
29503 - name: l3-interface-ipv6-address
29505 description: IP address
29508 example: __L3-INTERFACE-IPV6-ADDRESS__
29509 /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
29513 summary: returns l3-interface-ipv6-address-list
29514 description: returns l3-interface-ipv6-address-list
29515 operationId: getNetworkVnfcsVnfcL3InterfaceIpv6AddressList
29521 description: successful operation
29523 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
29525 description: Response codes found in [response codes](https://wiki.onap.org/).
29529 description: Unique ID of vnfc.
29532 example: __VNFC-NAME__
29533 - name: l3-interface-ipv6-address
29535 description: IP address
29538 example: __L3-INTERFACE-IPV6-ADDRESS__
29542 summary: create or update an existing l3-interface-ipv6-address-list
29544 Create or update an existing l3-interface-ipv6-address-list.
29546 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29547 operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
29556 description: Response codes found in [response codes](https://wiki.onap.org/).
29560 description: Unique ID of vnfc.
29563 example: __VNFC-NAME__
29564 - name: l3-interface-ipv6-address
29566 description: IP address
29569 example: __L3-INTERFACE-IPV6-ADDRESS__
29572 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)
29575 $ref: "#/definitions/l3-interface-ipv6-address-list"
29579 summary: update an existing l3-interface-ipv6-address-list
29581 Update an existing l3-interface-ipv6-address-list
29583 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29584 The PUT operation will entirely replace an existing object.
29585 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29587 Other differences between PUT and PATCH are:
29589 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29590 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29591 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29592 operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
29601 description: Response codes found in [response codes](https://wiki.onap.org/).
29605 description: Unique ID of vnfc.
29608 example: __VNFC-NAME__
29609 - name: l3-interface-ipv6-address
29611 description: IP address
29614 example: __L3-INTERFACE-IPV6-ADDRESS__
29617 description: l3-interface-ipv6-address-list object that needs to be updated.
29620 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
29624 summary: delete an existing l3-interface-ipv6-address-list
29625 description: delete an existing l3-interface-ipv6-address-list
29626 operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressList
29635 description: Response codes found in [response codes](https://wiki.onap.org/).
29639 description: Unique ID of vnfc.
29642 example: __VNFC-NAME__
29643 - name: l3-interface-ipv6-address
29645 description: IP address
29648 example: __L3-INTERFACE-IPV6-ADDRESS__
29649 - name: resource-version
29651 description: resource-version for concurrency
29654 /network/vnfcs/vnfc/{vnfc-name}:
29658 summary: returns vnfc
29659 description: returns vnfc
29660 operationId: getNetworkVnfcsVnfc
29666 description: successful operation
29668 $ref: "#/getDefinitions/vnfc"
29670 description: Response codes found in [response codes](https://wiki.onap.org/).
29674 description: Unique ID of vnfc.
29677 example: __VNFC-NAME__
29681 summary: create or update an existing vnfc
29683 Create or update an existing vnfc.
29685 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29686 operationId: createOrUpdateNetworkVnfcsVnfc
29695 description: Response codes found in [response codes](https://wiki.onap.org/).
29699 description: Unique ID of vnfc.
29702 example: __VNFC-NAME__
29705 description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkVnfcsVnfc.json)
29708 $ref: "#/definitions/vnfc"
29712 summary: update an existing vnfc
29714 Update an existing vnfc
29716 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29717 The PUT operation will entirely replace an existing object.
29718 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29720 Other differences between PUT and PATCH are:
29722 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29723 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29724 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29725 operationId: UpdateNetworkVnfcsVnfc
29734 description: Response codes found in [response codes](https://wiki.onap.org/).
29738 description: Unique ID of vnfc.
29741 example: __VNFC-NAME__
29744 description: vnfc object that needs to be updated.
29747 $ref: "#/patchDefinitions/vnfc"
29751 summary: delete an existing vnfc
29752 description: delete an existing vnfc
29753 operationId: deleteNetworkVnfcsVnfc
29762 description: Response codes found in [response codes](https://wiki.onap.org/).
29766 description: Unique ID of vnfc.
29769 example: __VNFC-NAME__
29770 - name: resource-version
29772 description: resource-version for concurrency
29779 summary: returns vnfcs
29780 description: returns vnfcs
29781 operationId: getNetworkVnfcs
29787 description: successful operation
29789 $ref: "#/getDefinitions/vnfcs"
29791 description: Response codes found in [response codes](https://wiki.onap.org/).
29798 - name: nfc-naming-code
29803 - name: nfc-function
29808 - name: prov-status
29813 - name: ipaddress-v4-oam-vip
29823 - name: is-closed-loop-disabled
29828 - name: group-notation
29833 - name: model-invariant-id
29838 - name: model-version-id
29843 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship:
29847 summary: see node definition for valid relationships
29848 operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
29857 description: Response codes found in [response codes](https://wiki.onap.org/).
29861 description: Network ID, should be uuid. Unique across A&AI.
29864 example: __NETWORK-ID__
29867 description: Subnet ID, should be UUID.
29870 example: __SUBNET-ID__
29871 - name: host-route-id
29873 description: host-route id
29876 example: __HOST-ROUTE-ID__
29879 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)
29882 $ref: "#/definitions/relationship"
29886 summary: delete an existing relationship
29887 description: delete an existing relationship
29888 operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
29897 description: Response codes found in [response codes](https://wiki.onap.org/).
29901 description: Network ID, should be uuid. Unique across A&AI.
29904 example: __NETWORK-ID__
29907 description: Subnet ID, should be UUID.
29910 example: __SUBNET-ID__
29911 - name: host-route-id
29913 description: host-route id
29916 example: __HOST-ROUTE-ID__
29917 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}:
29921 summary: returns host-route
29922 description: returns host-route
29923 operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
29929 description: successful operation
29931 $ref: "#/getDefinitions/host-route"
29933 description: Response codes found in [response codes](https://wiki.onap.org/).
29937 description: Network ID, should be uuid. Unique across A&AI.
29940 example: __NETWORK-ID__
29943 description: Subnet ID, should be UUID.
29946 example: __SUBNET-ID__
29947 - name: host-route-id
29949 description: host-route id
29952 example: __HOST-ROUTE-ID__
29956 summary: create or update an existing host-route
29958 Create or update an existing host-route.
29960 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29961 operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
29970 description: Response codes found in [response codes](https://wiki.onap.org/).
29974 description: Network ID, should be uuid. Unique across A&AI.
29977 example: __NETWORK-ID__
29980 description: Subnet ID, should be UUID.
29983 example: __SUBNET-ID__
29984 - name: host-route-id
29986 description: host-route id
29989 example: __HOST-ROUTE-ID__
29992 description: host-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)
29995 $ref: "#/definitions/host-route"
29999 summary: update an existing host-route
30001 Update an existing host-route
30003 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30004 The PUT operation will entirely replace an existing object.
30005 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30007 Other differences between PUT and PATCH are:
30009 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30010 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30011 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30012 operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
30021 description: Response codes found in [response codes](https://wiki.onap.org/).
30025 description: Network ID, should be uuid. Unique across A&AI.
30028 example: __NETWORK-ID__
30031 description: Subnet ID, should be UUID.
30034 example: __SUBNET-ID__
30035 - name: host-route-id
30037 description: host-route id
30040 example: __HOST-ROUTE-ID__
30043 description: host-route object that needs to be updated.
30046 $ref: "#/patchDefinitions/host-route"
30050 summary: delete an existing host-route
30051 description: delete an existing host-route
30052 operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
30061 description: Response codes found in [response codes](https://wiki.onap.org/).
30065 description: Network ID, should be uuid. Unique across A&AI.
30068 example: __NETWORK-ID__
30071 description: Subnet ID, should be UUID.
30074 example: __SUBNET-ID__
30075 - name: host-route-id
30077 description: host-route id
30080 example: __HOST-ROUTE-ID__
30081 - name: resource-version
30083 description: resource-version for concurrency
30086 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes:
30090 summary: returns host-routes
30091 description: returns host-routes
30092 operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutes
30098 description: successful operation
30100 $ref: "#/getDefinitions/host-routes"
30102 description: Response codes found in [response codes](https://wiki.onap.org/).
30106 description: Network ID, should be uuid. Unique across A&AI.
30109 example: __NETWORK-ID__
30112 description: Subnet ID, should be UUID.
30115 example: __SUBNET-ID__
30116 - name: host-route-id
30121 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
30125 summary: see node definition for valid relationships
30126 operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
30135 description: Response codes found in [response codes](https://wiki.onap.org/).
30139 description: Network ID, should be uuid. Unique across A&AI.
30142 example: __NETWORK-ID__
30145 description: Subnet ID, should be UUID.
30148 example: __SUBNET-ID__
30151 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
30154 $ref: "#/definitions/relationship"
30158 summary: delete an existing relationship
30159 description: delete an existing relationship
30160 operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
30169 description: Response codes found in [response codes](https://wiki.onap.org/).
30173 description: Network ID, should be uuid. Unique across A&AI.
30176 example: __NETWORK-ID__
30179 description: Subnet ID, should be UUID.
30182 example: __SUBNET-ID__
30183 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}:
30187 summary: returns subnet
30188 description: returns subnet
30189 operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet
30195 description: successful operation
30197 $ref: "#/getDefinitions/subnet"
30199 description: Response codes found in [response codes](https://wiki.onap.org/).
30203 description: Network ID, should be uuid. Unique across A&AI.
30206 example: __NETWORK-ID__
30209 description: Subnet ID, should be UUID.
30212 example: __SUBNET-ID__
30216 summary: create or update an existing subnet
30218 Create or update an existing subnet.
30220 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30221 operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet
30230 description: Response codes found in [response codes](https://wiki.onap.org/).
30234 description: Network ID, should be uuid. Unique across A&AI.
30237 example: __NETWORK-ID__
30240 description: Subnet ID, should be UUID.
30243 example: __SUBNET-ID__
30246 description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
30249 $ref: "#/definitions/subnet"
30253 summary: update an existing subnet
30255 Update an existing subnet
30257 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30258 The PUT operation will entirely replace an existing object.
30259 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30261 Other differences between PUT and PATCH are:
30263 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30264 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30265 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30266 operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet
30275 description: Response codes found in [response codes](https://wiki.onap.org/).
30279 description: Network ID, should be uuid. Unique across A&AI.
30282 example: __NETWORK-ID__
30285 description: Subnet ID, should be UUID.
30288 example: __SUBNET-ID__
30291 description: subnet object that needs to be updated.
30294 $ref: "#/patchDefinitions/subnet"
30298 summary: delete an existing subnet
30299 description: delete an existing subnet
30300 operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet
30309 description: Response codes found in [response codes](https://wiki.onap.org/).
30313 description: Network ID, should be uuid. Unique across A&AI.
30316 example: __NETWORK-ID__
30319 description: Subnet ID, should be UUID.
30322 example: __SUBNET-ID__
30323 - name: resource-version
30325 description: resource-version for concurrency
30328 /network/l3-networks/l3-network/{network-id}/subnets:
30332 summary: returns subnets
30333 description: returns subnets
30334 operationId: getNetworkL3NetworksL3NetworkSubnets
30340 description: successful operation
30342 $ref: "#/getDefinitions/subnets"
30344 description: Response codes found in [response codes](https://wiki.onap.org/).
30348 description: Network ID, should be uuid. Unique across A&AI.
30351 example: __NETWORK-ID__
30357 - name: subnet-name
30362 /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship:
30366 summary: see node definition for valid relationships
30367 operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
30376 description: Response codes found in [response codes](https://wiki.onap.org/).
30380 description: Network ID, should be uuid. Unique across A&AI.
30383 example: __NETWORK-ID__
30384 - name: vlan-id-inner
30390 example: __VLAN-ID-INNER__
30393 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
30396 $ref: "#/definitions/relationship"
30400 summary: delete an existing relationship
30401 description: delete an existing relationship
30402 operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
30411 description: Response codes found in [response codes](https://wiki.onap.org/).
30415 description: Network ID, should be uuid. Unique across A&AI.
30418 example: __NETWORK-ID__
30419 - name: vlan-id-inner
30425 example: __VLAN-ID-INNER__
30426 /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}:
30430 summary: returns ctag-assignment
30431 description: returns ctag-assignment
30432 operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
30438 description: successful operation
30440 $ref: "#/getDefinitions/ctag-assignment"
30442 description: Response codes found in [response codes](https://wiki.onap.org/).
30446 description: Network ID, should be uuid. Unique across A&AI.
30449 example: __NETWORK-ID__
30450 - name: vlan-id-inner
30456 example: __VLAN-ID-INNER__
30460 summary: create or update an existing ctag-assignment
30462 Create or update an existing ctag-assignment.
30464 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30465 operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
30474 description: Response codes found in [response codes](https://wiki.onap.org/).
30478 description: Network ID, should be uuid. Unique across A&AI.
30481 example: __NETWORK-ID__
30482 - name: vlan-id-inner
30488 example: __VLAN-ID-INNER__
30491 description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
30494 $ref: "#/definitions/ctag-assignment"
30498 summary: update an existing ctag-assignment
30500 Update an existing ctag-assignment
30502 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30503 The PUT operation will entirely replace an existing object.
30504 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30506 Other differences between PUT and PATCH are:
30508 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30509 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30510 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30511 operationId: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
30520 description: Response codes found in [response codes](https://wiki.onap.org/).
30524 description: Network ID, should be uuid. Unique across A&AI.
30527 example: __NETWORK-ID__
30528 - name: vlan-id-inner
30534 example: __VLAN-ID-INNER__
30537 description: ctag-assignment object that needs to be updated.
30540 $ref: "#/patchDefinitions/ctag-assignment"
30544 summary: delete an existing ctag-assignment
30545 description: delete an existing ctag-assignment
30546 operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
30555 description: Response codes found in [response codes](https://wiki.onap.org/).
30559 description: Network ID, should be uuid. Unique across A&AI.
30562 example: __NETWORK-ID__
30563 - name: vlan-id-inner
30569 example: __VLAN-ID-INNER__
30570 - name: resource-version
30572 description: resource-version for concurrency
30575 /network/l3-networks/l3-network/{network-id}/ctag-assignments:
30579 summary: returns ctag-assignments
30580 description: returns ctag-assignments
30581 operationId: getNetworkL3NetworksL3NetworkCtagAssignments
30587 description: successful operation
30589 $ref: "#/getDefinitions/ctag-assignments"
30591 description: Response codes found in [response codes](https://wiki.onap.org/).
30595 description: Network ID, should be uuid. Unique across A&AI.
30598 example: __NETWORK-ID__
30599 - name: vlan-id-inner
30605 /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship:
30609 summary: see node definition for valid relationships
30610 operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
30619 description: Response codes found in [response codes](https://wiki.onap.org/).
30623 description: Network ID, should be uuid. Unique across A&AI.
30626 example: __NETWORK-ID__
30627 - name: segmentation-id
30629 description: Route Table Reference id, UUID assigned to this instance.
30632 example: __SEGMENTATION-ID__
30635 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
30638 $ref: "#/definitions/relationship"
30642 summary: delete an existing relationship
30643 description: delete an existing relationship
30644 operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
30653 description: Response codes found in [response codes](https://wiki.onap.org/).
30657 description: Network ID, should be uuid. Unique across A&AI.
30660 example: __NETWORK-ID__
30661 - name: segmentation-id
30663 description: Route Table Reference id, UUID assigned to this instance.
30666 example: __SEGMENTATION-ID__
30667 /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}:
30671 summary: returns segmentation-assignment
30672 description: returns segmentation-assignment
30673 operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
30679 description: successful operation
30681 $ref: "#/getDefinitions/segmentation-assignment"
30683 description: Response codes found in [response codes](https://wiki.onap.org/).
30687 description: Network ID, should be uuid. Unique across A&AI.
30690 example: __NETWORK-ID__
30691 - name: segmentation-id
30693 description: Route Table Reference id, UUID assigned to this instance.
30696 example: __SEGMENTATION-ID__
30700 summary: create or update an existing segmentation-assignment
30702 Create or update an existing segmentation-assignment.
30704 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30705 operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
30714 description: Response codes found in [response codes](https://wiki.onap.org/).
30718 description: Network ID, should be uuid. Unique across A&AI.
30721 example: __NETWORK-ID__
30722 - name: segmentation-id
30724 description: Route Table Reference id, UUID assigned to this instance.
30727 example: __SEGMENTATION-ID__
30730 description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
30733 $ref: "#/definitions/segmentation-assignment"
30737 summary: update an existing segmentation-assignment
30739 Update an existing segmentation-assignment
30741 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30742 The PUT operation will entirely replace an existing object.
30743 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30745 Other differences between PUT and PATCH are:
30747 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30748 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30749 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30750 operationId: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
30759 description: Response codes found in [response codes](https://wiki.onap.org/).
30763 description: Network ID, should be uuid. Unique across A&AI.
30766 example: __NETWORK-ID__
30767 - name: segmentation-id
30769 description: Route Table Reference id, UUID assigned to this instance.
30772 example: __SEGMENTATION-ID__
30775 description: segmentation-assignment object that needs to be updated.
30778 $ref: "#/patchDefinitions/segmentation-assignment"
30782 summary: delete an existing segmentation-assignment
30783 description: delete an existing segmentation-assignment
30784 operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
30793 description: Response codes found in [response codes](https://wiki.onap.org/).
30797 description: Network ID, should be uuid. Unique across A&AI.
30800 example: __NETWORK-ID__
30801 - name: segmentation-id
30803 description: Route Table Reference id, UUID assigned to this instance.
30806 example: __SEGMENTATION-ID__
30807 - name: resource-version
30809 description: resource-version for concurrency
30812 /network/l3-networks/l3-network/{network-id}/segmentation-assignments:
30816 summary: returns segmentation-assignments
30817 description: returns segmentation-assignments
30818 operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments
30824 description: successful operation
30826 $ref: "#/getDefinitions/segmentation-assignments"
30828 description: Response codes found in [response codes](https://wiki.onap.org/).
30832 description: Network ID, should be uuid. Unique across A&AI.
30835 example: __NETWORK-ID__
30836 - name: segmentation-id
30841 /network/l3-networks/l3-network/{network-id}/relationship-list/relationship:
30845 summary: see node definition for valid relationships
30846 operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship
30855 description: Response codes found in [response codes](https://wiki.onap.org/).
30859 description: Network ID, should be uuid. Unique across A&AI.
30862 example: __NETWORK-ID__
30865 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3Network.json)
30868 $ref: "#/definitions/relationship"
30872 summary: delete an existing relationship
30873 description: delete an existing relationship
30874 operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship
30883 description: Response codes found in [response codes](https://wiki.onap.org/).
30887 description: Network ID, should be uuid. Unique across A&AI.
30890 example: __NETWORK-ID__
30891 /network/l3-networks/l3-network/{network-id}:
30895 summary: returns l3-network
30896 description: returns l3-network
30897 operationId: getNetworkL3NetworksL3Network
30903 description: successful operation
30905 $ref: "#/getDefinitions/l3-network"
30907 description: Response codes found in [response codes](https://wiki.onap.org/).
30911 description: Network ID, should be uuid. Unique across A&AI.
30914 example: __NETWORK-ID__
30918 summary: create or update an existing l3-network
30920 Create or update an existing l3-network.
30922 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30923 operationId: createOrUpdateNetworkL3NetworksL3Network
30932 description: Response codes found in [response codes](https://wiki.onap.org/).
30936 description: Network ID, should be uuid. Unique across A&AI.
30939 example: __NETWORK-ID__
30942 description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkL3NetworksL3Network.json)
30945 $ref: "#/definitions/l3-network"
30949 summary: update an existing l3-network
30951 Update an existing l3-network
30953 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30954 The PUT operation will entirely replace an existing object.
30955 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30957 Other differences between PUT and PATCH are:
30959 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30960 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30961 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30962 operationId: UpdateNetworkL3NetworksL3Network
30971 description: Response codes found in [response codes](https://wiki.onap.org/).
30975 description: Network ID, should be uuid. Unique across A&AI.
30978 example: __NETWORK-ID__
30981 description: l3-network object that needs to be updated.
30984 $ref: "#/patchDefinitions/l3-network"
30988 summary: delete an existing l3-network
30989 description: delete an existing l3-network
30990 operationId: deleteNetworkL3NetworksL3Network
30999 description: Response codes found in [response codes](https://wiki.onap.org/).
31003 description: Network ID, should be uuid. Unique across A&AI.
31006 example: __NETWORK-ID__
31007 - name: resource-version
31009 description: resource-version for concurrency
31012 /network/l3-networks:
31016 summary: returns l3-networks
31017 description: returns l3-networks
31018 operationId: getNetworkL3Networks
31024 description: successful operation
31026 $ref: "#/getDefinitions/l3-networks"
31028 description: Response codes found in [response codes](https://wiki.onap.org/).
31035 - name: network-name
31040 - name: network-role
31050 - name: heat-stack-id
31055 - name: contrail-network-fqdn
31060 - name: model-invariant-id
31065 - name: model-version-id
31070 - name: widget-model-id
31075 - name: widget-model-version
31080 /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship:
31084 summary: see node definition for valid relationships
31085 operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
31094 description: Response codes found in [response codes](https://wiki.onap.org/).
31096 - name: network-policy-id
31098 description: UUID representing unique key to this instance
31101 example: __NETWORK-POLICY-ID__
31104 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNetworkPoliciesNetworkPolicy.json)
31107 $ref: "#/definitions/relationship"
31111 summary: delete an existing relationship
31112 description: delete an existing relationship
31113 operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
31122 description: Response codes found in [response codes](https://wiki.onap.org/).
31124 - name: network-policy-id
31126 description: UUID representing unique key to this instance
31129 example: __NETWORK-POLICY-ID__
31130 /network/network-policies/network-policy/{network-policy-id}:
31134 summary: returns network-policy
31135 description: returns network-policy
31136 operationId: getNetworkNetworkPoliciesNetworkPolicy
31142 description: successful operation
31144 $ref: "#/getDefinitions/network-policy"
31146 description: Response codes found in [response codes](https://wiki.onap.org/).
31148 - name: network-policy-id
31150 description: UUID representing unique key to this instance
31153 example: __NETWORK-POLICY-ID__
31157 summary: create or update an existing network-policy
31159 Create or update an existing network-policy.
31161 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31162 operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy
31171 description: Response codes found in [response codes](https://wiki.onap.org/).
31173 - name: network-policy-id
31175 description: UUID representing unique key to this instance
31178 example: __NETWORK-POLICY-ID__
31181 description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNetworkPoliciesNetworkPolicy.json)
31184 $ref: "#/definitions/network-policy"
31188 summary: update an existing network-policy
31190 Update an existing network-policy
31192 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31193 The PUT operation will entirely replace an existing object.
31194 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31196 Other differences between PUT and PATCH are:
31198 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31199 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31200 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31201 operationId: UpdateNetworkNetworkPoliciesNetworkPolicy
31210 description: Response codes found in [response codes](https://wiki.onap.org/).
31212 - name: network-policy-id
31214 description: UUID representing unique key to this instance
31217 example: __NETWORK-POLICY-ID__
31220 description: network-policy object that needs to be updated.
31223 $ref: "#/patchDefinitions/network-policy"
31227 summary: delete an existing network-policy
31228 description: delete an existing network-policy
31229 operationId: deleteNetworkNetworkPoliciesNetworkPolicy
31238 description: Response codes found in [response codes](https://wiki.onap.org/).
31240 - name: network-policy-id
31242 description: UUID representing unique key to this instance
31245 example: __NETWORK-POLICY-ID__
31246 - name: resource-version
31248 description: resource-version for concurrency
31251 /network/network-policies:
31255 summary: returns network-policies
31256 description: returns network-policies
31257 operationId: getNetworkNetworkPolicies
31263 description: successful operation
31265 $ref: "#/getDefinitions/network-policies"
31267 description: Response codes found in [response codes](https://wiki.onap.org/).
31269 - name: network-policy-id
31274 - name: network-policy-fqdn
31279 /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship:
31283 summary: see node definition for valid relationships
31284 operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship
31293 description: Response codes found in [response codes](https://wiki.onap.org/).
31297 description: Unique id of VNF. This is unique across the graph.
31300 example: __VNF-ID__
31303 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnf.json)
31306 $ref: "#/definitions/relationship"
31310 summary: delete an existing relationship
31311 description: delete an existing relationship
31312 operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship
31321 description: Response codes found in [response codes](https://wiki.onap.org/).
31325 description: Unique id of VNF. This is unique across the graph.
31328 example: __VNF-ID__
31329 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
31333 summary: see node definition for valid relationships
31334 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
31343 description: Response codes found in [response codes](https://wiki.onap.org/).
31347 description: Unique id of VNF. This is unique across the graph.
31350 example: __VNF-ID__
31351 - name: interface-name
31353 description: Name given to the interface
31356 example: __INTERFACE-NAME__
31357 - name: vlan-interface
31359 description: String that identifies the interface
31362 example: __VLAN-INTERFACE__
31365 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
31368 $ref: "#/definitions/relationship"
31372 summary: delete an existing relationship
31373 description: delete an existing relationship
31374 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
31383 description: Response codes found in [response codes](https://wiki.onap.org/).
31387 description: Unique id of VNF. This is unique across the graph.
31390 example: __VNF-ID__
31391 - name: interface-name
31393 description: Name given to the interface
31396 example: __INTERFACE-NAME__
31397 - name: vlan-interface
31399 description: String that identifies the interface
31402 example: __VLAN-INTERFACE__
31403 /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:
31407 summary: see node definition for valid relationships
31408 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
31417 description: Response codes found in [response codes](https://wiki.onap.org/).
31421 description: Unique id of VNF. This is unique across the graph.
31424 example: __VNF-ID__
31425 - name: interface-name
31427 description: Name given to the interface
31430 example: __INTERFACE-NAME__
31431 - name: vlan-interface
31433 description: String that identifies the interface
31436 example: __VLAN-INTERFACE__
31437 - name: l3-interface-ipv4-address
31439 description: IP address
31442 example: __L3-INTERFACE-IPV4-ADDRESS__
31445 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
31448 $ref: "#/definitions/relationship"
31452 summary: delete an existing relationship
31453 description: delete an existing relationship
31454 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
31463 description: Response codes found in [response codes](https://wiki.onap.org/).
31467 description: Unique id of VNF. This is unique across the graph.
31470 example: __VNF-ID__
31471 - name: interface-name
31473 description: Name given to the interface
31476 example: __INTERFACE-NAME__
31477 - name: vlan-interface
31479 description: String that identifies the interface
31482 example: __VLAN-INTERFACE__
31483 - name: l3-interface-ipv4-address
31485 description: IP address
31488 example: __L3-INTERFACE-IPV4-ADDRESS__
31489 /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}:
31493 summary: returns l3-interface-ipv4-address-list
31494 description: returns l3-interface-ipv4-address-list
31495 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31501 description: successful operation
31503 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
31505 description: Response codes found in [response codes](https://wiki.onap.org/).
31509 description: Unique id of VNF. This is unique across the graph.
31512 example: __VNF-ID__
31513 - name: interface-name
31515 description: Name given to the interface
31518 example: __INTERFACE-NAME__
31519 - name: vlan-interface
31521 description: String that identifies the interface
31524 example: __VLAN-INTERFACE__
31525 - name: l3-interface-ipv4-address
31527 description: IP address
31530 example: __L3-INTERFACE-IPV4-ADDRESS__
31534 summary: create or update an existing l3-interface-ipv4-address-list
31536 Create or update an existing l3-interface-ipv4-address-list.
31538 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31539 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31548 description: Response codes found in [response codes](https://wiki.onap.org/).
31552 description: Unique id of VNF. This is unique across the graph.
31555 example: __VNF-ID__
31556 - name: interface-name
31558 description: Name given to the interface
31561 example: __INTERFACE-NAME__
31562 - name: vlan-interface
31564 description: String that identifies the interface
31567 example: __VLAN-INTERFACE__
31568 - name: l3-interface-ipv4-address
31570 description: IP address
31573 example: __L3-INTERFACE-IPV4-ADDRESS__
31576 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
31579 $ref: "#/definitions/l3-interface-ipv4-address-list"
31583 summary: update an existing l3-interface-ipv4-address-list
31585 Update an existing l3-interface-ipv4-address-list
31587 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31588 The PUT operation will entirely replace an existing object.
31589 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31591 Other differences between PUT and PATCH are:
31593 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31594 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31595 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31596 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31605 description: Response codes found in [response codes](https://wiki.onap.org/).
31609 description: Unique id of VNF. This is unique across the graph.
31612 example: __VNF-ID__
31613 - name: interface-name
31615 description: Name given to the interface
31618 example: __INTERFACE-NAME__
31619 - name: vlan-interface
31621 description: String that identifies the interface
31624 example: __VLAN-INTERFACE__
31625 - name: l3-interface-ipv4-address
31627 description: IP address
31630 example: __L3-INTERFACE-IPV4-ADDRESS__
31633 description: l3-interface-ipv4-address-list object that needs to be updated.
31636 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
31640 summary: delete an existing l3-interface-ipv4-address-list
31641 description: delete an existing l3-interface-ipv4-address-list
31642 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31651 description: Response codes found in [response codes](https://wiki.onap.org/).
31655 description: Unique id of VNF. This is unique across the graph.
31658 example: __VNF-ID__
31659 - name: interface-name
31661 description: Name given to the interface
31664 example: __INTERFACE-NAME__
31665 - name: vlan-interface
31667 description: String that identifies the interface
31670 example: __VLAN-INTERFACE__
31671 - name: l3-interface-ipv4-address
31673 description: IP address
31676 example: __L3-INTERFACE-IPV4-ADDRESS__
31677 - name: resource-version
31679 description: resource-version for concurrency
31682 /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:
31686 summary: see node definition for valid relationships
31687 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
31696 description: Response codes found in [response codes](https://wiki.onap.org/).
31700 description: Unique id of VNF. This is unique across the graph.
31703 example: __VNF-ID__
31704 - name: interface-name
31706 description: Name given to the interface
31709 example: __INTERFACE-NAME__
31710 - name: vlan-interface
31712 description: String that identifies the interface
31715 example: __VLAN-INTERFACE__
31716 - name: l3-interface-ipv6-address
31718 description: IP address
31721 example: __L3-INTERFACE-IPV6-ADDRESS__
31724 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
31727 $ref: "#/definitions/relationship"
31731 summary: delete an existing relationship
31732 description: delete an existing relationship
31733 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
31742 description: Response codes found in [response codes](https://wiki.onap.org/).
31746 description: Unique id of VNF. This is unique across the graph.
31749 example: __VNF-ID__
31750 - name: interface-name
31752 description: Name given to the interface
31755 example: __INTERFACE-NAME__
31756 - name: vlan-interface
31758 description: String that identifies the interface
31761 example: __VLAN-INTERFACE__
31762 - name: l3-interface-ipv6-address
31764 description: IP address
31767 example: __L3-INTERFACE-IPV6-ADDRESS__
31768 /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}:
31772 summary: returns l3-interface-ipv6-address-list
31773 description: returns l3-interface-ipv6-address-list
31774 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31780 description: successful operation
31782 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
31784 description: Response codes found in [response codes](https://wiki.onap.org/).
31788 description: Unique id of VNF. This is unique across the graph.
31791 example: __VNF-ID__
31792 - name: interface-name
31794 description: Name given to the interface
31797 example: __INTERFACE-NAME__
31798 - name: vlan-interface
31800 description: String that identifies the interface
31803 example: __VLAN-INTERFACE__
31804 - name: l3-interface-ipv6-address
31806 description: IP address
31809 example: __L3-INTERFACE-IPV6-ADDRESS__
31813 summary: create or update an existing l3-interface-ipv6-address-list
31815 Create or update an existing l3-interface-ipv6-address-list.
31817 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31818 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31827 description: Response codes found in [response codes](https://wiki.onap.org/).
31831 description: Unique id of VNF. This is unique across the graph.
31834 example: __VNF-ID__
31835 - name: interface-name
31837 description: Name given to the interface
31840 example: __INTERFACE-NAME__
31841 - name: vlan-interface
31843 description: String that identifies the interface
31846 example: __VLAN-INTERFACE__
31847 - name: l3-interface-ipv6-address
31849 description: IP address
31852 example: __L3-INTERFACE-IPV6-ADDRESS__
31855 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
31858 $ref: "#/definitions/l3-interface-ipv6-address-list"
31862 summary: update an existing l3-interface-ipv6-address-list
31864 Update an existing l3-interface-ipv6-address-list
31866 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31867 The PUT operation will entirely replace an existing object.
31868 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31870 Other differences between PUT and PATCH are:
31872 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31873 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31874 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31875 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31884 description: Response codes found in [response codes](https://wiki.onap.org/).
31888 description: Unique id of VNF. This is unique across the graph.
31891 example: __VNF-ID__
31892 - name: interface-name
31894 description: Name given to the interface
31897 example: __INTERFACE-NAME__
31898 - name: vlan-interface
31900 description: String that identifies the interface
31903 example: __VLAN-INTERFACE__
31904 - name: l3-interface-ipv6-address
31906 description: IP address
31909 example: __L3-INTERFACE-IPV6-ADDRESS__
31912 description: l3-interface-ipv6-address-list object that needs to be updated.
31915 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
31919 summary: delete an existing l3-interface-ipv6-address-list
31920 description: delete an existing l3-interface-ipv6-address-list
31921 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31930 description: Response codes found in [response codes](https://wiki.onap.org/).
31934 description: Unique id of VNF. This is unique across the graph.
31937 example: __VNF-ID__
31938 - name: interface-name
31940 description: Name given to the interface
31943 example: __INTERFACE-NAME__
31944 - name: vlan-interface
31946 description: String that identifies the interface
31949 example: __VLAN-INTERFACE__
31950 - name: l3-interface-ipv6-address
31952 description: IP address
31955 example: __L3-INTERFACE-IPV6-ADDRESS__
31956 - name: resource-version
31958 description: resource-version for concurrency
31961 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
31965 summary: returns vlan
31966 description: returns vlan
31967 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
31973 description: successful operation
31975 $ref: "#/getDefinitions/vlan"
31977 description: Response codes found in [response codes](https://wiki.onap.org/).
31981 description: Unique id of VNF. This is unique across the graph.
31984 example: __VNF-ID__
31985 - name: interface-name
31987 description: Name given to the interface
31990 example: __INTERFACE-NAME__
31991 - name: vlan-interface
31993 description: String that identifies the interface
31996 example: __VLAN-INTERFACE__
32000 summary: create or update an existing vlan
32002 Create or update an existing vlan.
32004 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32005 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
32014 description: Response codes found in [response codes](https://wiki.onap.org/).
32018 description: Unique id of VNF. This is unique across the graph.
32021 example: __VNF-ID__
32022 - name: interface-name
32024 description: Name given to the interface
32027 example: __INTERFACE-NAME__
32028 - name: vlan-interface
32030 description: String that identifies the interface
32033 example: __VLAN-INTERFACE__
32036 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
32039 $ref: "#/definitions/vlan"
32043 summary: update an existing vlan
32045 Update an existing vlan
32047 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32048 The PUT operation will entirely replace an existing object.
32049 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32051 Other differences between PUT and PATCH are:
32053 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32054 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32055 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32056 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
32065 description: Response codes found in [response codes](https://wiki.onap.org/).
32069 description: Unique id of VNF. This is unique across the graph.
32072 example: __VNF-ID__
32073 - name: interface-name
32075 description: Name given to the interface
32078 example: __INTERFACE-NAME__
32079 - name: vlan-interface
32081 description: String that identifies the interface
32084 example: __VLAN-INTERFACE__
32087 description: vlan object that needs to be updated.
32090 $ref: "#/patchDefinitions/vlan"
32094 summary: delete an existing vlan
32095 description: delete an existing vlan
32096 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
32105 description: Response codes found in [response codes](https://wiki.onap.org/).
32109 description: Unique id of VNF. This is unique across the graph.
32112 example: __VNF-ID__
32113 - name: interface-name
32115 description: Name given to the interface
32118 example: __INTERFACE-NAME__
32119 - name: vlan-interface
32121 description: String that identifies the interface
32124 example: __VLAN-INTERFACE__
32125 - name: resource-version
32127 description: resource-version for concurrency
32130 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans:
32134 summary: returns vlans
32135 description: returns vlans
32136 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans
32142 description: successful operation
32144 $ref: "#/getDefinitions/vlans"
32146 description: Response codes found in [response codes](https://wiki.onap.org/).
32150 description: Unique id of VNF. This is unique across the graph.
32153 example: __VNF-ID__
32154 - name: interface-name
32156 description: Name given to the interface
32159 example: __INTERFACE-NAME__
32160 - name: vlan-interface
32165 - name: vlan-id-inner
32176 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
32180 summary: see node definition for valid relationships
32181 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
32190 description: Response codes found in [response codes](https://wiki.onap.org/).
32194 description: Unique id of VNF. This is unique across the graph.
32197 example: __VNF-ID__
32198 - name: interface-name
32200 description: Name given to the interface
32203 example: __INTERFACE-NAME__
32206 description: PCI ID used to identify the sriov-vf
32209 example: __PCI-ID__
32212 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
32215 $ref: "#/definitions/relationship"
32219 summary: delete an existing relationship
32220 description: delete an existing relationship
32221 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
32230 description: Response codes found in [response codes](https://wiki.onap.org/).
32234 description: Unique id of VNF. This is unique across the graph.
32237 example: __VNF-ID__
32238 - name: interface-name
32240 description: Name given to the interface
32243 example: __INTERFACE-NAME__
32246 description: PCI ID used to identify the sriov-vf
32249 example: __PCI-ID__
32250 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
32254 summary: returns sriov-vf
32255 description: returns sriov-vf
32256 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
32262 description: successful operation
32264 $ref: "#/getDefinitions/sriov-vf"
32266 description: Response codes found in [response codes](https://wiki.onap.org/).
32270 description: Unique id of VNF. This is unique across the graph.
32273 example: __VNF-ID__
32274 - name: interface-name
32276 description: Name given to the interface
32279 example: __INTERFACE-NAME__
32282 description: PCI ID used to identify the sriov-vf
32285 example: __PCI-ID__
32289 summary: create or update an existing sriov-vf
32291 Create or update an existing sriov-vf.
32293 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32294 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
32303 description: Response codes found in [response codes](https://wiki.onap.org/).
32307 description: Unique id of VNF. This is unique across the graph.
32310 example: __VNF-ID__
32311 - name: interface-name
32313 description: Name given to the interface
32316 example: __INTERFACE-NAME__
32319 description: PCI ID used to identify the sriov-vf
32322 example: __PCI-ID__
32325 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
32328 $ref: "#/definitions/sriov-vf"
32332 summary: update an existing sriov-vf
32334 Update an existing sriov-vf
32336 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32337 The PUT operation will entirely replace an existing object.
32338 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32340 Other differences between PUT and PATCH are:
32342 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32343 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32344 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32345 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
32354 description: Response codes found in [response codes](https://wiki.onap.org/).
32358 description: Unique id of VNF. This is unique across the graph.
32361 example: __VNF-ID__
32362 - name: interface-name
32364 description: Name given to the interface
32367 example: __INTERFACE-NAME__
32370 description: PCI ID used to identify the sriov-vf
32373 example: __PCI-ID__
32376 description: sriov-vf object that needs to be updated.
32379 $ref: "#/patchDefinitions/sriov-vf"
32383 summary: delete an existing sriov-vf
32384 description: delete an existing sriov-vf
32385 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
32394 description: Response codes found in [response codes](https://wiki.onap.org/).
32398 description: Unique id of VNF. This is unique across the graph.
32401 example: __VNF-ID__
32402 - name: interface-name
32404 description: Name given to the interface
32407 example: __INTERFACE-NAME__
32410 description: PCI ID used to identify the sriov-vf
32413 example: __PCI-ID__
32414 - name: resource-version
32416 description: resource-version for concurrency
32419 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
32423 summary: returns sriov-vfs
32424 description: returns sriov-vfs
32425 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs
32431 description: successful operation
32433 $ref: "#/getDefinitions/sriov-vfs"
32435 description: Response codes found in [response codes](https://wiki.onap.org/).
32439 description: Unique id of VNF. This is unique across the graph.
32442 example: __VNF-ID__
32443 - name: interface-name
32445 description: Name given to the interface
32448 example: __INTERFACE-NAME__
32454 - name: vf-vlan-filter
32459 - name: vf-mac-filter
32464 - name: vf-vlan-strip
32469 - name: neutron-network-id
32474 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
32478 summary: see node definition for valid relationships
32479 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
32488 description: Response codes found in [response codes](https://wiki.onap.org/).
32492 description: Unique id of VNF. This is unique across the graph.
32495 example: __VNF-ID__
32496 - name: interface-name
32498 description: Name given to the interface
32501 example: __INTERFACE-NAME__
32504 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
32507 $ref: "#/definitions/relationship"
32511 summary: delete an existing relationship
32512 description: delete an existing relationship
32513 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
32522 description: Response codes found in [response codes](https://wiki.onap.org/).
32526 description: Unique id of VNF. This is unique across the graph.
32529 example: __VNF-ID__
32530 - name: interface-name
32532 description: Name given to the interface
32535 example: __INTERFACE-NAME__
32536 /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:
32540 summary: see node definition for valid relationships
32541 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
32550 description: Response codes found in [response codes](https://wiki.onap.org/).
32554 description: Unique id of VNF. This is unique across the graph.
32557 example: __VNF-ID__
32558 - name: interface-name
32560 description: Name given to the interface
32563 example: __INTERFACE-NAME__
32564 - name: l3-interface-ipv4-address
32566 description: IP address
32569 example: __L3-INTERFACE-IPV4-ADDRESS__
32572 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
32575 $ref: "#/definitions/relationship"
32579 summary: delete an existing relationship
32580 description: delete an existing relationship
32581 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
32590 description: Response codes found in [response codes](https://wiki.onap.org/).
32594 description: Unique id of VNF. This is unique across the graph.
32597 example: __VNF-ID__
32598 - name: interface-name
32600 description: Name given to the interface
32603 example: __INTERFACE-NAME__
32604 - name: l3-interface-ipv4-address
32606 description: IP address
32609 example: __L3-INTERFACE-IPV4-ADDRESS__
32610 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
32614 summary: returns l3-interface-ipv4-address-list
32615 description: returns l3-interface-ipv4-address-list
32616 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32622 description: successful operation
32624 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
32626 description: Response codes found in [response codes](https://wiki.onap.org/).
32630 description: Unique id of VNF. This is unique across the graph.
32633 example: __VNF-ID__
32634 - name: interface-name
32636 description: Name given to the interface
32639 example: __INTERFACE-NAME__
32640 - name: l3-interface-ipv4-address
32642 description: IP address
32645 example: __L3-INTERFACE-IPV4-ADDRESS__
32649 summary: create or update an existing l3-interface-ipv4-address-list
32651 Create or update an existing l3-interface-ipv4-address-list.
32653 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32654 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32663 description: Response codes found in [response codes](https://wiki.onap.org/).
32667 description: Unique id of VNF. This is unique across the graph.
32670 example: __VNF-ID__
32671 - name: interface-name
32673 description: Name given to the interface
32676 example: __INTERFACE-NAME__
32677 - name: l3-interface-ipv4-address
32679 description: IP address
32682 example: __L3-INTERFACE-IPV4-ADDRESS__
32685 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
32688 $ref: "#/definitions/l3-interface-ipv4-address-list"
32692 summary: update an existing l3-interface-ipv4-address-list
32694 Update an existing l3-interface-ipv4-address-list
32696 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32697 The PUT operation will entirely replace an existing object.
32698 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32700 Other differences between PUT and PATCH are:
32702 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32703 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32704 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32705 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32714 description: Response codes found in [response codes](https://wiki.onap.org/).
32718 description: Unique id of VNF. This is unique across the graph.
32721 example: __VNF-ID__
32722 - name: interface-name
32724 description: Name given to the interface
32727 example: __INTERFACE-NAME__
32728 - name: l3-interface-ipv4-address
32730 description: IP address
32733 example: __L3-INTERFACE-IPV4-ADDRESS__
32736 description: l3-interface-ipv4-address-list object that needs to be updated.
32739 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
32743 summary: delete an existing l3-interface-ipv4-address-list
32744 description: delete an existing l3-interface-ipv4-address-list
32745 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32754 description: Response codes found in [response codes](https://wiki.onap.org/).
32758 description: Unique id of VNF. This is unique across the graph.
32761 example: __VNF-ID__
32762 - name: interface-name
32764 description: Name given to the interface
32767 example: __INTERFACE-NAME__
32768 - name: l3-interface-ipv4-address
32770 description: IP address
32773 example: __L3-INTERFACE-IPV4-ADDRESS__
32774 - name: resource-version
32776 description: resource-version for concurrency
32779 /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:
32783 summary: see node definition for valid relationships
32784 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
32793 description: Response codes found in [response codes](https://wiki.onap.org/).
32797 description: Unique id of VNF. This is unique across the graph.
32800 example: __VNF-ID__
32801 - name: interface-name
32803 description: Name given to the interface
32806 example: __INTERFACE-NAME__
32807 - name: l3-interface-ipv6-address
32809 description: IP address
32812 example: __L3-INTERFACE-IPV6-ADDRESS__
32815 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
32818 $ref: "#/definitions/relationship"
32822 summary: delete an existing relationship
32823 description: delete an existing relationship
32824 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
32833 description: Response codes found in [response codes](https://wiki.onap.org/).
32837 description: Unique id of VNF. This is unique across the graph.
32840 example: __VNF-ID__
32841 - name: interface-name
32843 description: Name given to the interface
32846 example: __INTERFACE-NAME__
32847 - name: l3-interface-ipv6-address
32849 description: IP address
32852 example: __L3-INTERFACE-IPV6-ADDRESS__
32853 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
32857 summary: returns l3-interface-ipv6-address-list
32858 description: returns l3-interface-ipv6-address-list
32859 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
32865 description: successful operation
32867 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
32869 description: Response codes found in [response codes](https://wiki.onap.org/).
32873 description: Unique id of VNF. This is unique across the graph.
32876 example: __VNF-ID__
32877 - name: interface-name
32879 description: Name given to the interface
32882 example: __INTERFACE-NAME__
32883 - name: l3-interface-ipv6-address
32885 description: IP address
32888 example: __L3-INTERFACE-IPV6-ADDRESS__
32892 summary: create or update an existing l3-interface-ipv6-address-list
32894 Create or update an existing l3-interface-ipv6-address-list.
32896 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32897 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
32906 description: Response codes found in [response codes](https://wiki.onap.org/).
32910 description: Unique id of VNF. This is unique across the graph.
32913 example: __VNF-ID__
32914 - name: interface-name
32916 description: Name given to the interface
32919 example: __INTERFACE-NAME__
32920 - name: l3-interface-ipv6-address
32922 description: IP address
32925 example: __L3-INTERFACE-IPV6-ADDRESS__
32928 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
32931 $ref: "#/definitions/l3-interface-ipv6-address-list"
32935 summary: update an existing l3-interface-ipv6-address-list
32937 Update an existing l3-interface-ipv6-address-list
32939 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32940 The PUT operation will entirely replace an existing object.
32941 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32943 Other differences between PUT and PATCH are:
32945 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32946 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32947 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32948 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
32957 description: Response codes found in [response codes](https://wiki.onap.org/).
32961 description: Unique id of VNF. This is unique across the graph.
32964 example: __VNF-ID__
32965 - name: interface-name
32967 description: Name given to the interface
32970 example: __INTERFACE-NAME__
32971 - name: l3-interface-ipv6-address
32973 description: IP address
32976 example: __L3-INTERFACE-IPV6-ADDRESS__
32979 description: l3-interface-ipv6-address-list object that needs to be updated.
32982 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
32986 summary: delete an existing l3-interface-ipv6-address-list
32987 description: delete an existing l3-interface-ipv6-address-list
32988 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
32997 description: Response codes found in [response codes](https://wiki.onap.org/).
33001 description: Unique id of VNF. This is unique across the graph.
33004 example: __VNF-ID__
33005 - name: interface-name
33007 description: Name given to the interface
33010 example: __INTERFACE-NAME__
33011 - name: l3-interface-ipv6-address
33013 description: IP address
33016 example: __L3-INTERFACE-IPV6-ADDRESS__
33017 - name: resource-version
33019 description: resource-version for concurrency
33022 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}:
33026 summary: returns l-interface
33027 description: returns l-interface
33028 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface
33034 description: successful operation
33036 $ref: "#/getDefinitions/l-interface"
33038 description: Response codes found in [response codes](https://wiki.onap.org/).
33042 description: Unique id of VNF. This is unique across the graph.
33045 example: __VNF-ID__
33046 - name: interface-name
33048 description: Name given to the interface
33051 example: __INTERFACE-NAME__
33055 summary: create or update an existing l-interface
33057 Create or update an existing l-interface.
33059 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33060 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
33069 description: Response codes found in [response codes](https://wiki.onap.org/).
33073 description: Unique id of VNF. This is unique across the graph.
33076 example: __VNF-ID__
33077 - name: interface-name
33079 description: Name given to the interface
33082 example: __INTERFACE-NAME__
33085 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
33088 $ref: "#/definitions/l-interface"
33092 summary: update an existing l-interface
33094 Update an existing l-interface
33096 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33097 The PUT operation will entirely replace an existing object.
33098 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33100 Other differences between PUT and PATCH are:
33102 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33103 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33104 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33105 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
33114 description: Response codes found in [response codes](https://wiki.onap.org/).
33118 description: Unique id of VNF. This is unique across the graph.
33121 example: __VNF-ID__
33122 - name: interface-name
33124 description: Name given to the interface
33127 example: __INTERFACE-NAME__
33130 description: l-interface object that needs to be updated.
33133 $ref: "#/patchDefinitions/l-interface"
33137 summary: delete an existing l-interface
33138 description: delete an existing l-interface
33139 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface
33148 description: Response codes found in [response codes](https://wiki.onap.org/).
33152 description: Unique id of VNF. This is unique across the graph.
33155 example: __VNF-ID__
33156 - name: interface-name
33158 description: Name given to the interface
33161 example: __INTERFACE-NAME__
33162 - name: resource-version
33164 description: resource-version for concurrency
33167 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces:
33171 summary: returns l-interfaces
33172 description: returns l-interfaces
33173 operationId: getNetworkGenericVnfsGenericVnfLInterfaces
33179 description: successful operation
33181 $ref: "#/getDefinitions/l-interfaces"
33183 description: Response codes found in [response codes](https://wiki.onap.org/).
33187 description: Unique id of VNF. This is unique across the graph.
33190 example: __VNF-ID__
33191 - name: interface-name
33196 - name: interface-id
33206 - name: network-name
33211 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
33215 summary: see node definition for valid relationships
33216 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
33225 description: Response codes found in [response codes](https://wiki.onap.org/).
33229 description: Unique id of VNF. This is unique across the graph.
33232 example: __VNF-ID__
33233 - name: interface-name
33235 description: Name that identifies the link aggregate interface
33238 example: __INTERFACE-NAME__
33241 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
33244 $ref: "#/definitions/relationship"
33248 summary: delete an existing relationship
33249 description: delete an existing relationship
33250 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
33259 description: Response codes found in [response codes](https://wiki.onap.org/).
33263 description: Unique id of VNF. This is unique across the graph.
33266 example: __VNF-ID__
33267 - name: interface-name
33269 description: Name that identifies the link aggregate interface
33272 example: __INTERFACE-NAME__
33273 /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:
33277 summary: see node definition for valid relationships
33278 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
33287 description: Response codes found in [response codes](https://wiki.onap.org/).
33291 description: Unique id of VNF. This is unique across the graph.
33294 example: __VNF-ID__
33295 - name: interface-name
33297 description: Name that identifies the link aggregate interface
33300 example: __INTERFACE-NAME__
33301 - name: interface-name
33303 description: Name given to the interface
33306 example: __INTERFACE-NAME__
33307 - name: vlan-interface
33309 description: String that identifies the interface
33312 example: __VLAN-INTERFACE__
33315 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
33318 $ref: "#/definitions/relationship"
33322 summary: delete an existing relationship
33323 description: delete an existing relationship
33324 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
33333 description: Response codes found in [response codes](https://wiki.onap.org/).
33337 description: Unique id of VNF. This is unique across the graph.
33340 example: __VNF-ID__
33341 - name: interface-name
33343 description: Name that identifies the link aggregate interface
33346 example: __INTERFACE-NAME__
33347 - name: interface-name
33349 description: Name given to the interface
33352 example: __INTERFACE-NAME__
33353 - name: vlan-interface
33355 description: String that identifies the interface
33358 example: __VLAN-INTERFACE__
33359 /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:
33363 summary: see node definition for valid relationships
33364 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
33373 description: Response codes found in [response codes](https://wiki.onap.org/).
33377 description: Unique id of VNF. This is unique across the graph.
33380 example: __VNF-ID__
33381 - name: interface-name
33383 description: Name that identifies the link aggregate interface
33386 example: __INTERFACE-NAME__
33387 - name: interface-name
33389 description: Name given to the interface
33392 example: __INTERFACE-NAME__
33393 - name: vlan-interface
33395 description: String that identifies the interface
33398 example: __VLAN-INTERFACE__
33399 - name: l3-interface-ipv4-address
33401 description: IP address
33404 example: __L3-INTERFACE-IPV4-ADDRESS__
33407 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
33410 $ref: "#/definitions/relationship"
33414 summary: delete an existing relationship
33415 description: delete an existing relationship
33416 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
33425 description: Response codes found in [response codes](https://wiki.onap.org/).
33429 description: Unique id of VNF. This is unique across the graph.
33432 example: __VNF-ID__
33433 - name: interface-name
33435 description: Name that identifies the link aggregate interface
33438 example: __INTERFACE-NAME__
33439 - name: interface-name
33441 description: Name given to the interface
33444 example: __INTERFACE-NAME__
33445 - name: vlan-interface
33447 description: String that identifies the interface
33450 example: __VLAN-INTERFACE__
33451 - name: l3-interface-ipv4-address
33453 description: IP address
33456 example: __L3-INTERFACE-IPV4-ADDRESS__
33457 /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}:
33461 summary: returns l3-interface-ipv4-address-list
33462 description: returns l3-interface-ipv4-address-list
33463 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33469 description: successful operation
33471 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
33473 description: Response codes found in [response codes](https://wiki.onap.org/).
33477 description: Unique id of VNF. This is unique across the graph.
33480 example: __VNF-ID__
33481 - name: interface-name
33483 description: Name that identifies the link aggregate interface
33486 example: __INTERFACE-NAME__
33487 - name: interface-name
33489 description: Name given to the interface
33492 example: __INTERFACE-NAME__
33493 - name: vlan-interface
33495 description: String that identifies the interface
33498 example: __VLAN-INTERFACE__
33499 - name: l3-interface-ipv4-address
33501 description: IP address
33504 example: __L3-INTERFACE-IPV4-ADDRESS__
33508 summary: create or update an existing l3-interface-ipv4-address-list
33510 Create or update an existing l3-interface-ipv4-address-list.
33512 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33513 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33522 description: Response codes found in [response codes](https://wiki.onap.org/).
33526 description: Unique id of VNF. This is unique across the graph.
33529 example: __VNF-ID__
33530 - name: interface-name
33532 description: Name that identifies the link aggregate interface
33535 example: __INTERFACE-NAME__
33536 - name: interface-name
33538 description: Name given to the interface
33541 example: __INTERFACE-NAME__
33542 - name: vlan-interface
33544 description: String that identifies the interface
33547 example: __VLAN-INTERFACE__
33548 - name: l3-interface-ipv4-address
33550 description: IP address
33553 example: __L3-INTERFACE-IPV4-ADDRESS__
33556 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
33559 $ref: "#/definitions/l3-interface-ipv4-address-list"
33563 summary: update an existing l3-interface-ipv4-address-list
33565 Update an existing l3-interface-ipv4-address-list
33567 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33568 The PUT operation will entirely replace an existing object.
33569 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33571 Other differences between PUT and PATCH are:
33573 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33574 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33575 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33576 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33585 description: Response codes found in [response codes](https://wiki.onap.org/).
33589 description: Unique id of VNF. This is unique across the graph.
33592 example: __VNF-ID__
33593 - name: interface-name
33595 description: Name that identifies the link aggregate interface
33598 example: __INTERFACE-NAME__
33599 - name: interface-name
33601 description: Name given to the interface
33604 example: __INTERFACE-NAME__
33605 - name: vlan-interface
33607 description: String that identifies the interface
33610 example: __VLAN-INTERFACE__
33611 - name: l3-interface-ipv4-address
33613 description: IP address
33616 example: __L3-INTERFACE-IPV4-ADDRESS__
33619 description: l3-interface-ipv4-address-list object that needs to be updated.
33622 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
33626 summary: delete an existing l3-interface-ipv4-address-list
33627 description: delete an existing l3-interface-ipv4-address-list
33628 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33637 description: Response codes found in [response codes](https://wiki.onap.org/).
33641 description: Unique id of VNF. This is unique across the graph.
33644 example: __VNF-ID__
33645 - name: interface-name
33647 description: Name that identifies the link aggregate interface
33650 example: __INTERFACE-NAME__
33651 - name: interface-name
33653 description: Name given to the interface
33656 example: __INTERFACE-NAME__
33657 - name: vlan-interface
33659 description: String that identifies the interface
33662 example: __VLAN-INTERFACE__
33663 - name: l3-interface-ipv4-address
33665 description: IP address
33668 example: __L3-INTERFACE-IPV4-ADDRESS__
33669 - name: resource-version
33671 description: resource-version for concurrency
33674 /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:
33678 summary: see node definition for valid relationships
33679 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
33688 description: Response codes found in [response codes](https://wiki.onap.org/).
33692 description: Unique id of VNF. This is unique across the graph.
33695 example: __VNF-ID__
33696 - name: interface-name
33698 description: Name that identifies the link aggregate interface
33701 example: __INTERFACE-NAME__
33702 - name: interface-name
33704 description: Name given to the interface
33707 example: __INTERFACE-NAME__
33708 - name: vlan-interface
33710 description: String that identifies the interface
33713 example: __VLAN-INTERFACE__
33714 - name: l3-interface-ipv6-address
33716 description: IP address
33719 example: __L3-INTERFACE-IPV6-ADDRESS__
33722 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
33725 $ref: "#/definitions/relationship"
33729 summary: delete an existing relationship
33730 description: delete an existing relationship
33731 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
33740 description: Response codes found in [response codes](https://wiki.onap.org/).
33744 description: Unique id of VNF. This is unique across the graph.
33747 example: __VNF-ID__
33748 - name: interface-name
33750 description: Name that identifies the link aggregate interface
33753 example: __INTERFACE-NAME__
33754 - name: interface-name
33756 description: Name given to the interface
33759 example: __INTERFACE-NAME__
33760 - name: vlan-interface
33762 description: String that identifies the interface
33765 example: __VLAN-INTERFACE__
33766 - name: l3-interface-ipv6-address
33768 description: IP address
33771 example: __L3-INTERFACE-IPV6-ADDRESS__
33772 /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}:
33776 summary: returns l3-interface-ipv6-address-list
33777 description: returns l3-interface-ipv6-address-list
33778 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33784 description: successful operation
33786 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
33788 description: Response codes found in [response codes](https://wiki.onap.org/).
33792 description: Unique id of VNF. This is unique across the graph.
33795 example: __VNF-ID__
33796 - name: interface-name
33798 description: Name that identifies the link aggregate interface
33801 example: __INTERFACE-NAME__
33802 - name: interface-name
33804 description: Name given to the interface
33807 example: __INTERFACE-NAME__
33808 - name: vlan-interface
33810 description: String that identifies the interface
33813 example: __VLAN-INTERFACE__
33814 - name: l3-interface-ipv6-address
33816 description: IP address
33819 example: __L3-INTERFACE-IPV6-ADDRESS__
33823 summary: create or update an existing l3-interface-ipv6-address-list
33825 Create or update an existing l3-interface-ipv6-address-list.
33827 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33828 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33837 description: Response codes found in [response codes](https://wiki.onap.org/).
33841 description: Unique id of VNF. This is unique across the graph.
33844 example: __VNF-ID__
33845 - name: interface-name
33847 description: Name that identifies the link aggregate interface
33850 example: __INTERFACE-NAME__
33851 - name: interface-name
33853 description: Name given to the interface
33856 example: __INTERFACE-NAME__
33857 - name: vlan-interface
33859 description: String that identifies the interface
33862 example: __VLAN-INTERFACE__
33863 - name: l3-interface-ipv6-address
33865 description: IP address
33868 example: __L3-INTERFACE-IPV6-ADDRESS__
33871 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
33874 $ref: "#/definitions/l3-interface-ipv6-address-list"
33878 summary: update an existing l3-interface-ipv6-address-list
33880 Update an existing l3-interface-ipv6-address-list
33882 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33883 The PUT operation will entirely replace an existing object.
33884 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33886 Other differences between PUT and PATCH are:
33888 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33889 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33890 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33891 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33900 description: Response codes found in [response codes](https://wiki.onap.org/).
33904 description: Unique id of VNF. This is unique across the graph.
33907 example: __VNF-ID__
33908 - name: interface-name
33910 description: Name that identifies the link aggregate interface
33913 example: __INTERFACE-NAME__
33914 - name: interface-name
33916 description: Name given to the interface
33919 example: __INTERFACE-NAME__
33920 - name: vlan-interface
33922 description: String that identifies the interface
33925 example: __VLAN-INTERFACE__
33926 - name: l3-interface-ipv6-address
33928 description: IP address
33931 example: __L3-INTERFACE-IPV6-ADDRESS__
33934 description: l3-interface-ipv6-address-list object that needs to be updated.
33937 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
33941 summary: delete an existing l3-interface-ipv6-address-list
33942 description: delete an existing l3-interface-ipv6-address-list
33943 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33952 description: Response codes found in [response codes](https://wiki.onap.org/).
33956 description: Unique id of VNF. This is unique across the graph.
33959 example: __VNF-ID__
33960 - name: interface-name
33962 description: Name that identifies the link aggregate interface
33965 example: __INTERFACE-NAME__
33966 - name: interface-name
33968 description: Name given to the interface
33971 example: __INTERFACE-NAME__
33972 - name: vlan-interface
33974 description: String that identifies the interface
33977 example: __VLAN-INTERFACE__
33978 - name: l3-interface-ipv6-address
33980 description: IP address
33983 example: __L3-INTERFACE-IPV6-ADDRESS__
33984 - name: resource-version
33986 description: resource-version for concurrency
33989 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
33993 summary: returns vlan
33994 description: returns vlan
33995 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
34001 description: successful operation
34003 $ref: "#/getDefinitions/vlan"
34005 description: Response codes found in [response codes](https://wiki.onap.org/).
34009 description: Unique id of VNF. This is unique across the graph.
34012 example: __VNF-ID__
34013 - name: interface-name
34015 description: Name that identifies the link aggregate interface
34018 example: __INTERFACE-NAME__
34019 - name: interface-name
34021 description: Name given to the interface
34024 example: __INTERFACE-NAME__
34025 - name: vlan-interface
34027 description: String that identifies the interface
34030 example: __VLAN-INTERFACE__
34034 summary: create or update an existing vlan
34036 Create or update an existing vlan.
34038 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34039 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
34048 description: Response codes found in [response codes](https://wiki.onap.org/).
34052 description: Unique id of VNF. This is unique across the graph.
34055 example: __VNF-ID__
34056 - name: interface-name
34058 description: Name that identifies the link aggregate interface
34061 example: __INTERFACE-NAME__
34062 - name: interface-name
34064 description: Name given to the interface
34067 example: __INTERFACE-NAME__
34068 - name: vlan-interface
34070 description: String that identifies the interface
34073 example: __VLAN-INTERFACE__
34076 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
34079 $ref: "#/definitions/vlan"
34083 summary: update an existing vlan
34085 Update an existing vlan
34087 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34088 The PUT operation will entirely replace an existing object.
34089 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34091 Other differences between PUT and PATCH are:
34093 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34094 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34095 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34096 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
34105 description: Response codes found in [response codes](https://wiki.onap.org/).
34109 description: Unique id of VNF. This is unique across the graph.
34112 example: __VNF-ID__
34113 - name: interface-name
34115 description: Name that identifies the link aggregate interface
34118 example: __INTERFACE-NAME__
34119 - name: interface-name
34121 description: Name given to the interface
34124 example: __INTERFACE-NAME__
34125 - name: vlan-interface
34127 description: String that identifies the interface
34130 example: __VLAN-INTERFACE__
34133 description: vlan object that needs to be updated.
34136 $ref: "#/patchDefinitions/vlan"
34140 summary: delete an existing vlan
34141 description: delete an existing vlan
34142 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
34151 description: Response codes found in [response codes](https://wiki.onap.org/).
34155 description: Unique id of VNF. This is unique across the graph.
34158 example: __VNF-ID__
34159 - name: interface-name
34161 description: Name that identifies the link aggregate interface
34164 example: __INTERFACE-NAME__
34165 - name: interface-name
34167 description: Name given to the interface
34170 example: __INTERFACE-NAME__
34171 - name: vlan-interface
34173 description: String that identifies the interface
34176 example: __VLAN-INTERFACE__
34177 - name: resource-version
34179 description: resource-version for concurrency
34182 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
34186 summary: returns vlans
34187 description: returns vlans
34188 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
34194 description: successful operation
34196 $ref: "#/getDefinitions/vlans"
34198 description: Response codes found in [response codes](https://wiki.onap.org/).
34202 description: Unique id of VNF. This is unique across the graph.
34205 example: __VNF-ID__
34206 - name: interface-name
34208 description: Name that identifies the link aggregate interface
34211 example: __INTERFACE-NAME__
34212 - name: interface-name
34214 description: Name given to the interface
34217 example: __INTERFACE-NAME__
34218 - name: vlan-interface
34223 - name: vlan-id-inner
34234 /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:
34238 summary: see node definition for valid relationships
34239 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
34248 description: Response codes found in [response codes](https://wiki.onap.org/).
34252 description: Unique id of VNF. This is unique across the graph.
34255 example: __VNF-ID__
34256 - name: interface-name
34258 description: Name that identifies the link aggregate interface
34261 example: __INTERFACE-NAME__
34262 - name: interface-name
34264 description: Name given to the interface
34267 example: __INTERFACE-NAME__
34270 description: PCI ID used to identify the sriov-vf
34273 example: __PCI-ID__
34276 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
34279 $ref: "#/definitions/relationship"
34283 summary: delete an existing relationship
34284 description: delete an existing relationship
34285 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
34294 description: Response codes found in [response codes](https://wiki.onap.org/).
34298 description: Unique id of VNF. This is unique across the graph.
34301 example: __VNF-ID__
34302 - name: interface-name
34304 description: Name that identifies the link aggregate interface
34307 example: __INTERFACE-NAME__
34308 - name: interface-name
34310 description: Name given to the interface
34313 example: __INTERFACE-NAME__
34316 description: PCI ID used to identify the sriov-vf
34319 example: __PCI-ID__
34320 /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}:
34324 summary: returns sriov-vf
34325 description: returns sriov-vf
34326 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
34332 description: successful operation
34334 $ref: "#/getDefinitions/sriov-vf"
34336 description: Response codes found in [response codes](https://wiki.onap.org/).
34340 description: Unique id of VNF. This is unique across the graph.
34343 example: __VNF-ID__
34344 - name: interface-name
34346 description: Name that identifies the link aggregate interface
34349 example: __INTERFACE-NAME__
34350 - name: interface-name
34352 description: Name given to the interface
34355 example: __INTERFACE-NAME__
34358 description: PCI ID used to identify the sriov-vf
34361 example: __PCI-ID__
34365 summary: create or update an existing sriov-vf
34367 Create or update an existing sriov-vf.
34369 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34370 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
34379 description: Response codes found in [response codes](https://wiki.onap.org/).
34383 description: Unique id of VNF. This is unique across the graph.
34386 example: __VNF-ID__
34387 - name: interface-name
34389 description: Name that identifies the link aggregate interface
34392 example: __INTERFACE-NAME__
34393 - name: interface-name
34395 description: Name given to the interface
34398 example: __INTERFACE-NAME__
34401 description: PCI ID used to identify the sriov-vf
34404 example: __PCI-ID__
34407 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
34410 $ref: "#/definitions/sriov-vf"
34414 summary: update an existing sriov-vf
34416 Update an existing sriov-vf
34418 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34419 The PUT operation will entirely replace an existing object.
34420 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34422 Other differences between PUT and PATCH are:
34424 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34425 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34426 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34427 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
34436 description: Response codes found in [response codes](https://wiki.onap.org/).
34440 description: Unique id of VNF. This is unique across the graph.
34443 example: __VNF-ID__
34444 - name: interface-name
34446 description: Name that identifies the link aggregate interface
34449 example: __INTERFACE-NAME__
34450 - name: interface-name
34452 description: Name given to the interface
34455 example: __INTERFACE-NAME__
34458 description: PCI ID used to identify the sriov-vf
34461 example: __PCI-ID__
34464 description: sriov-vf object that needs to be updated.
34467 $ref: "#/patchDefinitions/sriov-vf"
34471 summary: delete an existing sriov-vf
34472 description: delete an existing sriov-vf
34473 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
34482 description: Response codes found in [response codes](https://wiki.onap.org/).
34486 description: Unique id of VNF. This is unique across the graph.
34489 example: __VNF-ID__
34490 - name: interface-name
34492 description: Name that identifies the link aggregate interface
34495 example: __INTERFACE-NAME__
34496 - name: interface-name
34498 description: Name given to the interface
34501 example: __INTERFACE-NAME__
34504 description: PCI ID used to identify the sriov-vf
34507 example: __PCI-ID__
34508 - name: resource-version
34510 description: resource-version for concurrency
34513 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
34517 summary: returns sriov-vfs
34518 description: returns sriov-vfs
34519 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
34525 description: successful operation
34527 $ref: "#/getDefinitions/sriov-vfs"
34529 description: Response codes found in [response codes](https://wiki.onap.org/).
34533 description: Unique id of VNF. This is unique across the graph.
34536 example: __VNF-ID__
34537 - name: interface-name
34539 description: Name that identifies the link aggregate interface
34542 example: __INTERFACE-NAME__
34543 - name: interface-name
34545 description: Name given to the interface
34548 example: __INTERFACE-NAME__
34554 - name: vf-vlan-filter
34559 - name: vf-mac-filter
34564 - name: vf-vlan-strip
34569 - name: neutron-network-id
34574 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
34578 summary: see node definition for valid relationships
34579 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
34588 description: Response codes found in [response codes](https://wiki.onap.org/).
34592 description: Unique id of VNF. This is unique across the graph.
34595 example: __VNF-ID__
34596 - name: interface-name
34598 description: Name that identifies the link aggregate interface
34601 example: __INTERFACE-NAME__
34602 - name: interface-name
34604 description: Name given to the interface
34607 example: __INTERFACE-NAME__
34610 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
34613 $ref: "#/definitions/relationship"
34617 summary: delete an existing relationship
34618 description: delete an existing relationship
34619 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
34628 description: Response codes found in [response codes](https://wiki.onap.org/).
34632 description: Unique id of VNF. This is unique across the graph.
34635 example: __VNF-ID__
34636 - name: interface-name
34638 description: Name that identifies the link aggregate interface
34641 example: __INTERFACE-NAME__
34642 - name: interface-name
34644 description: Name given to the interface
34647 example: __INTERFACE-NAME__
34648 /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:
34652 summary: see node definition for valid relationships
34653 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
34662 description: Response codes found in [response codes](https://wiki.onap.org/).
34666 description: Unique id of VNF. This is unique across the graph.
34669 example: __VNF-ID__
34670 - name: interface-name
34672 description: Name that identifies the link aggregate interface
34675 example: __INTERFACE-NAME__
34676 - name: interface-name
34678 description: Name given to the interface
34681 example: __INTERFACE-NAME__
34682 - name: l3-interface-ipv4-address
34684 description: IP address
34687 example: __L3-INTERFACE-IPV4-ADDRESS__
34690 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
34693 $ref: "#/definitions/relationship"
34697 summary: delete an existing relationship
34698 description: delete an existing relationship
34699 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
34708 description: Response codes found in [response codes](https://wiki.onap.org/).
34712 description: Unique id of VNF. This is unique across the graph.
34715 example: __VNF-ID__
34716 - name: interface-name
34718 description: Name that identifies the link aggregate interface
34721 example: __INTERFACE-NAME__
34722 - name: interface-name
34724 description: Name given to the interface
34727 example: __INTERFACE-NAME__
34728 - name: l3-interface-ipv4-address
34730 description: IP address
34733 example: __L3-INTERFACE-IPV4-ADDRESS__
34734 /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}:
34738 summary: returns l3-interface-ipv4-address-list
34739 description: returns l3-interface-ipv4-address-list
34740 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34746 description: successful operation
34748 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
34750 description: Response codes found in [response codes](https://wiki.onap.org/).
34754 description: Unique id of VNF. This is unique across the graph.
34757 example: __VNF-ID__
34758 - name: interface-name
34760 description: Name that identifies the link aggregate interface
34763 example: __INTERFACE-NAME__
34764 - name: interface-name
34766 description: Name given to the interface
34769 example: __INTERFACE-NAME__
34770 - name: l3-interface-ipv4-address
34772 description: IP address
34775 example: __L3-INTERFACE-IPV4-ADDRESS__
34779 summary: create or update an existing l3-interface-ipv4-address-list
34781 Create or update an existing l3-interface-ipv4-address-list.
34783 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34784 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34793 description: Response codes found in [response codes](https://wiki.onap.org/).
34797 description: Unique id of VNF. This is unique across the graph.
34800 example: __VNF-ID__
34801 - name: interface-name
34803 description: Name that identifies the link aggregate interface
34806 example: __INTERFACE-NAME__
34807 - name: interface-name
34809 description: Name given to the interface
34812 example: __INTERFACE-NAME__
34813 - name: l3-interface-ipv4-address
34815 description: IP address
34818 example: __L3-INTERFACE-IPV4-ADDRESS__
34821 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
34824 $ref: "#/definitions/l3-interface-ipv4-address-list"
34828 summary: update an existing l3-interface-ipv4-address-list
34830 Update an existing l3-interface-ipv4-address-list
34832 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34833 The PUT operation will entirely replace an existing object.
34834 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34836 Other differences between PUT and PATCH are:
34838 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34839 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34840 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34841 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34850 description: Response codes found in [response codes](https://wiki.onap.org/).
34854 description: Unique id of VNF. This is unique across the graph.
34857 example: __VNF-ID__
34858 - name: interface-name
34860 description: Name that identifies the link aggregate interface
34863 example: __INTERFACE-NAME__
34864 - name: interface-name
34866 description: Name given to the interface
34869 example: __INTERFACE-NAME__
34870 - name: l3-interface-ipv4-address
34872 description: IP address
34875 example: __L3-INTERFACE-IPV4-ADDRESS__
34878 description: l3-interface-ipv4-address-list object that needs to be updated.
34881 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
34885 summary: delete an existing l3-interface-ipv4-address-list
34886 description: delete an existing l3-interface-ipv4-address-list
34887 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34896 description: Response codes found in [response codes](https://wiki.onap.org/).
34900 description: Unique id of VNF. This is unique across the graph.
34903 example: __VNF-ID__
34904 - name: interface-name
34906 description: Name that identifies the link aggregate interface
34909 example: __INTERFACE-NAME__
34910 - name: interface-name
34912 description: Name given to the interface
34915 example: __INTERFACE-NAME__
34916 - name: l3-interface-ipv4-address
34918 description: IP address
34921 example: __L3-INTERFACE-IPV4-ADDRESS__
34922 - name: resource-version
34924 description: resource-version for concurrency
34927 /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:
34931 summary: see node definition for valid relationships
34932 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
34941 description: Response codes found in [response codes](https://wiki.onap.org/).
34945 description: Unique id of VNF. This is unique across the graph.
34948 example: __VNF-ID__
34949 - name: interface-name
34951 description: Name that identifies the link aggregate interface
34954 example: __INTERFACE-NAME__
34955 - name: interface-name
34957 description: Name given to the interface
34960 example: __INTERFACE-NAME__
34961 - name: l3-interface-ipv6-address
34963 description: IP address
34966 example: __L3-INTERFACE-IPV6-ADDRESS__
34969 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
34972 $ref: "#/definitions/relationship"
34976 summary: delete an existing relationship
34977 description: delete an existing relationship
34978 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
34987 description: Response codes found in [response codes](https://wiki.onap.org/).
34991 description: Unique id of VNF. This is unique across the graph.
34994 example: __VNF-ID__
34995 - name: interface-name
34997 description: Name that identifies the link aggregate interface
35000 example: __INTERFACE-NAME__
35001 - name: interface-name
35003 description: Name given to the interface
35006 example: __INTERFACE-NAME__
35007 - name: l3-interface-ipv6-address
35009 description: IP address
35012 example: __L3-INTERFACE-IPV6-ADDRESS__
35013 /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}:
35017 summary: returns l3-interface-ipv6-address-list
35018 description: returns l3-interface-ipv6-address-list
35019 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
35025 description: successful operation
35027 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
35029 description: Response codes found in [response codes](https://wiki.onap.org/).
35033 description: Unique id of VNF. This is unique across the graph.
35036 example: __VNF-ID__
35037 - name: interface-name
35039 description: Name that identifies the link aggregate interface
35042 example: __INTERFACE-NAME__
35043 - name: interface-name
35045 description: Name given to the interface
35048 example: __INTERFACE-NAME__
35049 - name: l3-interface-ipv6-address
35051 description: IP address
35054 example: __L3-INTERFACE-IPV6-ADDRESS__
35058 summary: create or update an existing l3-interface-ipv6-address-list
35060 Create or update an existing l3-interface-ipv6-address-list.
35062 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35063 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
35072 description: Response codes found in [response codes](https://wiki.onap.org/).
35076 description: Unique id of VNF. This is unique across the graph.
35079 example: __VNF-ID__
35080 - name: interface-name
35082 description: Name that identifies the link aggregate interface
35085 example: __INTERFACE-NAME__
35086 - name: interface-name
35088 description: Name given to the interface
35091 example: __INTERFACE-NAME__
35092 - name: l3-interface-ipv6-address
35094 description: IP address
35097 example: __L3-INTERFACE-IPV6-ADDRESS__
35100 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
35103 $ref: "#/definitions/l3-interface-ipv6-address-list"
35107 summary: update an existing l3-interface-ipv6-address-list
35109 Update an existing l3-interface-ipv6-address-list
35111 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35112 The PUT operation will entirely replace an existing object.
35113 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35115 Other differences between PUT and PATCH are:
35117 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35118 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35119 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35120 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
35129 description: Response codes found in [response codes](https://wiki.onap.org/).
35133 description: Unique id of VNF. This is unique across the graph.
35136 example: __VNF-ID__
35137 - name: interface-name
35139 description: Name that identifies the link aggregate interface
35142 example: __INTERFACE-NAME__
35143 - name: interface-name
35145 description: Name given to the interface
35148 example: __INTERFACE-NAME__
35149 - name: l3-interface-ipv6-address
35151 description: IP address
35154 example: __L3-INTERFACE-IPV6-ADDRESS__
35157 description: l3-interface-ipv6-address-list object that needs to be updated.
35160 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
35164 summary: delete an existing l3-interface-ipv6-address-list
35165 description: delete an existing l3-interface-ipv6-address-list
35166 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
35175 description: Response codes found in [response codes](https://wiki.onap.org/).
35179 description: Unique id of VNF. This is unique across the graph.
35182 example: __VNF-ID__
35183 - name: interface-name
35185 description: Name that identifies the link aggregate interface
35188 example: __INTERFACE-NAME__
35189 - name: interface-name
35191 description: Name given to the interface
35194 example: __INTERFACE-NAME__
35195 - name: l3-interface-ipv6-address
35197 description: IP address
35200 example: __L3-INTERFACE-IPV6-ADDRESS__
35201 - name: resource-version
35203 description: resource-version for concurrency
35206 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
35210 summary: returns l-interface
35211 description: returns l-interface
35212 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
35218 description: successful operation
35220 $ref: "#/getDefinitions/l-interface"
35222 description: Response codes found in [response codes](https://wiki.onap.org/).
35226 description: Unique id of VNF. This is unique across the graph.
35229 example: __VNF-ID__
35230 - name: interface-name
35232 description: Name that identifies the link aggregate interface
35235 example: __INTERFACE-NAME__
35236 - name: interface-name
35238 description: Name given to the interface
35241 example: __INTERFACE-NAME__
35245 summary: create or update an existing l-interface
35247 Create or update an existing l-interface.
35249 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35250 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
35259 description: Response codes found in [response codes](https://wiki.onap.org/).
35263 description: Unique id of VNF. This is unique across the graph.
35266 example: __VNF-ID__
35267 - name: interface-name
35269 description: Name that identifies the link aggregate interface
35272 example: __INTERFACE-NAME__
35273 - name: interface-name
35275 description: Name given to the interface
35278 example: __INTERFACE-NAME__
35281 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
35284 $ref: "#/definitions/l-interface"
35288 summary: update an existing l-interface
35290 Update an existing l-interface
35292 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35293 The PUT operation will entirely replace an existing object.
35294 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35296 Other differences between PUT and PATCH are:
35298 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35299 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35300 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35301 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
35310 description: Response codes found in [response codes](https://wiki.onap.org/).
35314 description: Unique id of VNF. This is unique across the graph.
35317 example: __VNF-ID__
35318 - name: interface-name
35320 description: Name that identifies the link aggregate interface
35323 example: __INTERFACE-NAME__
35324 - name: interface-name
35326 description: Name given to the interface
35329 example: __INTERFACE-NAME__
35332 description: l-interface object that needs to be updated.
35335 $ref: "#/patchDefinitions/l-interface"
35339 summary: delete an existing l-interface
35340 description: delete an existing l-interface
35341 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
35350 description: Response codes found in [response codes](https://wiki.onap.org/).
35354 description: Unique id of VNF. This is unique across the graph.
35357 example: __VNF-ID__
35358 - name: interface-name
35360 description: Name that identifies the link aggregate interface
35363 example: __INTERFACE-NAME__
35364 - name: interface-name
35366 description: Name given to the interface
35369 example: __INTERFACE-NAME__
35370 - name: resource-version
35372 description: resource-version for concurrency
35375 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
35379 summary: returns l-interfaces
35380 description: returns l-interfaces
35381 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces
35387 description: successful operation
35389 $ref: "#/getDefinitions/l-interfaces"
35391 description: Response codes found in [response codes](https://wiki.onap.org/).
35395 description: Unique id of VNF. This is unique across the graph.
35398 example: __VNF-ID__
35399 - name: interface-name
35401 description: Name that identifies the link aggregate interface
35404 example: __INTERFACE-NAME__
35405 - name: interface-name
35410 - name: interface-id
35420 - name: network-name
35425 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}:
35429 summary: returns lag-interface
35430 description: returns lag-interface
35431 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
35437 description: successful operation
35439 $ref: "#/getDefinitions/lag-interface"
35441 description: Response codes found in [response codes](https://wiki.onap.org/).
35445 description: Unique id of VNF. This is unique across the graph.
35448 example: __VNF-ID__
35449 - name: interface-name
35451 description: Name that identifies the link aggregate interface
35454 example: __INTERFACE-NAME__
35458 summary: create or update an existing lag-interface
35460 Create or update an existing lag-interface.
35462 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35463 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
35472 description: Response codes found in [response codes](https://wiki.onap.org/).
35476 description: Unique id of VNF. This is unique across the graph.
35479 example: __VNF-ID__
35480 - name: interface-name
35482 description: Name that identifies the link aggregate interface
35485 example: __INTERFACE-NAME__
35488 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
35491 $ref: "#/definitions/lag-interface"
35495 summary: update an existing lag-interface
35497 Update an existing lag-interface
35499 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35500 The PUT operation will entirely replace an existing object.
35501 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35503 Other differences between PUT and PATCH are:
35505 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35506 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35507 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35508 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
35517 description: Response codes found in [response codes](https://wiki.onap.org/).
35521 description: Unique id of VNF. This is unique across the graph.
35524 example: __VNF-ID__
35525 - name: interface-name
35527 description: Name that identifies the link aggregate interface
35530 example: __INTERFACE-NAME__
35533 description: lag-interface object that needs to be updated.
35536 $ref: "#/patchDefinitions/lag-interface"
35540 summary: delete an existing lag-interface
35541 description: delete an existing lag-interface
35542 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
35551 description: Response codes found in [response codes](https://wiki.onap.org/).
35555 description: Unique id of VNF. This is unique across the graph.
35558 example: __VNF-ID__
35559 - name: interface-name
35561 description: Name that identifies the link aggregate interface
35564 example: __INTERFACE-NAME__
35565 - name: resource-version
35567 description: resource-version for concurrency
35570 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces:
35574 summary: returns lag-interfaces
35575 description: returns lag-interfaces
35576 operationId: getNetworkGenericVnfsGenericVnfLagInterfaces
35582 description: successful operation
35584 $ref: "#/getDefinitions/lag-interfaces"
35586 description: Response codes found in [response codes](https://wiki.onap.org/).
35590 description: Unique id of VNF. This is unique across the graph.
35593 example: __VNF-ID__
35594 - name: interface-name
35599 - name: interface-id
35604 - name: interface-role
35609 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship:
35613 summary: see node definition for valid relationships
35614 operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
35623 description: Response codes found in [response codes](https://wiki.onap.org/).
35627 description: Unique id of VNF. This is unique across the graph.
35630 example: __VNF-ID__
35631 - name: vf-module-id
35633 description: Unique ID of vf-module.
35636 example: __VF-MODULE-ID__
35639 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
35642 $ref: "#/definitions/relationship"
35646 summary: delete an existing relationship
35647 description: delete an existing relationship
35648 operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
35657 description: Response codes found in [response codes](https://wiki.onap.org/).
35661 description: Unique id of VNF. This is unique across the graph.
35664 example: __VNF-ID__
35665 - name: vf-module-id
35667 description: Unique ID of vf-module.
35670 example: __VF-MODULE-ID__
35671 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}:
35675 summary: returns vf-module
35676 description: returns vf-module
35677 operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule
35683 description: successful operation
35685 $ref: "#/getDefinitions/vf-module"
35687 description: Response codes found in [response codes](https://wiki.onap.org/).
35691 description: Unique id of VNF. This is unique across the graph.
35694 example: __VNF-ID__
35695 - name: vf-module-id
35697 description: Unique ID of vf-module.
35700 example: __VF-MODULE-ID__
35704 summary: create or update an existing vf-module
35706 Create or update an existing vf-module.
35708 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35709 operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
35718 description: Response codes found in [response codes](https://wiki.onap.org/).
35722 description: Unique id of VNF. This is unique across the graph.
35725 example: __VNF-ID__
35726 - name: vf-module-id
35728 description: Unique ID of vf-module.
35731 example: __VF-MODULE-ID__
35734 description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
35737 $ref: "#/definitions/vf-module"
35741 summary: update an existing vf-module
35743 Update an existing vf-module
35745 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35746 The PUT operation will entirely replace an existing object.
35747 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35749 Other differences between PUT and PATCH are:
35751 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35752 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35753 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35754 operationId: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
35763 description: Response codes found in [response codes](https://wiki.onap.org/).
35767 description: Unique id of VNF. This is unique across the graph.
35770 example: __VNF-ID__
35771 - name: vf-module-id
35773 description: Unique ID of vf-module.
35776 example: __VF-MODULE-ID__
35779 description: vf-module object that needs to be updated.
35782 $ref: "#/patchDefinitions/vf-module"
35786 summary: delete an existing vf-module
35787 description: delete an existing vf-module
35788 operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule
35797 description: Response codes found in [response codes](https://wiki.onap.org/).
35801 description: Unique id of VNF. This is unique across the graph.
35804 example: __VNF-ID__
35805 - name: vf-module-id
35807 description: Unique ID of vf-module.
35810 example: __VF-MODULE-ID__
35811 - name: resource-version
35813 description: resource-version for concurrency
35816 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules:
35820 summary: returns vf-modules
35821 description: returns vf-modules
35822 operationId: getNetworkGenericVnfsGenericVnfVfModules
35828 description: successful operation
35830 $ref: "#/getDefinitions/vf-modules"
35832 description: Response codes found in [response codes](https://wiki.onap.org/).
35836 description: Unique id of VNF. This is unique across the graph.
35839 example: __VNF-ID__
35840 - name: vf-module-id
35845 - name: vf-module-name
35850 - name: heat-stack-id
35855 - name: model-invariant-id
35860 - name: model-version-id
35865 - name: widget-model-id
35870 - name: widget-model-version
35875 - name: contrail-service-instance-fqdn
35880 /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
35884 summary: see node definition for valid relationships
35885 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
35894 description: Response codes found in [response codes](https://wiki.onap.org/).
35898 description: Unique id of VNF. This is unique across the graph.
35901 example: __VNF-ID__
35904 description: Unique ID for the license group the resource belongs to, should be uuid.
35907 example: __GROUP-UUID__
35908 - name: resource-uuid
35910 description: Unique ID of a license resource.
35913 example: __RESOURCE-UUID__
35916 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLicensesLicense.json)
35919 $ref: "#/definitions/relationship"
35923 summary: delete an existing relationship
35924 description: delete an existing relationship
35925 operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
35934 description: Response codes found in [response codes](https://wiki.onap.org/).
35938 description: Unique id of VNF. This is unique across the graph.
35941 example: __VNF-ID__
35944 description: Unique ID for the license group the resource belongs to, should be uuid.
35947 example: __GROUP-UUID__
35948 - name: resource-uuid
35950 description: Unique ID of a license resource.
35953 example: __RESOURCE-UUID__
35954 /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
35958 summary: returns license
35959 description: returns license
35960 operationId: getNetworkGenericVnfsGenericVnfLicensesLicense
35966 description: successful operation
35968 $ref: "#/getDefinitions/license"
35970 description: Response codes found in [response codes](https://wiki.onap.org/).
35974 description: Unique id of VNF. This is unique across the graph.
35977 example: __VNF-ID__
35980 description: Unique ID for the license group the resource belongs to, should be uuid.
35983 example: __GROUP-UUID__
35984 - name: resource-uuid
35986 description: Unique ID of a license resource.
35989 example: __RESOURCE-UUID__
35993 summary: create or update an existing license
35995 Create or update an existing license.
35997 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35998 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense
36007 description: Response codes found in [response codes](https://wiki.onap.org/).
36011 description: Unique id of VNF. This is unique across the graph.
36014 example: __VNF-ID__
36017 description: Unique ID for the license group the resource belongs to, should be uuid.
36020 example: __GROUP-UUID__
36021 - name: resource-uuid
36023 description: Unique ID of a license resource.
36026 example: __RESOURCE-UUID__
36029 description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfLicensesLicense.json)
36032 $ref: "#/definitions/license"
36036 summary: update an existing license
36038 Update an existing license
36040 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36041 The PUT operation will entirely replace an existing object.
36042 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36044 Other differences between PUT and PATCH are:
36046 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36047 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36048 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36049 operationId: UpdateNetworkGenericVnfsGenericVnfLicensesLicense
36058 description: Response codes found in [response codes](https://wiki.onap.org/).
36062 description: Unique id of VNF. This is unique across the graph.
36065 example: __VNF-ID__
36068 description: Unique ID for the license group the resource belongs to, should be uuid.
36071 example: __GROUP-UUID__
36072 - name: resource-uuid
36074 description: Unique ID of a license resource.
36077 example: __RESOURCE-UUID__
36080 description: license object that needs to be updated.
36083 $ref: "#/patchDefinitions/license"
36087 summary: delete an existing license
36088 description: delete an existing license
36089 operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicense
36098 description: Response codes found in [response codes](https://wiki.onap.org/).
36102 description: Unique id of VNF. This is unique across the graph.
36105 example: __VNF-ID__
36108 description: Unique ID for the license group the resource belongs to, should be uuid.
36111 example: __GROUP-UUID__
36112 - name: resource-uuid
36114 description: Unique ID of a license resource.
36117 example: __RESOURCE-UUID__
36118 - name: resource-version
36120 description: resource-version for concurrency
36123 /network/generic-vnfs/generic-vnf/{vnf-id}/licenses:
36127 summary: returns licenses
36128 description: returns licenses
36129 operationId: getNetworkGenericVnfsGenericVnfLicenses
36135 description: successful operation
36137 $ref: "#/getDefinitions/licenses"
36139 description: Response codes found in [response codes](https://wiki.onap.org/).
36143 description: Unique id of VNF. This is unique across the graph.
36146 example: __VNF-ID__
36152 - name: resource-uuid
36157 /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
36161 summary: see node definition for valid relationships
36162 operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
36171 description: Response codes found in [response codes](https://wiki.onap.org/).
36175 description: Unique id of VNF. This is unique across the graph.
36178 example: __VNF-ID__
36181 description: Unique ID for the entitlement group the resource comes from, should be uuid.
36184 example: __GROUP-UUID__
36185 - name: resource-uuid
36187 description: Unique ID of an entitlement resource.
36190 example: __RESOURCE-UUID__
36193 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
36196 $ref: "#/definitions/relationship"
36200 summary: delete an existing relationship
36201 description: delete an existing relationship
36202 operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
36211 description: Response codes found in [response codes](https://wiki.onap.org/).
36215 description: Unique id of VNF. This is unique across the graph.
36218 example: __VNF-ID__
36221 description: Unique ID for the entitlement group the resource comes from, should be uuid.
36224 example: __GROUP-UUID__
36225 - name: resource-uuid
36227 description: Unique ID of an entitlement resource.
36230 example: __RESOURCE-UUID__
36231 /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
36235 summary: returns entitlement
36236 description: returns entitlement
36237 operationId: getNetworkGenericVnfsGenericVnfEntitlementsEntitlement
36243 description: successful operation
36245 $ref: "#/getDefinitions/entitlement"
36247 description: Response codes found in [response codes](https://wiki.onap.org/).
36251 description: Unique id of VNF. This is unique across the graph.
36254 example: __VNF-ID__
36257 description: Unique ID for the entitlement group the resource comes from, should be uuid.
36260 example: __GROUP-UUID__
36261 - name: resource-uuid
36263 description: Unique ID of an entitlement resource.
36266 example: __RESOURCE-UUID__
36270 summary: create or update an existing entitlement
36272 Create or update an existing entitlement.
36274 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36275 operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
36284 description: Response codes found in [response codes](https://wiki.onap.org/).
36288 description: Unique id of VNF. This is unique across the graph.
36291 example: __VNF-ID__
36294 description: Unique ID for the entitlement group the resource comes from, should be uuid.
36297 example: __GROUP-UUID__
36298 - name: resource-uuid
36300 description: Unique ID of an entitlement resource.
36303 example: __RESOURCE-UUID__
36306 description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
36309 $ref: "#/definitions/entitlement"
36313 summary: update an existing entitlement
36315 Update an existing entitlement
36317 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36318 The PUT operation will entirely replace an existing object.
36319 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36321 Other differences between PUT and PATCH are:
36323 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36324 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36325 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36326 operationId: UpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
36335 description: Response codes found in [response codes](https://wiki.onap.org/).
36339 description: Unique id of VNF. This is unique across the graph.
36342 example: __VNF-ID__
36345 description: Unique ID for the entitlement group the resource comes from, should be uuid.
36348 example: __GROUP-UUID__
36349 - name: resource-uuid
36351 description: Unique ID of an entitlement resource.
36354 example: __RESOURCE-UUID__
36357 description: entitlement object that needs to be updated.
36360 $ref: "#/patchDefinitions/entitlement"
36364 summary: delete an existing entitlement
36365 description: delete an existing entitlement
36366 operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlement
36375 description: Response codes found in [response codes](https://wiki.onap.org/).
36379 description: Unique id of VNF. This is unique across the graph.
36382 example: __VNF-ID__
36385 description: Unique ID for the entitlement group the resource comes from, should be uuid.
36388 example: __GROUP-UUID__
36389 - name: resource-uuid
36391 description: Unique ID of an entitlement resource.
36394 example: __RESOURCE-UUID__
36395 - name: resource-version
36397 description: resource-version for concurrency
36400 /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements:
36404 summary: returns entitlements
36405 description: returns entitlements
36406 operationId: getNetworkGenericVnfsGenericVnfEntitlements
36412 description: successful operation
36414 $ref: "#/getDefinitions/entitlements"
36416 description: Response codes found in [response codes](https://wiki.onap.org/).
36420 description: Unique id of VNF. This is unique across the graph.
36423 example: __VNF-ID__
36429 - name: resource-uuid
36434 /network/generic-vnfs/generic-vnf/{vnf-id}:
36438 summary: returns generic-vnf
36439 description: returns generic-vnf
36440 operationId: getNetworkGenericVnfsGenericVnf
36446 description: successful operation
36448 $ref: "#/getDefinitions/generic-vnf"
36450 description: Response codes found in [response codes](https://wiki.onap.org/).
36454 description: Unique id of VNF. This is unique across the graph.
36457 example: __VNF-ID__
36461 summary: create or update an existing generic-vnf
36463 Create or update an existing generic-vnf.
36465 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36466 operationId: createOrUpdateNetworkGenericVnfsGenericVnf
36475 description: Response codes found in [response codes](https://wiki.onap.org/).
36479 description: Unique id of VNF. This is unique across the graph.
36482 example: __VNF-ID__
36485 description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkGenericVnfsGenericVnf.json)
36488 $ref: "#/definitions/generic-vnf"
36492 summary: update an existing generic-vnf
36494 Update an existing generic-vnf
36496 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36497 The PUT operation will entirely replace an existing object.
36498 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36500 Other differences between PUT and PATCH are:
36502 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36503 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36504 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36505 operationId: UpdateNetworkGenericVnfsGenericVnf
36514 description: Response codes found in [response codes](https://wiki.onap.org/).
36518 description: Unique id of VNF. This is unique across the graph.
36521 example: __VNF-ID__
36524 description: generic-vnf object that needs to be updated.
36527 $ref: "#/patchDefinitions/generic-vnf"
36531 summary: delete an existing generic-vnf
36532 description: delete an existing generic-vnf
36533 operationId: deleteNetworkGenericVnfsGenericVnf
36542 description: Response codes found in [response codes](https://wiki.onap.org/).
36546 description: Unique id of VNF. This is unique across the graph.
36549 example: __VNF-ID__
36550 - name: resource-version
36552 description: resource-version for concurrency
36555 /network/generic-vnfs:
36559 summary: returns generic-vnfs
36560 description: returns generic-vnfs
36561 operationId: getNetworkGenericVnfs
36567 description: successful operation
36569 $ref: "#/getDefinitions/generic-vnfs"
36571 description: Response codes found in [response codes](https://wiki.onap.org/).
36598 - name: regional-resource-zone
36603 - name: prov-status
36608 - name: heat-stack-id
36618 - name: is-closed-loop-disabled
36623 - name: model-invariant-id
36628 - name: model-version-id
36633 - name: widget-model-id
36638 - name: widget-model-version
36648 - name: nf-function
36658 - name: nf-naming-code
36663 /network/lag-links/lag-link/{link-name}/relationship-list/relationship:
36667 summary: see node definition for valid relationships
36668 operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship
36677 description: Response codes found in [response codes](https://wiki.onap.org/).
36681 description: Alphabetical concatenation of lag-interface names
36684 example: __LINK-NAME__
36687 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkLagLinksLagLink.json)
36690 $ref: "#/definitions/relationship"
36694 summary: delete an existing relationship
36695 description: delete an existing relationship
36696 operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship
36705 description: Response codes found in [response codes](https://wiki.onap.org/).
36709 description: Alphabetical concatenation of lag-interface names
36712 example: __LINK-NAME__
36713 /network/lag-links/lag-link/{link-name}:
36717 summary: returns lag-link
36718 description: returns lag-link
36719 operationId: getNetworkLagLinksLagLink
36725 description: successful operation
36727 $ref: "#/getDefinitions/lag-link"
36729 description: Response codes found in [response codes](https://wiki.onap.org/).
36733 description: Alphabetical concatenation of lag-interface names
36736 example: __LINK-NAME__
36740 summary: create or update an existing lag-link
36742 Create or update an existing lag-link.
36744 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36745 operationId: createOrUpdateNetworkLagLinksLagLink
36754 description: Response codes found in [response codes](https://wiki.onap.org/).
36758 description: Alphabetical concatenation of lag-interface names
36761 example: __LINK-NAME__
36764 description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkLagLinksLagLink.json)
36767 $ref: "#/definitions/lag-link"
36771 summary: update an existing lag-link
36773 Update an existing lag-link
36775 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36776 The PUT operation will entirely replace an existing object.
36777 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36779 Other differences between PUT and PATCH are:
36781 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36782 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36783 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36784 operationId: UpdateNetworkLagLinksLagLink
36793 description: Response codes found in [response codes](https://wiki.onap.org/).
36797 description: Alphabetical concatenation of lag-interface names
36800 example: __LINK-NAME__
36803 description: lag-link object that needs to be updated.
36806 $ref: "#/patchDefinitions/lag-link"
36810 summary: delete an existing lag-link
36811 description: delete an existing lag-link
36812 operationId: deleteNetworkLagLinksLagLink
36821 description: Response codes found in [response codes](https://wiki.onap.org/).
36825 description: Alphabetical concatenation of lag-interface names
36828 example: __LINK-NAME__
36829 - name: resource-version
36831 description: resource-version for concurrency
36834 /network/lag-links:
36838 summary: returns lag-links
36839 description: returns lag-links
36840 operationId: getNetworkLagLinks
36846 description: successful operation
36848 $ref: "#/getDefinitions/lag-links"
36850 description: Response codes found in [response codes](https://wiki.onap.org/).
36857 /network/newvces/newvce/{vnf-id2}/relationship-list/relationship:
36861 summary: see node definition for valid relationships
36862 operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship
36871 description: Response codes found in [response codes](https://wiki.onap.org/).
36875 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36878 example: __VNF-ID2__
36881 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvce.json)
36884 $ref: "#/definitions/relationship"
36888 summary: delete an existing relationship
36889 description: delete an existing relationship
36890 operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship
36899 description: Response codes found in [response codes](https://wiki.onap.org/).
36903 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36906 example: __VNF-ID2__
36907 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
36911 summary: see node definition for valid relationships
36912 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
36921 description: Response codes found in [response codes](https://wiki.onap.org/).
36925 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36928 example: __VNF-ID2__
36929 - name: interface-name
36931 description: Name given to the interface
36934 example: __INTERFACE-NAME__
36935 - name: vlan-interface
36937 description: String that identifies the interface
36940 example: __VLAN-INTERFACE__
36943 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
36946 $ref: "#/definitions/relationship"
36950 summary: delete an existing relationship
36951 description: delete an existing relationship
36952 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
36961 description: Response codes found in [response codes](https://wiki.onap.org/).
36965 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36968 example: __VNF-ID2__
36969 - name: interface-name
36971 description: Name given to the interface
36974 example: __INTERFACE-NAME__
36975 - name: vlan-interface
36977 description: String that identifies the interface
36980 example: __VLAN-INTERFACE__
36981 /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:
36985 summary: see node definition for valid relationships
36986 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
36995 description: Response codes found in [response codes](https://wiki.onap.org/).
36999 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37002 example: __VNF-ID2__
37003 - name: interface-name
37005 description: Name given to the interface
37008 example: __INTERFACE-NAME__
37009 - name: vlan-interface
37011 description: String that identifies the interface
37014 example: __VLAN-INTERFACE__
37015 - name: l3-interface-ipv4-address
37017 description: IP address
37020 example: __L3-INTERFACE-IPV4-ADDRESS__
37023 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
37026 $ref: "#/definitions/relationship"
37030 summary: delete an existing relationship
37031 description: delete an existing relationship
37032 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
37041 description: Response codes found in [response codes](https://wiki.onap.org/).
37045 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37048 example: __VNF-ID2__
37049 - name: interface-name
37051 description: Name given to the interface
37054 example: __INTERFACE-NAME__
37055 - name: vlan-interface
37057 description: String that identifies the interface
37060 example: __VLAN-INTERFACE__
37061 - name: l3-interface-ipv4-address
37063 description: IP address
37066 example: __L3-INTERFACE-IPV4-ADDRESS__
37067 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
37071 summary: returns l3-interface-ipv4-address-list
37072 description: returns l3-interface-ipv4-address-list
37073 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37079 description: successful operation
37081 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
37083 description: Response codes found in [response codes](https://wiki.onap.org/).
37087 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37090 example: __VNF-ID2__
37091 - name: interface-name
37093 description: Name given to the interface
37096 example: __INTERFACE-NAME__
37097 - name: vlan-interface
37099 description: String that identifies the interface
37102 example: __VLAN-INTERFACE__
37103 - name: l3-interface-ipv4-address
37105 description: IP address
37108 example: __L3-INTERFACE-IPV4-ADDRESS__
37112 summary: create or update an existing l3-interface-ipv4-address-list
37114 Create or update an existing l3-interface-ipv4-address-list.
37116 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37117 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37126 description: Response codes found in [response codes](https://wiki.onap.org/).
37130 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37133 example: __VNF-ID2__
37134 - name: interface-name
37136 description: Name given to the interface
37139 example: __INTERFACE-NAME__
37140 - name: vlan-interface
37142 description: String that identifies the interface
37145 example: __VLAN-INTERFACE__
37146 - name: l3-interface-ipv4-address
37148 description: IP address
37151 example: __L3-INTERFACE-IPV4-ADDRESS__
37154 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
37157 $ref: "#/definitions/l3-interface-ipv4-address-list"
37161 summary: update an existing l3-interface-ipv4-address-list
37163 Update an existing l3-interface-ipv4-address-list
37165 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37166 The PUT operation will entirely replace an existing object.
37167 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37169 Other differences between PUT and PATCH are:
37171 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37172 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37173 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37174 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37183 description: Response codes found in [response codes](https://wiki.onap.org/).
37187 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37190 example: __VNF-ID2__
37191 - name: interface-name
37193 description: Name given to the interface
37196 example: __INTERFACE-NAME__
37197 - name: vlan-interface
37199 description: String that identifies the interface
37202 example: __VLAN-INTERFACE__
37203 - name: l3-interface-ipv4-address
37205 description: IP address
37208 example: __L3-INTERFACE-IPV4-ADDRESS__
37211 description: l3-interface-ipv4-address-list object that needs to be updated.
37214 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
37218 summary: delete an existing l3-interface-ipv4-address-list
37219 description: delete an existing l3-interface-ipv4-address-list
37220 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37229 description: Response codes found in [response codes](https://wiki.onap.org/).
37233 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37236 example: __VNF-ID2__
37237 - name: interface-name
37239 description: Name given to the interface
37242 example: __INTERFACE-NAME__
37243 - name: vlan-interface
37245 description: String that identifies the interface
37248 example: __VLAN-INTERFACE__
37249 - name: l3-interface-ipv4-address
37251 description: IP address
37254 example: __L3-INTERFACE-IPV4-ADDRESS__
37255 - name: resource-version
37257 description: resource-version for concurrency
37260 /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:
37264 summary: see node definition for valid relationships
37265 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
37274 description: Response codes found in [response codes](https://wiki.onap.org/).
37278 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37281 example: __VNF-ID2__
37282 - name: interface-name
37284 description: Name given to the interface
37287 example: __INTERFACE-NAME__
37288 - name: vlan-interface
37290 description: String that identifies the interface
37293 example: __VLAN-INTERFACE__
37294 - name: l3-interface-ipv6-address
37296 description: IP address
37299 example: __L3-INTERFACE-IPV6-ADDRESS__
37302 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
37305 $ref: "#/definitions/relationship"
37309 summary: delete an existing relationship
37310 description: delete an existing relationship
37311 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
37320 description: Response codes found in [response codes](https://wiki.onap.org/).
37324 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37327 example: __VNF-ID2__
37328 - name: interface-name
37330 description: Name given to the interface
37333 example: __INTERFACE-NAME__
37334 - name: vlan-interface
37336 description: String that identifies the interface
37339 example: __VLAN-INTERFACE__
37340 - name: l3-interface-ipv6-address
37342 description: IP address
37345 example: __L3-INTERFACE-IPV6-ADDRESS__
37346 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
37350 summary: returns l3-interface-ipv6-address-list
37351 description: returns l3-interface-ipv6-address-list
37352 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37358 description: successful operation
37360 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
37362 description: Response codes found in [response codes](https://wiki.onap.org/).
37366 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37369 example: __VNF-ID2__
37370 - name: interface-name
37372 description: Name given to the interface
37375 example: __INTERFACE-NAME__
37376 - name: vlan-interface
37378 description: String that identifies the interface
37381 example: __VLAN-INTERFACE__
37382 - name: l3-interface-ipv6-address
37384 description: IP address
37387 example: __L3-INTERFACE-IPV6-ADDRESS__
37391 summary: create or update an existing l3-interface-ipv6-address-list
37393 Create or update an existing l3-interface-ipv6-address-list.
37395 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37396 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37405 description: Response codes found in [response codes](https://wiki.onap.org/).
37409 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37412 example: __VNF-ID2__
37413 - name: interface-name
37415 description: Name given to the interface
37418 example: __INTERFACE-NAME__
37419 - name: vlan-interface
37421 description: String that identifies the interface
37424 example: __VLAN-INTERFACE__
37425 - name: l3-interface-ipv6-address
37427 description: IP address
37430 example: __L3-INTERFACE-IPV6-ADDRESS__
37433 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
37436 $ref: "#/definitions/l3-interface-ipv6-address-list"
37440 summary: update an existing l3-interface-ipv6-address-list
37442 Update an existing l3-interface-ipv6-address-list
37444 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37445 The PUT operation will entirely replace an existing object.
37446 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37448 Other differences between PUT and PATCH are:
37450 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37451 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37452 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37453 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37462 description: Response codes found in [response codes](https://wiki.onap.org/).
37466 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37469 example: __VNF-ID2__
37470 - name: interface-name
37472 description: Name given to the interface
37475 example: __INTERFACE-NAME__
37476 - name: vlan-interface
37478 description: String that identifies the interface
37481 example: __VLAN-INTERFACE__
37482 - name: l3-interface-ipv6-address
37484 description: IP address
37487 example: __L3-INTERFACE-IPV6-ADDRESS__
37490 description: l3-interface-ipv6-address-list object that needs to be updated.
37493 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
37497 summary: delete an existing l3-interface-ipv6-address-list
37498 description: delete an existing l3-interface-ipv6-address-list
37499 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37508 description: Response codes found in [response codes](https://wiki.onap.org/).
37512 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37515 example: __VNF-ID2__
37516 - name: interface-name
37518 description: Name given to the interface
37521 example: __INTERFACE-NAME__
37522 - name: vlan-interface
37524 description: String that identifies the interface
37527 example: __VLAN-INTERFACE__
37528 - name: l3-interface-ipv6-address
37530 description: IP address
37533 example: __L3-INTERFACE-IPV6-ADDRESS__
37534 - name: resource-version
37536 description: resource-version for concurrency
37539 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
37543 summary: returns vlan
37544 description: returns vlan
37545 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
37551 description: successful operation
37553 $ref: "#/getDefinitions/vlan"
37555 description: Response codes found in [response codes](https://wiki.onap.org/).
37559 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37562 example: __VNF-ID2__
37563 - name: interface-name
37565 description: Name given to the interface
37568 example: __INTERFACE-NAME__
37569 - name: vlan-interface
37571 description: String that identifies the interface
37574 example: __VLAN-INTERFACE__
37578 summary: create or update an existing vlan
37580 Create or update an existing vlan.
37582 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37583 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
37592 description: Response codes found in [response codes](https://wiki.onap.org/).
37596 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37599 example: __VNF-ID2__
37600 - name: interface-name
37602 description: Name given to the interface
37605 example: __INTERFACE-NAME__
37606 - name: vlan-interface
37608 description: String that identifies the interface
37611 example: __VLAN-INTERFACE__
37614 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
37617 $ref: "#/definitions/vlan"
37621 summary: update an existing vlan
37623 Update an existing vlan
37625 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37626 The PUT operation will entirely replace an existing object.
37627 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37629 Other differences between PUT and PATCH are:
37631 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37632 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37633 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37634 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
37643 description: Response codes found in [response codes](https://wiki.onap.org/).
37647 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37650 example: __VNF-ID2__
37651 - name: interface-name
37653 description: Name given to the interface
37656 example: __INTERFACE-NAME__
37657 - name: vlan-interface
37659 description: String that identifies the interface
37662 example: __VLAN-INTERFACE__
37665 description: vlan object that needs to be updated.
37668 $ref: "#/patchDefinitions/vlan"
37672 summary: delete an existing vlan
37673 description: delete an existing vlan
37674 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
37683 description: Response codes found in [response codes](https://wiki.onap.org/).
37687 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37690 example: __VNF-ID2__
37691 - name: interface-name
37693 description: Name given to the interface
37696 example: __INTERFACE-NAME__
37697 - name: vlan-interface
37699 description: String that identifies the interface
37702 example: __VLAN-INTERFACE__
37703 - name: resource-version
37705 description: resource-version for concurrency
37708 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans:
37712 summary: returns vlans
37713 description: returns vlans
37714 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans
37720 description: successful operation
37722 $ref: "#/getDefinitions/vlans"
37724 description: Response codes found in [response codes](https://wiki.onap.org/).
37728 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37731 example: __VNF-ID2__
37732 - name: interface-name
37734 description: Name given to the interface
37737 example: __INTERFACE-NAME__
37738 - name: vlan-interface
37743 - name: vlan-id-inner
37754 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
37758 summary: see node definition for valid relationships
37759 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
37768 description: Response codes found in [response codes](https://wiki.onap.org/).
37772 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37775 example: __VNF-ID2__
37776 - name: interface-name
37778 description: Name given to the interface
37781 example: __INTERFACE-NAME__
37784 description: PCI ID used to identify the sriov-vf
37787 example: __PCI-ID__
37790 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
37793 $ref: "#/definitions/relationship"
37797 summary: delete an existing relationship
37798 description: delete an existing relationship
37799 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
37808 description: Response codes found in [response codes](https://wiki.onap.org/).
37812 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37815 example: __VNF-ID2__
37816 - name: interface-name
37818 description: Name given to the interface
37821 example: __INTERFACE-NAME__
37824 description: PCI ID used to identify the sriov-vf
37827 example: __PCI-ID__
37828 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
37832 summary: returns sriov-vf
37833 description: returns sriov-vf
37834 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
37840 description: successful operation
37842 $ref: "#/getDefinitions/sriov-vf"
37844 description: Response codes found in [response codes](https://wiki.onap.org/).
37848 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37851 example: __VNF-ID2__
37852 - name: interface-name
37854 description: Name given to the interface
37857 example: __INTERFACE-NAME__
37860 description: PCI ID used to identify the sriov-vf
37863 example: __PCI-ID__
37867 summary: create or update an existing sriov-vf
37869 Create or update an existing sriov-vf.
37871 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37872 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
37881 description: Response codes found in [response codes](https://wiki.onap.org/).
37885 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37888 example: __VNF-ID2__
37889 - name: interface-name
37891 description: Name given to the interface
37894 example: __INTERFACE-NAME__
37897 description: PCI ID used to identify the sriov-vf
37900 example: __PCI-ID__
37903 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
37906 $ref: "#/definitions/sriov-vf"
37910 summary: update an existing sriov-vf
37912 Update an existing sriov-vf
37914 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37915 The PUT operation will entirely replace an existing object.
37916 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37918 Other differences between PUT and PATCH are:
37920 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37921 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37922 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37923 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
37932 description: Response codes found in [response codes](https://wiki.onap.org/).
37936 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37939 example: __VNF-ID2__
37940 - name: interface-name
37942 description: Name given to the interface
37945 example: __INTERFACE-NAME__
37948 description: PCI ID used to identify the sriov-vf
37951 example: __PCI-ID__
37954 description: sriov-vf object that needs to be updated.
37957 $ref: "#/patchDefinitions/sriov-vf"
37961 summary: delete an existing sriov-vf
37962 description: delete an existing sriov-vf
37963 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
37972 description: Response codes found in [response codes](https://wiki.onap.org/).
37976 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37979 example: __VNF-ID2__
37980 - name: interface-name
37982 description: Name given to the interface
37985 example: __INTERFACE-NAME__
37988 description: PCI ID used to identify the sriov-vf
37991 example: __PCI-ID__
37992 - name: resource-version
37994 description: resource-version for concurrency
37997 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
38001 summary: returns sriov-vfs
38002 description: returns sriov-vfs
38003 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs
38009 description: successful operation
38011 $ref: "#/getDefinitions/sriov-vfs"
38013 description: Response codes found in [response codes](https://wiki.onap.org/).
38017 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38020 example: __VNF-ID2__
38021 - name: interface-name
38023 description: Name given to the interface
38026 example: __INTERFACE-NAME__
38032 - name: vf-vlan-filter
38037 - name: vf-mac-filter
38042 - name: vf-vlan-strip
38047 - name: neutron-network-id
38052 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
38056 summary: see node definition for valid relationships
38057 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
38066 description: Response codes found in [response codes](https://wiki.onap.org/).
38070 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38073 example: __VNF-ID2__
38074 - name: interface-name
38076 description: Name given to the interface
38079 example: __INTERFACE-NAME__
38082 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterface.json)
38085 $ref: "#/definitions/relationship"
38089 summary: delete an existing relationship
38090 description: delete an existing relationship
38091 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
38100 description: Response codes found in [response codes](https://wiki.onap.org/).
38104 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38107 example: __VNF-ID2__
38108 - name: interface-name
38110 description: Name given to the interface
38113 example: __INTERFACE-NAME__
38114 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
38118 summary: see node definition for valid relationships
38119 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
38128 description: Response codes found in [response codes](https://wiki.onap.org/).
38132 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38135 example: __VNF-ID2__
38136 - name: interface-name
38138 description: Name given to the interface
38141 example: __INTERFACE-NAME__
38142 - name: l3-interface-ipv4-address
38144 description: IP address
38147 example: __L3-INTERFACE-IPV4-ADDRESS__
38150 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
38153 $ref: "#/definitions/relationship"
38157 summary: delete an existing relationship
38158 description: delete an existing relationship
38159 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
38168 description: Response codes found in [response codes](https://wiki.onap.org/).
38172 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38175 example: __VNF-ID2__
38176 - name: interface-name
38178 description: Name given to the interface
38181 example: __INTERFACE-NAME__
38182 - name: l3-interface-ipv4-address
38184 description: IP address
38187 example: __L3-INTERFACE-IPV4-ADDRESS__
38188 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
38192 summary: returns l3-interface-ipv4-address-list
38193 description: returns l3-interface-ipv4-address-list
38194 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
38200 description: successful operation
38202 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
38204 description: Response codes found in [response codes](https://wiki.onap.org/).
38208 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38211 example: __VNF-ID2__
38212 - name: interface-name
38214 description: Name given to the interface
38217 example: __INTERFACE-NAME__
38218 - name: l3-interface-ipv4-address
38220 description: IP address
38223 example: __L3-INTERFACE-IPV4-ADDRESS__
38227 summary: create or update an existing l3-interface-ipv4-address-list
38229 Create or update an existing l3-interface-ipv4-address-list.
38231 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38232 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
38241 description: Response codes found in [response codes](https://wiki.onap.org/).
38245 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38248 example: __VNF-ID2__
38249 - name: interface-name
38251 description: Name given to the interface
38254 example: __INTERFACE-NAME__
38255 - name: l3-interface-ipv4-address
38257 description: IP address
38260 example: __L3-INTERFACE-IPV4-ADDRESS__
38263 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
38266 $ref: "#/definitions/l3-interface-ipv4-address-list"
38270 summary: update an existing l3-interface-ipv4-address-list
38272 Update an existing l3-interface-ipv4-address-list
38274 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38275 The PUT operation will entirely replace an existing object.
38276 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38278 Other differences between PUT and PATCH are:
38280 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38281 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38282 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38283 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
38292 description: Response codes found in [response codes](https://wiki.onap.org/).
38296 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38299 example: __VNF-ID2__
38300 - name: interface-name
38302 description: Name given to the interface
38305 example: __INTERFACE-NAME__
38306 - name: l3-interface-ipv4-address
38308 description: IP address
38311 example: __L3-INTERFACE-IPV4-ADDRESS__
38314 description: l3-interface-ipv4-address-list object that needs to be updated.
38317 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
38321 summary: delete an existing l3-interface-ipv4-address-list
38322 description: delete an existing l3-interface-ipv4-address-list
38323 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
38332 description: Response codes found in [response codes](https://wiki.onap.org/).
38336 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38339 example: __VNF-ID2__
38340 - name: interface-name
38342 description: Name given to the interface
38345 example: __INTERFACE-NAME__
38346 - name: l3-interface-ipv4-address
38348 description: IP address
38351 example: __L3-INTERFACE-IPV4-ADDRESS__
38352 - name: resource-version
38354 description: resource-version for concurrency
38357 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
38361 summary: see node definition for valid relationships
38362 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
38371 description: Response codes found in [response codes](https://wiki.onap.org/).
38375 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38378 example: __VNF-ID2__
38379 - name: interface-name
38381 description: Name given to the interface
38384 example: __INTERFACE-NAME__
38385 - name: l3-interface-ipv6-address
38387 description: IP address
38390 example: __L3-INTERFACE-IPV6-ADDRESS__
38393 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
38396 $ref: "#/definitions/relationship"
38400 summary: delete an existing relationship
38401 description: delete an existing relationship
38402 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
38411 description: Response codes found in [response codes](https://wiki.onap.org/).
38415 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38418 example: __VNF-ID2__
38419 - name: interface-name
38421 description: Name given to the interface
38424 example: __INTERFACE-NAME__
38425 - name: l3-interface-ipv6-address
38427 description: IP address
38430 example: __L3-INTERFACE-IPV6-ADDRESS__
38431 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
38435 summary: returns l3-interface-ipv6-address-list
38436 description: returns l3-interface-ipv6-address-list
38437 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
38443 description: successful operation
38445 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
38447 description: Response codes found in [response codes](https://wiki.onap.org/).
38451 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38454 example: __VNF-ID2__
38455 - name: interface-name
38457 description: Name given to the interface
38460 example: __INTERFACE-NAME__
38461 - name: l3-interface-ipv6-address
38463 description: IP address
38466 example: __L3-INTERFACE-IPV6-ADDRESS__
38470 summary: create or update an existing l3-interface-ipv6-address-list
38472 Create or update an existing l3-interface-ipv6-address-list.
38474 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38475 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
38484 description: Response codes found in [response codes](https://wiki.onap.org/).
38488 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38491 example: __VNF-ID2__
38492 - name: interface-name
38494 description: Name given to the interface
38497 example: __INTERFACE-NAME__
38498 - name: l3-interface-ipv6-address
38500 description: IP address
38503 example: __L3-INTERFACE-IPV6-ADDRESS__
38506 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
38509 $ref: "#/definitions/l3-interface-ipv6-address-list"
38513 summary: update an existing l3-interface-ipv6-address-list
38515 Update an existing l3-interface-ipv6-address-list
38517 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38518 The PUT operation will entirely replace an existing object.
38519 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38521 Other differences between PUT and PATCH are:
38523 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38524 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38525 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38526 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
38535 description: Response codes found in [response codes](https://wiki.onap.org/).
38539 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38542 example: __VNF-ID2__
38543 - name: interface-name
38545 description: Name given to the interface
38548 example: __INTERFACE-NAME__
38549 - name: l3-interface-ipv6-address
38551 description: IP address
38554 example: __L3-INTERFACE-IPV6-ADDRESS__
38557 description: l3-interface-ipv6-address-list object that needs to be updated.
38560 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
38564 summary: delete an existing l3-interface-ipv6-address-list
38565 description: delete an existing l3-interface-ipv6-address-list
38566 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
38575 description: Response codes found in [response codes](https://wiki.onap.org/).
38579 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38582 example: __VNF-ID2__
38583 - name: interface-name
38585 description: Name given to the interface
38588 example: __INTERFACE-NAME__
38589 - name: l3-interface-ipv6-address
38591 description: IP address
38594 example: __L3-INTERFACE-IPV6-ADDRESS__
38595 - name: resource-version
38597 description: resource-version for concurrency
38600 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}:
38604 summary: returns l-interface
38605 description: returns l-interface
38606 operationId: getNetworkNewvcesNewvceLInterfacesLInterface
38612 description: successful operation
38614 $ref: "#/getDefinitions/l-interface"
38616 description: Response codes found in [response codes](https://wiki.onap.org/).
38620 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38623 example: __VNF-ID2__
38624 - name: interface-name
38626 description: Name given to the interface
38629 example: __INTERFACE-NAME__
38633 summary: create or update an existing l-interface
38635 Create or update an existing l-interface.
38637 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38638 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface
38647 description: Response codes found in [response codes](https://wiki.onap.org/).
38651 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38654 example: __VNF-ID2__
38655 - name: interface-name
38657 description: Name given to the interface
38660 example: __INTERFACE-NAME__
38663 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvceLInterfacesLInterface.json)
38666 $ref: "#/definitions/l-interface"
38670 summary: update an existing l-interface
38672 Update an existing l-interface
38674 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38675 The PUT operation will entirely replace an existing object.
38676 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38678 Other differences between PUT and PATCH are:
38680 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38681 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38682 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38683 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterface
38692 description: Response codes found in [response codes](https://wiki.onap.org/).
38696 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38699 example: __VNF-ID2__
38700 - name: interface-name
38702 description: Name given to the interface
38705 example: __INTERFACE-NAME__
38708 description: l-interface object that needs to be updated.
38711 $ref: "#/patchDefinitions/l-interface"
38715 summary: delete an existing l-interface
38716 description: delete an existing l-interface
38717 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface
38726 description: Response codes found in [response codes](https://wiki.onap.org/).
38730 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38733 example: __VNF-ID2__
38734 - name: interface-name
38736 description: Name given to the interface
38739 example: __INTERFACE-NAME__
38740 - name: resource-version
38742 description: resource-version for concurrency
38745 /network/newvces/newvce/{vnf-id2}/l-interfaces:
38749 summary: returns l-interfaces
38750 description: returns l-interfaces
38751 operationId: getNetworkNewvcesNewvceLInterfaces
38757 description: successful operation
38759 $ref: "#/getDefinitions/l-interfaces"
38761 description: Response codes found in [response codes](https://wiki.onap.org/).
38765 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38768 example: __VNF-ID2__
38769 - name: interface-name
38774 - name: interface-id
38784 - name: network-name
38789 /network/newvces/newvce/{vnf-id2}:
38793 summary: returns newvce
38794 description: returns newvce
38795 operationId: getNetworkNewvcesNewvce
38801 description: successful operation
38803 $ref: "#/getDefinitions/newvce"
38805 description: Response codes found in [response codes](https://wiki.onap.org/).
38809 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38812 example: __VNF-ID2__
38816 summary: create or update an existing newvce
38818 Create or update an existing newvce.
38820 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38821 operationId: createOrUpdateNetworkNewvcesNewvce
38830 description: Response codes found in [response codes](https://wiki.onap.org/).
38834 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38837 example: __VNF-ID2__
38840 description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkNewvcesNewvce.json)
38843 $ref: "#/definitions/newvce"
38847 summary: update an existing newvce
38849 Update an existing newvce
38851 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38852 The PUT operation will entirely replace an existing object.
38853 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38855 Other differences between PUT and PATCH are:
38857 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38858 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38859 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38860 operationId: UpdateNetworkNewvcesNewvce
38869 description: Response codes found in [response codes](https://wiki.onap.org/).
38873 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38876 example: __VNF-ID2__
38879 description: newvce object that needs to be updated.
38882 $ref: "#/patchDefinitions/newvce"
38886 summary: delete an existing newvce
38887 description: delete an existing newvce
38888 operationId: deleteNetworkNewvcesNewvce
38897 description: Response codes found in [response codes](https://wiki.onap.org/).
38901 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38904 example: __VNF-ID2__
38905 - name: resource-version
38907 description: resource-version for concurrency
38914 summary: returns newvces
38915 description: returns newvces
38916 operationId: getNetworkNewvces
38922 description: successful operation
38924 $ref: "#/getDefinitions/newvces"
38926 description: Response codes found in [response codes](https://wiki.onap.org/).
38948 - name: prov-status
38953 - name: heat-stack-id
38958 /network/pnfs/pnf/{pnf-name}/relationship-list/relationship:
38962 summary: see node definition for valid relationships
38963 operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship
38972 description: Response codes found in [response codes](https://wiki.onap.org/).
38976 description: unique name of Physical Network Function.
38979 example: __PNF-NAME__
38982 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnf.json)
38985 $ref: "#/definitions/relationship"
38989 summary: delete an existing relationship
38990 description: delete an existing relationship
38991 operationId: deleteNetworkPnfsPnfRelationshipListRelationship
39000 description: Response codes found in [response codes](https://wiki.onap.org/).
39004 description: unique name of Physical Network Function.
39007 example: __PNF-NAME__
39008 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
39012 summary: see node definition for valid relationships
39013 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
39022 description: Response codes found in [response codes](https://wiki.onap.org/).
39026 description: unique name of Physical Network Function.
39029 example: __PNF-NAME__
39030 - name: interface-name
39032 description: Name that identifies the physical interface
39035 example: __INTERFACE-NAME__
39038 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterface.json)
39041 $ref: "#/definitions/relationship"
39045 summary: delete an existing relationship
39046 description: delete an existing relationship
39047 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
39056 description: Response codes found in [response codes](https://wiki.onap.org/).
39060 description: unique name of Physical Network Function.
39063 example: __PNF-NAME__
39064 - name: interface-name
39066 description: Name that identifies the physical interface
39069 example: __INTERFACE-NAME__
39070 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
39074 summary: see node definition for valid relationships
39075 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
39084 description: Response codes found in [response codes](https://wiki.onap.org/).
39088 description: unique name of Physical Network Function.
39091 example: __PNF-NAME__
39092 - name: interface-name
39094 description: Name that identifies the physical interface
39097 example: __INTERFACE-NAME__
39100 description: Identifier for the sriov-pf
39103 example: __PF-PCI-ID__
39106 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)
39109 $ref: "#/definitions/relationship"
39113 summary: delete an existing relationship
39114 description: delete an existing relationship
39115 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
39124 description: Response codes found in [response codes](https://wiki.onap.org/).
39128 description: unique name of Physical Network Function.
39131 example: __PNF-NAME__
39132 - name: interface-name
39134 description: Name that identifies the physical interface
39137 example: __INTERFACE-NAME__
39140 description: Identifier for the sriov-pf
39143 example: __PF-PCI-ID__
39144 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
39148 summary: returns sriov-pf
39149 description: returns sriov-pf
39150 operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
39156 description: successful operation
39158 $ref: "#/getDefinitions/sriov-pf"
39160 description: Response codes found in [response codes](https://wiki.onap.org/).
39164 description: unique name of Physical Network Function.
39167 example: __PNF-NAME__
39168 - name: interface-name
39170 description: Name that identifies the physical interface
39173 example: __INTERFACE-NAME__
39176 description: Identifier for the sriov-pf
39179 example: __PF-PCI-ID__
39183 summary: create or update an existing sriov-pf
39185 Create or update an existing sriov-pf.
39187 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39188 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
39197 description: Response codes found in [response codes](https://wiki.onap.org/).
39201 description: unique name of Physical Network Function.
39204 example: __PNF-NAME__
39205 - name: interface-name
39207 description: Name that identifies the physical interface
39210 example: __INTERFACE-NAME__
39213 description: Identifier for the sriov-pf
39216 example: __PF-PCI-ID__
39219 description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)
39222 $ref: "#/definitions/sriov-pf"
39226 summary: update an existing sriov-pf
39228 Update an existing sriov-pf
39230 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39231 The PUT operation will entirely replace an existing object.
39232 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39234 Other differences between PUT and PATCH are:
39236 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39237 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39238 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39239 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
39248 description: Response codes found in [response codes](https://wiki.onap.org/).
39252 description: unique name of Physical Network Function.
39255 example: __PNF-NAME__
39256 - name: interface-name
39258 description: Name that identifies the physical interface
39261 example: __INTERFACE-NAME__
39264 description: Identifier for the sriov-pf
39267 example: __PF-PCI-ID__
39270 description: sriov-pf object that needs to be updated.
39273 $ref: "#/patchDefinitions/sriov-pf"
39277 summary: delete an existing sriov-pf
39278 description: delete an existing sriov-pf
39279 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
39288 description: Response codes found in [response codes](https://wiki.onap.org/).
39292 description: unique name of Physical Network Function.
39295 example: __PNF-NAME__
39296 - name: interface-name
39298 description: Name that identifies the physical interface
39301 example: __INTERFACE-NAME__
39304 description: Identifier for the sriov-pf
39307 example: __PF-PCI-ID__
39308 - name: resource-version
39310 description: resource-version for concurrency
39313 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
39317 summary: returns sriov-pfs
39318 description: returns sriov-pfs
39319 operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfs
39325 description: successful operation
39327 $ref: "#/getDefinitions/sriov-pfs"
39329 description: Response codes found in [response codes](https://wiki.onap.org/).
39333 description: unique name of Physical Network Function.
39336 example: __PNF-NAME__
39337 - name: interface-name
39339 description: Name that identifies the physical interface
39342 example: __INTERFACE-NAME__
39348 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
39352 summary: see node definition for valid relationships
39353 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
39362 description: Response codes found in [response codes](https://wiki.onap.org/).
39366 description: unique name of Physical Network Function.
39369 example: __PNF-NAME__
39370 - name: interface-name
39372 description: Name that identifies the physical interface
39375 example: __INTERFACE-NAME__
39376 - name: interface-name
39378 description: Name given to the interface
39381 example: __INTERFACE-NAME__
39382 - name: vlan-interface
39384 description: String that identifies the interface
39387 example: __VLAN-INTERFACE__
39390 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
39393 $ref: "#/definitions/relationship"
39397 summary: delete an existing relationship
39398 description: delete an existing relationship
39399 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
39408 description: Response codes found in [response codes](https://wiki.onap.org/).
39412 description: unique name of Physical Network Function.
39415 example: __PNF-NAME__
39416 - name: interface-name
39418 description: Name that identifies the physical interface
39421 example: __INTERFACE-NAME__
39422 - name: interface-name
39424 description: Name given to the interface
39427 example: __INTERFACE-NAME__
39428 - name: vlan-interface
39430 description: String that identifies the interface
39433 example: __VLAN-INTERFACE__
39434 /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:
39438 summary: see node definition for valid relationships
39439 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
39448 description: Response codes found in [response codes](https://wiki.onap.org/).
39452 description: unique name of Physical Network Function.
39455 example: __PNF-NAME__
39456 - name: interface-name
39458 description: Name that identifies the physical interface
39461 example: __INTERFACE-NAME__
39462 - name: interface-name
39464 description: Name given to the interface
39467 example: __INTERFACE-NAME__
39468 - name: vlan-interface
39470 description: String that identifies the interface
39473 example: __VLAN-INTERFACE__
39474 - name: l3-interface-ipv4-address
39476 description: IP address
39479 example: __L3-INTERFACE-IPV4-ADDRESS__
39482 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
39485 $ref: "#/definitions/relationship"
39489 summary: delete an existing relationship
39490 description: delete an existing relationship
39491 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
39500 description: Response codes found in [response codes](https://wiki.onap.org/).
39504 description: unique name of Physical Network Function.
39507 example: __PNF-NAME__
39508 - name: interface-name
39510 description: Name that identifies the physical interface
39513 example: __INTERFACE-NAME__
39514 - name: interface-name
39516 description: Name given to the interface
39519 example: __INTERFACE-NAME__
39520 - name: vlan-interface
39522 description: String that identifies the interface
39525 example: __VLAN-INTERFACE__
39526 - name: l3-interface-ipv4-address
39528 description: IP address
39531 example: __L3-INTERFACE-IPV4-ADDRESS__
39532 /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}:
39536 summary: returns l3-interface-ipv4-address-list
39537 description: returns l3-interface-ipv4-address-list
39538 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
39544 description: successful operation
39546 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
39548 description: Response codes found in [response codes](https://wiki.onap.org/).
39552 description: unique name of Physical Network Function.
39555 example: __PNF-NAME__
39556 - name: interface-name
39558 description: Name that identifies the physical interface
39561 example: __INTERFACE-NAME__
39562 - name: interface-name
39564 description: Name given to the interface
39567 example: __INTERFACE-NAME__
39568 - name: vlan-interface
39570 description: String that identifies the interface
39573 example: __VLAN-INTERFACE__
39574 - name: l3-interface-ipv4-address
39576 description: IP address
39579 example: __L3-INTERFACE-IPV4-ADDRESS__
39583 summary: create or update an existing l3-interface-ipv4-address-list
39585 Create or update an existing l3-interface-ipv4-address-list.
39587 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39588 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
39597 description: Response codes found in [response codes](https://wiki.onap.org/).
39601 description: unique name of Physical Network Function.
39604 example: __PNF-NAME__
39605 - name: interface-name
39607 description: Name that identifies the physical interface
39610 example: __INTERFACE-NAME__
39611 - name: interface-name
39613 description: Name given to the interface
39616 example: __INTERFACE-NAME__
39617 - name: vlan-interface
39619 description: String that identifies the interface
39622 example: __VLAN-INTERFACE__
39623 - name: l3-interface-ipv4-address
39625 description: IP address
39628 example: __L3-INTERFACE-IPV4-ADDRESS__
39631 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
39634 $ref: "#/definitions/l3-interface-ipv4-address-list"
39638 summary: update an existing l3-interface-ipv4-address-list
39640 Update an existing l3-interface-ipv4-address-list
39642 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39643 The PUT operation will entirely replace an existing object.
39644 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39646 Other differences between PUT and PATCH are:
39648 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39649 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39650 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39651 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
39660 description: Response codes found in [response codes](https://wiki.onap.org/).
39664 description: unique name of Physical Network Function.
39667 example: __PNF-NAME__
39668 - name: interface-name
39670 description: Name that identifies the physical interface
39673 example: __INTERFACE-NAME__
39674 - name: interface-name
39676 description: Name given to the interface
39679 example: __INTERFACE-NAME__
39680 - name: vlan-interface
39682 description: String that identifies the interface
39685 example: __VLAN-INTERFACE__
39686 - name: l3-interface-ipv4-address
39688 description: IP address
39691 example: __L3-INTERFACE-IPV4-ADDRESS__
39694 description: l3-interface-ipv4-address-list object that needs to be updated.
39697 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
39701 summary: delete an existing l3-interface-ipv4-address-list
39702 description: delete an existing l3-interface-ipv4-address-list
39703 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
39712 description: Response codes found in [response codes](https://wiki.onap.org/).
39716 description: unique name of Physical Network Function.
39719 example: __PNF-NAME__
39720 - name: interface-name
39722 description: Name that identifies the physical interface
39725 example: __INTERFACE-NAME__
39726 - name: interface-name
39728 description: Name given to the interface
39731 example: __INTERFACE-NAME__
39732 - name: vlan-interface
39734 description: String that identifies the interface
39737 example: __VLAN-INTERFACE__
39738 - name: l3-interface-ipv4-address
39740 description: IP address
39743 example: __L3-INTERFACE-IPV4-ADDRESS__
39744 - name: resource-version
39746 description: resource-version for concurrency
39749 /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:
39753 summary: see node definition for valid relationships
39754 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
39763 description: Response codes found in [response codes](https://wiki.onap.org/).
39767 description: unique name of Physical Network Function.
39770 example: __PNF-NAME__
39771 - name: interface-name
39773 description: Name that identifies the physical interface
39776 example: __INTERFACE-NAME__
39777 - name: interface-name
39779 description: Name given to the interface
39782 example: __INTERFACE-NAME__
39783 - name: vlan-interface
39785 description: String that identifies the interface
39788 example: __VLAN-INTERFACE__
39789 - name: l3-interface-ipv6-address
39791 description: IP address
39794 example: __L3-INTERFACE-IPV6-ADDRESS__
39797 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
39800 $ref: "#/definitions/relationship"
39804 summary: delete an existing relationship
39805 description: delete an existing relationship
39806 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
39815 description: Response codes found in [response codes](https://wiki.onap.org/).
39819 description: unique name of Physical Network Function.
39822 example: __PNF-NAME__
39823 - name: interface-name
39825 description: Name that identifies the physical interface
39828 example: __INTERFACE-NAME__
39829 - name: interface-name
39831 description: Name given to the interface
39834 example: __INTERFACE-NAME__
39835 - name: vlan-interface
39837 description: String that identifies the interface
39840 example: __VLAN-INTERFACE__
39841 - name: l3-interface-ipv6-address
39843 description: IP address
39846 example: __L3-INTERFACE-IPV6-ADDRESS__
39847 /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}:
39851 summary: returns l3-interface-ipv6-address-list
39852 description: returns l3-interface-ipv6-address-list
39853 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
39859 description: successful operation
39861 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
39863 description: Response codes found in [response codes](https://wiki.onap.org/).
39867 description: unique name of Physical Network Function.
39870 example: __PNF-NAME__
39871 - name: interface-name
39873 description: Name that identifies the physical interface
39876 example: __INTERFACE-NAME__
39877 - name: interface-name
39879 description: Name given to the interface
39882 example: __INTERFACE-NAME__
39883 - name: vlan-interface
39885 description: String that identifies the interface
39888 example: __VLAN-INTERFACE__
39889 - name: l3-interface-ipv6-address
39891 description: IP address
39894 example: __L3-INTERFACE-IPV6-ADDRESS__
39898 summary: create or update an existing l3-interface-ipv6-address-list
39900 Create or update an existing l3-interface-ipv6-address-list.
39902 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39903 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
39912 description: Response codes found in [response codes](https://wiki.onap.org/).
39916 description: unique name of Physical Network Function.
39919 example: __PNF-NAME__
39920 - name: interface-name
39922 description: Name that identifies the physical interface
39925 example: __INTERFACE-NAME__
39926 - name: interface-name
39928 description: Name given to the interface
39931 example: __INTERFACE-NAME__
39932 - name: vlan-interface
39934 description: String that identifies the interface
39937 example: __VLAN-INTERFACE__
39938 - name: l3-interface-ipv6-address
39940 description: IP address
39943 example: __L3-INTERFACE-IPV6-ADDRESS__
39946 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
39949 $ref: "#/definitions/l3-interface-ipv6-address-list"
39953 summary: update an existing l3-interface-ipv6-address-list
39955 Update an existing l3-interface-ipv6-address-list
39957 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39958 The PUT operation will entirely replace an existing object.
39959 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39961 Other differences between PUT and PATCH are:
39963 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39964 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39965 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39966 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
39975 description: Response codes found in [response codes](https://wiki.onap.org/).
39979 description: unique name of Physical Network Function.
39982 example: __PNF-NAME__
39983 - name: interface-name
39985 description: Name that identifies the physical interface
39988 example: __INTERFACE-NAME__
39989 - name: interface-name
39991 description: Name given to the interface
39994 example: __INTERFACE-NAME__
39995 - name: vlan-interface
39997 description: String that identifies the interface
40000 example: __VLAN-INTERFACE__
40001 - name: l3-interface-ipv6-address
40003 description: IP address
40006 example: __L3-INTERFACE-IPV6-ADDRESS__
40009 description: l3-interface-ipv6-address-list object that needs to be updated.
40012 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
40016 summary: delete an existing l3-interface-ipv6-address-list
40017 description: delete an existing l3-interface-ipv6-address-list
40018 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
40027 description: Response codes found in [response codes](https://wiki.onap.org/).
40031 description: unique name of Physical Network Function.
40034 example: __PNF-NAME__
40035 - name: interface-name
40037 description: Name that identifies the physical interface
40040 example: __INTERFACE-NAME__
40041 - name: interface-name
40043 description: Name given to the interface
40046 example: __INTERFACE-NAME__
40047 - name: vlan-interface
40049 description: String that identifies the interface
40052 example: __VLAN-INTERFACE__
40053 - name: l3-interface-ipv6-address
40055 description: IP address
40058 example: __L3-INTERFACE-IPV6-ADDRESS__
40059 - name: resource-version
40061 description: resource-version for concurrency
40064 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
40068 summary: returns vlan
40069 description: returns vlan
40070 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
40076 description: successful operation
40078 $ref: "#/getDefinitions/vlan"
40080 description: Response codes found in [response codes](https://wiki.onap.org/).
40084 description: unique name of Physical Network Function.
40087 example: __PNF-NAME__
40088 - name: interface-name
40090 description: Name that identifies the physical interface
40093 example: __INTERFACE-NAME__
40094 - name: interface-name
40096 description: Name given to the interface
40099 example: __INTERFACE-NAME__
40100 - name: vlan-interface
40102 description: String that identifies the interface
40105 example: __VLAN-INTERFACE__
40109 summary: create or update an existing vlan
40111 Create or update an existing vlan.
40113 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40114 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
40123 description: Response codes found in [response codes](https://wiki.onap.org/).
40127 description: unique name of Physical Network Function.
40130 example: __PNF-NAME__
40131 - name: interface-name
40133 description: Name that identifies the physical interface
40136 example: __INTERFACE-NAME__
40137 - name: interface-name
40139 description: Name given to the interface
40142 example: __INTERFACE-NAME__
40143 - name: vlan-interface
40145 description: String that identifies the interface
40148 example: __VLAN-INTERFACE__
40151 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
40154 $ref: "#/definitions/vlan"
40158 summary: update an existing vlan
40160 Update an existing vlan
40162 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40163 The PUT operation will entirely replace an existing object.
40164 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40166 Other differences between PUT and PATCH are:
40168 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40169 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40170 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40171 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
40180 description: Response codes found in [response codes](https://wiki.onap.org/).
40184 description: unique name of Physical Network Function.
40187 example: __PNF-NAME__
40188 - name: interface-name
40190 description: Name that identifies the physical interface
40193 example: __INTERFACE-NAME__
40194 - name: interface-name
40196 description: Name given to the interface
40199 example: __INTERFACE-NAME__
40200 - name: vlan-interface
40202 description: String that identifies the interface
40205 example: __VLAN-INTERFACE__
40208 description: vlan object that needs to be updated.
40211 $ref: "#/patchDefinitions/vlan"
40215 summary: delete an existing vlan
40216 description: delete an existing vlan
40217 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
40226 description: Response codes found in [response codes](https://wiki.onap.org/).
40230 description: unique name of Physical Network Function.
40233 example: __PNF-NAME__
40234 - name: interface-name
40236 description: Name that identifies the physical interface
40239 example: __INTERFACE-NAME__
40240 - name: interface-name
40242 description: Name given to the interface
40245 example: __INTERFACE-NAME__
40246 - name: vlan-interface
40248 description: String that identifies the interface
40251 example: __VLAN-INTERFACE__
40252 - name: resource-version
40254 description: resource-version for concurrency
40257 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
40261 summary: returns vlans
40262 description: returns vlans
40263 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans
40269 description: successful operation
40271 $ref: "#/getDefinitions/vlans"
40273 description: Response codes found in [response codes](https://wiki.onap.org/).
40277 description: unique name of Physical Network Function.
40280 example: __PNF-NAME__
40281 - name: interface-name
40283 description: Name that identifies the physical interface
40286 example: __INTERFACE-NAME__
40287 - name: interface-name
40289 description: Name given to the interface
40292 example: __INTERFACE-NAME__
40293 - name: vlan-interface
40298 - name: vlan-id-inner
40309 /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:
40313 summary: see node definition for valid relationships
40314 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
40323 description: Response codes found in [response codes](https://wiki.onap.org/).
40327 description: unique name of Physical Network Function.
40330 example: __PNF-NAME__
40331 - name: interface-name
40333 description: Name that identifies the physical interface
40336 example: __INTERFACE-NAME__
40337 - name: interface-name
40339 description: Name given to the interface
40342 example: __INTERFACE-NAME__
40345 description: PCI ID used to identify the sriov-vf
40348 example: __PCI-ID__
40351 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
40354 $ref: "#/definitions/relationship"
40358 summary: delete an existing relationship
40359 description: delete an existing relationship
40360 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
40369 description: Response codes found in [response codes](https://wiki.onap.org/).
40373 description: unique name of Physical Network Function.
40376 example: __PNF-NAME__
40377 - name: interface-name
40379 description: Name that identifies the physical interface
40382 example: __INTERFACE-NAME__
40383 - name: interface-name
40385 description: Name given to the interface
40388 example: __INTERFACE-NAME__
40391 description: PCI ID used to identify the sriov-vf
40394 example: __PCI-ID__
40395 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
40399 summary: returns sriov-vf
40400 description: returns sriov-vf
40401 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
40407 description: successful operation
40409 $ref: "#/getDefinitions/sriov-vf"
40411 description: Response codes found in [response codes](https://wiki.onap.org/).
40415 description: unique name of Physical Network Function.
40418 example: __PNF-NAME__
40419 - name: interface-name
40421 description: Name that identifies the physical interface
40424 example: __INTERFACE-NAME__
40425 - name: interface-name
40427 description: Name given to the interface
40430 example: __INTERFACE-NAME__
40433 description: PCI ID used to identify the sriov-vf
40436 example: __PCI-ID__
40440 summary: create or update an existing sriov-vf
40442 Create or update an existing sriov-vf.
40444 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40445 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
40454 description: Response codes found in [response codes](https://wiki.onap.org/).
40458 description: unique name of Physical Network Function.
40461 example: __PNF-NAME__
40462 - name: interface-name
40464 description: Name that identifies the physical interface
40467 example: __INTERFACE-NAME__
40468 - name: interface-name
40470 description: Name given to the interface
40473 example: __INTERFACE-NAME__
40476 description: PCI ID used to identify the sriov-vf
40479 example: __PCI-ID__
40482 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
40485 $ref: "#/definitions/sriov-vf"
40489 summary: update an existing sriov-vf
40491 Update an existing sriov-vf
40493 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40494 The PUT operation will entirely replace an existing object.
40495 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40497 Other differences between PUT and PATCH are:
40499 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40500 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40501 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40502 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
40511 description: Response codes found in [response codes](https://wiki.onap.org/).
40515 description: unique name of Physical Network Function.
40518 example: __PNF-NAME__
40519 - name: interface-name
40521 description: Name that identifies the physical interface
40524 example: __INTERFACE-NAME__
40525 - name: interface-name
40527 description: Name given to the interface
40530 example: __INTERFACE-NAME__
40533 description: PCI ID used to identify the sriov-vf
40536 example: __PCI-ID__
40539 description: sriov-vf object that needs to be updated.
40542 $ref: "#/patchDefinitions/sriov-vf"
40546 summary: delete an existing sriov-vf
40547 description: delete an existing sriov-vf
40548 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
40557 description: Response codes found in [response codes](https://wiki.onap.org/).
40561 description: unique name of Physical Network Function.
40564 example: __PNF-NAME__
40565 - name: interface-name
40567 description: Name that identifies the physical interface
40570 example: __INTERFACE-NAME__
40571 - name: interface-name
40573 description: Name given to the interface
40576 example: __INTERFACE-NAME__
40579 description: PCI ID used to identify the sriov-vf
40582 example: __PCI-ID__
40583 - name: resource-version
40585 description: resource-version for concurrency
40588 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
40592 summary: returns sriov-vfs
40593 description: returns sriov-vfs
40594 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
40600 description: successful operation
40602 $ref: "#/getDefinitions/sriov-vfs"
40604 description: Response codes found in [response codes](https://wiki.onap.org/).
40608 description: unique name of Physical Network Function.
40611 example: __PNF-NAME__
40612 - name: interface-name
40614 description: Name that identifies the physical interface
40617 example: __INTERFACE-NAME__
40618 - name: interface-name
40620 description: Name given to the interface
40623 example: __INTERFACE-NAME__
40629 - name: vf-vlan-filter
40634 - name: vf-mac-filter
40639 - name: vf-vlan-strip
40644 - name: neutron-network-id
40649 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
40653 summary: see node definition for valid relationships
40654 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
40663 description: Response codes found in [response codes](https://wiki.onap.org/).
40667 description: unique name of Physical Network Function.
40670 example: __PNF-NAME__
40671 - name: interface-name
40673 description: Name that identifies the physical interface
40676 example: __INTERFACE-NAME__
40677 - name: interface-name
40679 description: Name given to the interface
40682 example: __INTERFACE-NAME__
40685 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
40688 $ref: "#/definitions/relationship"
40692 summary: delete an existing relationship
40693 description: delete an existing relationship
40694 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
40703 description: Response codes found in [response codes](https://wiki.onap.org/).
40707 description: unique name of Physical Network Function.
40710 example: __PNF-NAME__
40711 - name: interface-name
40713 description: Name that identifies the physical interface
40716 example: __INTERFACE-NAME__
40717 - name: interface-name
40719 description: Name given to the interface
40722 example: __INTERFACE-NAME__
40723 /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:
40727 summary: see node definition for valid relationships
40728 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
40737 description: Response codes found in [response codes](https://wiki.onap.org/).
40741 description: unique name of Physical Network Function.
40744 example: __PNF-NAME__
40745 - name: interface-name
40747 description: Name that identifies the physical interface
40750 example: __INTERFACE-NAME__
40751 - name: interface-name
40753 description: Name given to the interface
40756 example: __INTERFACE-NAME__
40757 - name: l3-interface-ipv4-address
40759 description: IP address
40762 example: __L3-INTERFACE-IPV4-ADDRESS__
40765 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
40768 $ref: "#/definitions/relationship"
40772 summary: delete an existing relationship
40773 description: delete an existing relationship
40774 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
40783 description: Response codes found in [response codes](https://wiki.onap.org/).
40787 description: unique name of Physical Network Function.
40790 example: __PNF-NAME__
40791 - name: interface-name
40793 description: Name that identifies the physical interface
40796 example: __INTERFACE-NAME__
40797 - name: interface-name
40799 description: Name given to the interface
40802 example: __INTERFACE-NAME__
40803 - name: l3-interface-ipv4-address
40805 description: IP address
40808 example: __L3-INTERFACE-IPV4-ADDRESS__
40809 /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}:
40813 summary: returns l3-interface-ipv4-address-list
40814 description: returns l3-interface-ipv4-address-list
40815 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
40821 description: successful operation
40823 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
40825 description: Response codes found in [response codes](https://wiki.onap.org/).
40829 description: unique name of Physical Network Function.
40832 example: __PNF-NAME__
40833 - name: interface-name
40835 description: Name that identifies the physical interface
40838 example: __INTERFACE-NAME__
40839 - name: interface-name
40841 description: Name given to the interface
40844 example: __INTERFACE-NAME__
40845 - name: l3-interface-ipv4-address
40847 description: IP address
40850 example: __L3-INTERFACE-IPV4-ADDRESS__
40854 summary: create or update an existing l3-interface-ipv4-address-list
40856 Create or update an existing l3-interface-ipv4-address-list.
40858 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40859 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
40868 description: Response codes found in [response codes](https://wiki.onap.org/).
40872 description: unique name of Physical Network Function.
40875 example: __PNF-NAME__
40876 - name: interface-name
40878 description: Name that identifies the physical interface
40881 example: __INTERFACE-NAME__
40882 - name: interface-name
40884 description: Name given to the interface
40887 example: __INTERFACE-NAME__
40888 - name: l3-interface-ipv4-address
40890 description: IP address
40893 example: __L3-INTERFACE-IPV4-ADDRESS__
40896 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
40899 $ref: "#/definitions/l3-interface-ipv4-address-list"
40903 summary: update an existing l3-interface-ipv4-address-list
40905 Update an existing l3-interface-ipv4-address-list
40907 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40908 The PUT operation will entirely replace an existing object.
40909 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40911 Other differences between PUT and PATCH are:
40913 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40914 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40915 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40916 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
40925 description: Response codes found in [response codes](https://wiki.onap.org/).
40929 description: unique name of Physical Network Function.
40932 example: __PNF-NAME__
40933 - name: interface-name
40935 description: Name that identifies the physical interface
40938 example: __INTERFACE-NAME__
40939 - name: interface-name
40941 description: Name given to the interface
40944 example: __INTERFACE-NAME__
40945 - name: l3-interface-ipv4-address
40947 description: IP address
40950 example: __L3-INTERFACE-IPV4-ADDRESS__
40953 description: l3-interface-ipv4-address-list object that needs to be updated.
40956 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
40960 summary: delete an existing l3-interface-ipv4-address-list
40961 description: delete an existing l3-interface-ipv4-address-list
40962 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
40971 description: Response codes found in [response codes](https://wiki.onap.org/).
40975 description: unique name of Physical Network Function.
40978 example: __PNF-NAME__
40979 - name: interface-name
40981 description: Name that identifies the physical interface
40984 example: __INTERFACE-NAME__
40985 - name: interface-name
40987 description: Name given to the interface
40990 example: __INTERFACE-NAME__
40991 - name: l3-interface-ipv4-address
40993 description: IP address
40996 example: __L3-INTERFACE-IPV4-ADDRESS__
40997 - name: resource-version
40999 description: resource-version for concurrency
41002 /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:
41006 summary: see node definition for valid relationships
41007 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
41016 description: Response codes found in [response codes](https://wiki.onap.org/).
41020 description: unique name of Physical Network Function.
41023 example: __PNF-NAME__
41024 - name: interface-name
41026 description: Name that identifies the physical interface
41029 example: __INTERFACE-NAME__
41030 - name: interface-name
41032 description: Name given to the interface
41035 example: __INTERFACE-NAME__
41036 - name: l3-interface-ipv6-address
41038 description: IP address
41041 example: __L3-INTERFACE-IPV6-ADDRESS__
41044 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
41047 $ref: "#/definitions/relationship"
41051 summary: delete an existing relationship
41052 description: delete an existing relationship
41053 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
41062 description: Response codes found in [response codes](https://wiki.onap.org/).
41066 description: unique name of Physical Network Function.
41069 example: __PNF-NAME__
41070 - name: interface-name
41072 description: Name that identifies the physical interface
41075 example: __INTERFACE-NAME__
41076 - name: interface-name
41078 description: Name given to the interface
41081 example: __INTERFACE-NAME__
41082 - name: l3-interface-ipv6-address
41084 description: IP address
41087 example: __L3-INTERFACE-IPV6-ADDRESS__
41088 /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}:
41092 summary: returns l3-interface-ipv6-address-list
41093 description: returns l3-interface-ipv6-address-list
41094 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
41100 description: successful operation
41102 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
41104 description: Response codes found in [response codes](https://wiki.onap.org/).
41108 description: unique name of Physical Network Function.
41111 example: __PNF-NAME__
41112 - name: interface-name
41114 description: Name that identifies the physical interface
41117 example: __INTERFACE-NAME__
41118 - name: interface-name
41120 description: Name given to the interface
41123 example: __INTERFACE-NAME__
41124 - name: l3-interface-ipv6-address
41126 description: IP address
41129 example: __L3-INTERFACE-IPV6-ADDRESS__
41133 summary: create or update an existing l3-interface-ipv6-address-list
41135 Create or update an existing l3-interface-ipv6-address-list.
41137 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
41138 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
41147 description: Response codes found in [response codes](https://wiki.onap.org/).
41151 description: unique name of Physical Network Function.
41154 example: __PNF-NAME__
41155 - name: interface-name
41157 description: Name that identifies the physical interface
41160 example: __INTERFACE-NAME__
41161 - name: interface-name
41163 description: Name given to the interface
41166 example: __INTERFACE-NAME__
41167 - name: l3-interface-ipv6-address
41169 description: IP address
41172 example: __L3-INTERFACE-IPV6-ADDRESS__
41175 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
41178 $ref: "#/definitions/l3-interface-ipv6-address-list"
41182 summary: update an existing l3-interface-ipv6-address-list
41184 Update an existing l3-interface-ipv6-address-list
41186 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41187 The PUT operation will entirely replace an existing object.
41188 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
41190 Other differences between PUT and PATCH are:
41192 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
41193 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41194 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41195 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
41204 description: Response codes found in [response codes](https://wiki.onap.org/).
41208 description: unique name of Physical Network Function.
41211 example: __PNF-NAME__
41212 - name: interface-name
41214 description: Name that identifies the physical interface
41217 example: __INTERFACE-NAME__
41218 - name: interface-name
41220 description: Name given to the interface
41223 example: __INTERFACE-NAME__
41224 - name: l3-interface-ipv6-address
41226 description: IP address
41229 example: __L3-INTERFACE-IPV6-ADDRESS__
41232 description: l3-interface-ipv6-address-list object that needs to be updated.
41235 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
41239 summary: delete an existing l3-interface-ipv6-address-list
41240 description: delete an existing l3-interface-ipv6-address-list
41241 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
41250 description: Response codes found in [response codes](https://wiki.onap.org/).
41254 description: unique name of Physical Network Function.
41257 example: __PNF-NAME__
41258 - name: interface-name
41260 description: Name that identifies the physical interface
41263 example: __INTERFACE-NAME__
41264 - name: interface-name
41266 description: Name given to the interface
41269 example: __INTERFACE-NAME__
41270 - name: l3-interface-ipv6-address
41272 description: IP address
41275 example: __L3-INTERFACE-IPV6-ADDRESS__
41276 - name: resource-version
41278 description: resource-version for concurrency
41281 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
41285 summary: returns l-interface
41286 description: returns l-interface
41287 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
41293 description: successful operation
41295 $ref: "#/getDefinitions/l-interface"
41297 description: Response codes found in [response codes](https://wiki.onap.org/).
41301 description: unique name of Physical Network Function.
41304 example: __PNF-NAME__
41305 - name: interface-name
41307 description: Name that identifies the physical interface
41310 example: __INTERFACE-NAME__
41311 - name: interface-name
41313 description: Name given to the interface
41316 example: __INTERFACE-NAME__
41320 summary: create or update an existing l-interface
41322 Create or update an existing l-interface.
41324 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
41325 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
41334 description: Response codes found in [response codes](https://wiki.onap.org/).
41338 description: unique name of Physical Network Function.
41341 example: __PNF-NAME__
41342 - name: interface-name
41344 description: Name that identifies the physical interface
41347 example: __INTERFACE-NAME__
41348 - name: interface-name
41350 description: Name given to the interface
41353 example: __INTERFACE-NAME__
41356 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
41359 $ref: "#/definitions/l-interface"
41363 summary: update an existing l-interface
41365 Update an existing l-interface
41367 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41368 The PUT operation will entirely replace an existing object.
41369 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
41371 Other differences between PUT and PATCH are:
41373 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
41374 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41375 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41376 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
41385 description: Response codes found in [response codes](https://wiki.onap.org/).
41389 description: unique name of Physical Network Function.
41392 example: __PNF-NAME__
41393 - name: interface-name
41395 description: Name that identifies the physical interface
41398 example: __INTERFACE-NAME__
41399 - name: interface-name
41401 description: Name given to the interface
41404 example: __INTERFACE-NAME__
41407 description: l-interface object that needs to be updated.
41410 $ref: "#/patchDefinitions/l-interface"
41414 summary: delete an existing l-interface
41415 description: delete an existing l-interface
41416 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
41425 description: Response codes found in [response codes](https://wiki.onap.org/).
41429 description: unique name of Physical Network Function.
41432 example: __PNF-NAME__
41433 - name: interface-name
41435 description: Name that identifies the physical interface
41438 example: __INTERFACE-NAME__
41439 - name: interface-name
41441 description: Name given to the interface
41444 example: __INTERFACE-NAME__
41445 - name: resource-version
41447 description: resource-version for concurrency
41450 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
41454 summary: returns l-interfaces
41455 description: returns l-interfaces
41456 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces
41462 description: successful operation
41464 $ref: "#/getDefinitions/l-interfaces"
41466 description: Response codes found in [response codes](https://wiki.onap.org/).
41470 description: unique name of Physical Network Function.
41473 example: __PNF-NAME__
41474 - name: interface-name
41476 description: Name that identifies the physical interface
41479 example: __INTERFACE-NAME__
41480 - name: interface-name
41485 - name: interface-id
41495 - name: network-name
41500 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}:
41504 summary: returns p-interface
41505 description: returns p-interface
41506 operationId: getNetworkPnfsPnfPInterfacesPInterface
41512 description: successful operation
41514 $ref: "#/getDefinitions/p-interface"
41516 description: Response codes found in [response codes](https://wiki.onap.org/).
41520 description: unique name of Physical Network Function.
41523 example: __PNF-NAME__
41524 - name: interface-name
41526 description: Name that identifies the physical interface
41529 example: __INTERFACE-NAME__
41533 summary: create or update an existing p-interface
41535 Create or update an existing p-interface.
41537 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
41538 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterface
41547 description: Response codes found in [response codes](https://wiki.onap.org/).
41551 description: unique name of Physical Network Function.
41554 example: __PNF-NAME__
41555 - name: interface-name
41557 description: Name that identifies the physical interface
41560 example: __INTERFACE-NAME__
41563 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfPInterfacesPInterface.json)
41566 $ref: "#/definitions/p-interface"
41570 summary: update an existing p-interface
41572 Update an existing p-interface
41574 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41575 The PUT operation will entirely replace an existing object.
41576 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
41578 Other differences between PUT and PATCH are:
41580 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
41581 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41582 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41583 operationId: UpdateNetworkPnfsPnfPInterfacesPInterface
41592 description: Response codes found in [response codes](https://wiki.onap.org/).
41596 description: unique name of Physical Network Function.
41599 example: __PNF-NAME__
41600 - name: interface-name
41602 description: Name that identifies the physical interface
41605 example: __INTERFACE-NAME__
41608 description: p-interface object that needs to be updated.
41611 $ref: "#/patchDefinitions/p-interface"
41615 summary: delete an existing p-interface
41616 description: delete an existing p-interface
41617 operationId: deleteNetworkPnfsPnfPInterfacesPInterface
41626 description: Response codes found in [response codes](https://wiki.onap.org/).
41630 description: unique name of Physical Network Function.
41633 example: __PNF-NAME__
41634 - name: interface-name
41636 description: Name that identifies the physical interface
41639 example: __INTERFACE-NAME__
41640 - name: resource-version
41642 description: resource-version for concurrency
41645 /network/pnfs/pnf/{pnf-name}/p-interfaces:
41649 summary: returns p-interfaces
41650 description: returns p-interfaces
41651 operationId: getNetworkPnfsPnfPInterfaces
41657 description: successful operation
41659 $ref: "#/getDefinitions/p-interfaces"
41661 description: Response codes found in [response codes](https://wiki.onap.org/).
41665 description: unique name of Physical Network Function.
41668 example: __PNF-NAME__
41669 - name: interface-name
41674 - name: prov-status
41679 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
41683 summary: see node definition for valid relationships
41684 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
41693 description: Response codes found in [response codes](https://wiki.onap.org/).
41697 description: unique name of Physical Network Function.
41700 example: __PNF-NAME__
41701 - name: interface-name
41703 description: Name that identifies the link aggregate interface
41706 example: __INTERFACE-NAME__
41709 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterface.json)
41712 $ref: "#/definitions/relationship"
41716 summary: delete an existing relationship
41717 description: delete an existing relationship
41718 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
41727 description: Response codes found in [response codes](https://wiki.onap.org/).
41731 description: unique name of Physical Network Function.
41734 example: __PNF-NAME__
41735 - name: interface-name
41737 description: Name that identifies the link aggregate interface
41740 example: __INTERFACE-NAME__
41741 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
41745 summary: see node definition for valid relationships
41746 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
41755 description: Response codes found in [response codes](https://wiki.onap.org/).
41759 description: unique name of Physical Network Function.
41762 example: __PNF-NAME__
41763 - name: interface-name
41765 description: Name that identifies the link aggregate interface
41768 example: __INTERFACE-NAME__
41769 - name: interface-name
41771 description: Name given to the interface
41774 example: __INTERFACE-NAME__
41775 - name: vlan-interface
41777 description: String that identifies the interface
41780 example: __VLAN-INTERFACE__
41783 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
41786 $ref: "#/definitions/relationship"
41790 summary: delete an existing relationship
41791 description: delete an existing relationship
41792 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
41801 description: Response codes found in [response codes](https://wiki.onap.org/).
41805 description: unique name of Physical Network Function.
41808 example: __PNF-NAME__
41809 - name: interface-name
41811 description: Name that identifies the link aggregate interface
41814 example: __INTERFACE-NAME__
41815 - name: interface-name
41817 description: Name given to the interface
41820 example: __INTERFACE-NAME__
41821 - name: vlan-interface
41823 description: String that identifies the interface
41826 example: __VLAN-INTERFACE__
41827 /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:
41831 summary: see node definition for valid relationships
41832 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
41841 description: Response codes found in [response codes](https://wiki.onap.org/).
41845 description: unique name of Physical Network Function.
41848 example: __PNF-NAME__
41849 - name: interface-name
41851 description: Name that identifies the link aggregate interface
41854 example: __INTERFACE-NAME__
41855 - name: interface-name
41857 description: Name given to the interface
41860 example: __INTERFACE-NAME__
41861 - name: vlan-interface
41863 description: String that identifies the interface
41866 example: __VLAN-INTERFACE__
41867 - name: l3-interface-ipv4-address
41869 description: IP address
41872 example: __L3-INTERFACE-IPV4-ADDRESS__
41875 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
41878 $ref: "#/definitions/relationship"
41882 summary: delete an existing relationship
41883 description: delete an existing relationship
41884 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
41893 description: Response codes found in [response codes](https://wiki.onap.org/).
41897 description: unique name of Physical Network Function.
41900 example: __PNF-NAME__
41901 - name: interface-name
41903 description: Name that identifies the link aggregate interface
41906 example: __INTERFACE-NAME__
41907 - name: interface-name
41909 description: Name given to the interface
41912 example: __INTERFACE-NAME__
41913 - name: vlan-interface
41915 description: String that identifies the interface
41918 example: __VLAN-INTERFACE__
41919 - name: l3-interface-ipv4-address
41921 description: IP address
41924 example: __L3-INTERFACE-IPV4-ADDRESS__
41925 /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}:
41929 summary: returns l3-interface-ipv4-address-list
41930 description: returns l3-interface-ipv4-address-list
41931 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
41937 description: successful operation
41939 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
41941 description: Response codes found in [response codes](https://wiki.onap.org/).
41945 description: unique name of Physical Network Function.
41948 example: __PNF-NAME__
41949 - name: interface-name
41951 description: Name that identifies the link aggregate interface
41954 example: __INTERFACE-NAME__
41955 - name: interface-name
41957 description: Name given to the interface
41960 example: __INTERFACE-NAME__
41961 - name: vlan-interface
41963 description: String that identifies the interface
41966 example: __VLAN-INTERFACE__
41967 - name: l3-interface-ipv4-address
41969 description: IP address
41972 example: __L3-INTERFACE-IPV4-ADDRESS__
41976 summary: create or update an existing l3-interface-ipv4-address-list
41978 Create or update an existing l3-interface-ipv4-address-list.
41980 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
41981 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
41990 description: Response codes found in [response codes](https://wiki.onap.org/).
41994 description: unique name of Physical Network Function.
41997 example: __PNF-NAME__
41998 - name: interface-name
42000 description: Name that identifies the link aggregate interface
42003 example: __INTERFACE-NAME__
42004 - name: interface-name
42006 description: Name given to the interface
42009 example: __INTERFACE-NAME__
42010 - name: vlan-interface
42012 description: String that identifies the interface
42015 example: __VLAN-INTERFACE__
42016 - name: l3-interface-ipv4-address
42018 description: IP address
42021 example: __L3-INTERFACE-IPV4-ADDRESS__
42024 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
42027 $ref: "#/definitions/l3-interface-ipv4-address-list"
42031 summary: update an existing l3-interface-ipv4-address-list
42033 Update an existing l3-interface-ipv4-address-list
42035 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42036 The PUT operation will entirely replace an existing object.
42037 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
42039 Other differences between PUT and PATCH are:
42041 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
42042 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42043 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42044 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42053 description: Response codes found in [response codes](https://wiki.onap.org/).
42057 description: unique name of Physical Network Function.
42060 example: __PNF-NAME__
42061 - name: interface-name
42063 description: Name that identifies the link aggregate interface
42066 example: __INTERFACE-NAME__
42067 - name: interface-name
42069 description: Name given to the interface
42072 example: __INTERFACE-NAME__
42073 - name: vlan-interface
42075 description: String that identifies the interface
42078 example: __VLAN-INTERFACE__
42079 - name: l3-interface-ipv4-address
42081 description: IP address
42084 example: __L3-INTERFACE-IPV4-ADDRESS__
42087 description: l3-interface-ipv4-address-list object that needs to be updated.
42090 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
42094 summary: delete an existing l3-interface-ipv4-address-list
42095 description: delete an existing l3-interface-ipv4-address-list
42096 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42105 description: Response codes found in [response codes](https://wiki.onap.org/).
42109 description: unique name of Physical Network Function.
42112 example: __PNF-NAME__
42113 - name: interface-name
42115 description: Name that identifies the link aggregate interface
42118 example: __INTERFACE-NAME__
42119 - name: interface-name
42121 description: Name given to the interface
42124 example: __INTERFACE-NAME__
42125 - name: vlan-interface
42127 description: String that identifies the interface
42130 example: __VLAN-INTERFACE__
42131 - name: l3-interface-ipv4-address
42133 description: IP address
42136 example: __L3-INTERFACE-IPV4-ADDRESS__
42137 - name: resource-version
42139 description: resource-version for concurrency
42142 /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:
42146 summary: see node definition for valid relationships
42147 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
42156 description: Response codes found in [response codes](https://wiki.onap.org/).
42160 description: unique name of Physical Network Function.
42163 example: __PNF-NAME__
42164 - name: interface-name
42166 description: Name that identifies the link aggregate interface
42169 example: __INTERFACE-NAME__
42170 - name: interface-name
42172 description: Name given to the interface
42175 example: __INTERFACE-NAME__
42176 - name: vlan-interface
42178 description: String that identifies the interface
42181 example: __VLAN-INTERFACE__
42182 - name: l3-interface-ipv6-address
42184 description: IP address
42187 example: __L3-INTERFACE-IPV6-ADDRESS__
42190 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
42193 $ref: "#/definitions/relationship"
42197 summary: delete an existing relationship
42198 description: delete an existing relationship
42199 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
42208 description: Response codes found in [response codes](https://wiki.onap.org/).
42212 description: unique name of Physical Network Function.
42215 example: __PNF-NAME__
42216 - name: interface-name
42218 description: Name that identifies the link aggregate interface
42221 example: __INTERFACE-NAME__
42222 - name: interface-name
42224 description: Name given to the interface
42227 example: __INTERFACE-NAME__
42228 - name: vlan-interface
42230 description: String that identifies the interface
42233 example: __VLAN-INTERFACE__
42234 - name: l3-interface-ipv6-address
42236 description: IP address
42239 example: __L3-INTERFACE-IPV6-ADDRESS__
42240 /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}:
42244 summary: returns l3-interface-ipv6-address-list
42245 description: returns l3-interface-ipv6-address-list
42246 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
42252 description: successful operation
42254 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
42256 description: Response codes found in [response codes](https://wiki.onap.org/).
42260 description: unique name of Physical Network Function.
42263 example: __PNF-NAME__
42264 - name: interface-name
42266 description: Name that identifies the link aggregate interface
42269 example: __INTERFACE-NAME__
42270 - name: interface-name
42272 description: Name given to the interface
42275 example: __INTERFACE-NAME__
42276 - name: vlan-interface
42278 description: String that identifies the interface
42281 example: __VLAN-INTERFACE__
42282 - name: l3-interface-ipv6-address
42284 description: IP address
42287 example: __L3-INTERFACE-IPV6-ADDRESS__
42291 summary: create or update an existing l3-interface-ipv6-address-list
42293 Create or update an existing l3-interface-ipv6-address-list.
42295 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
42296 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
42305 description: Response codes found in [response codes](https://wiki.onap.org/).
42309 description: unique name of Physical Network Function.
42312 example: __PNF-NAME__
42313 - name: interface-name
42315 description: Name that identifies the link aggregate interface
42318 example: __INTERFACE-NAME__
42319 - name: interface-name
42321 description: Name given to the interface
42324 example: __INTERFACE-NAME__
42325 - name: vlan-interface
42327 description: String that identifies the interface
42330 example: __VLAN-INTERFACE__
42331 - name: l3-interface-ipv6-address
42333 description: IP address
42336 example: __L3-INTERFACE-IPV6-ADDRESS__
42339 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
42342 $ref: "#/definitions/l3-interface-ipv6-address-list"
42346 summary: update an existing l3-interface-ipv6-address-list
42348 Update an existing l3-interface-ipv6-address-list
42350 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42351 The PUT operation will entirely replace an existing object.
42352 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
42354 Other differences between PUT and PATCH are:
42356 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
42357 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42358 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42359 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
42368 description: Response codes found in [response codes](https://wiki.onap.org/).
42372 description: unique name of Physical Network Function.
42375 example: __PNF-NAME__
42376 - name: interface-name
42378 description: Name that identifies the link aggregate interface
42381 example: __INTERFACE-NAME__
42382 - name: interface-name
42384 description: Name given to the interface
42387 example: __INTERFACE-NAME__
42388 - name: vlan-interface
42390 description: String that identifies the interface
42393 example: __VLAN-INTERFACE__
42394 - name: l3-interface-ipv6-address
42396 description: IP address
42399 example: __L3-INTERFACE-IPV6-ADDRESS__
42402 description: l3-interface-ipv6-address-list object that needs to be updated.
42405 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
42409 summary: delete an existing l3-interface-ipv6-address-list
42410 description: delete an existing l3-interface-ipv6-address-list
42411 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
42420 description: Response codes found in [response codes](https://wiki.onap.org/).
42424 description: unique name of Physical Network Function.
42427 example: __PNF-NAME__
42428 - name: interface-name
42430 description: Name that identifies the link aggregate interface
42433 example: __INTERFACE-NAME__
42434 - name: interface-name
42436 description: Name given to the interface
42439 example: __INTERFACE-NAME__
42440 - name: vlan-interface
42442 description: String that identifies the interface
42445 example: __VLAN-INTERFACE__
42446 - name: l3-interface-ipv6-address
42448 description: IP address
42451 example: __L3-INTERFACE-IPV6-ADDRESS__
42452 - name: resource-version
42454 description: resource-version for concurrency
42457 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
42461 summary: returns vlan
42462 description: returns vlan
42463 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
42469 description: successful operation
42471 $ref: "#/getDefinitions/vlan"
42473 description: Response codes found in [response codes](https://wiki.onap.org/).
42477 description: unique name of Physical Network Function.
42480 example: __PNF-NAME__
42481 - name: interface-name
42483 description: Name that identifies the link aggregate interface
42486 example: __INTERFACE-NAME__
42487 - name: interface-name
42489 description: Name given to the interface
42492 example: __INTERFACE-NAME__
42493 - name: vlan-interface
42495 description: String that identifies the interface
42498 example: __VLAN-INTERFACE__
42502 summary: create or update an existing vlan
42504 Create or update an existing vlan.
42506 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
42507 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
42516 description: Response codes found in [response codes](https://wiki.onap.org/).
42520 description: unique name of Physical Network Function.
42523 example: __PNF-NAME__
42524 - name: interface-name
42526 description: Name that identifies the link aggregate interface
42529 example: __INTERFACE-NAME__
42530 - name: interface-name
42532 description: Name given to the interface
42535 example: __INTERFACE-NAME__
42536 - name: vlan-interface
42538 description: String that identifies the interface
42541 example: __VLAN-INTERFACE__
42544 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
42547 $ref: "#/definitions/vlan"
42551 summary: update an existing vlan
42553 Update an existing vlan
42555 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42556 The PUT operation will entirely replace an existing object.
42557 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
42559 Other differences between PUT and PATCH are:
42561 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
42562 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42563 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42564 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
42573 description: Response codes found in [response codes](https://wiki.onap.org/).
42577 description: unique name of Physical Network Function.
42580 example: __PNF-NAME__
42581 - name: interface-name
42583 description: Name that identifies the link aggregate interface
42586 example: __INTERFACE-NAME__
42587 - name: interface-name
42589 description: Name given to the interface
42592 example: __INTERFACE-NAME__
42593 - name: vlan-interface
42595 description: String that identifies the interface
42598 example: __VLAN-INTERFACE__
42601 description: vlan object that needs to be updated.
42604 $ref: "#/patchDefinitions/vlan"
42608 summary: delete an existing vlan
42609 description: delete an existing vlan
42610 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
42619 description: Response codes found in [response codes](https://wiki.onap.org/).
42623 description: unique name of Physical Network Function.
42626 example: __PNF-NAME__
42627 - name: interface-name
42629 description: Name that identifies the link aggregate interface
42632 example: __INTERFACE-NAME__
42633 - name: interface-name
42635 description: Name given to the interface
42638 example: __INTERFACE-NAME__
42639 - name: vlan-interface
42641 description: String that identifies the interface
42644 example: __VLAN-INTERFACE__
42645 - name: resource-version
42647 description: resource-version for concurrency
42650 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
42654 summary: returns vlans
42655 description: returns vlans
42656 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
42662 description: successful operation
42664 $ref: "#/getDefinitions/vlans"
42666 description: Response codes found in [response codes](https://wiki.onap.org/).
42670 description: unique name of Physical Network Function.
42673 example: __PNF-NAME__
42674 - name: interface-name
42676 description: Name that identifies the link aggregate interface
42679 example: __INTERFACE-NAME__
42680 - name: interface-name
42682 description: Name given to the interface
42685 example: __INTERFACE-NAME__
42686 - name: vlan-interface
42691 - name: vlan-id-inner
42702 /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:
42706 summary: see node definition for valid relationships
42707 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
42716 description: Response codes found in [response codes](https://wiki.onap.org/).
42720 description: unique name of Physical Network Function.
42723 example: __PNF-NAME__
42724 - name: interface-name
42726 description: Name that identifies the link aggregate interface
42729 example: __INTERFACE-NAME__
42730 - name: interface-name
42732 description: Name given to the interface
42735 example: __INTERFACE-NAME__
42738 description: PCI ID used to identify the sriov-vf
42741 example: __PCI-ID__
42744 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
42747 $ref: "#/definitions/relationship"
42751 summary: delete an existing relationship
42752 description: delete an existing relationship
42753 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
42762 description: Response codes found in [response codes](https://wiki.onap.org/).
42766 description: unique name of Physical Network Function.
42769 example: __PNF-NAME__
42770 - name: interface-name
42772 description: Name that identifies the link aggregate interface
42775 example: __INTERFACE-NAME__
42776 - name: interface-name
42778 description: Name given to the interface
42781 example: __INTERFACE-NAME__
42784 description: PCI ID used to identify the sriov-vf
42787 example: __PCI-ID__
42788 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
42792 summary: returns sriov-vf
42793 description: returns sriov-vf
42794 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
42800 description: successful operation
42802 $ref: "#/getDefinitions/sriov-vf"
42804 description: Response codes found in [response codes](https://wiki.onap.org/).
42808 description: unique name of Physical Network Function.
42811 example: __PNF-NAME__
42812 - name: interface-name
42814 description: Name that identifies the link aggregate interface
42817 example: __INTERFACE-NAME__
42818 - name: interface-name
42820 description: Name given to the interface
42823 example: __INTERFACE-NAME__
42826 description: PCI ID used to identify the sriov-vf
42829 example: __PCI-ID__
42833 summary: create or update an existing sriov-vf
42835 Create or update an existing sriov-vf.
42837 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
42838 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
42847 description: Response codes found in [response codes](https://wiki.onap.org/).
42851 description: unique name of Physical Network Function.
42854 example: __PNF-NAME__
42855 - name: interface-name
42857 description: Name that identifies the link aggregate interface
42860 example: __INTERFACE-NAME__
42861 - name: interface-name
42863 description: Name given to the interface
42866 example: __INTERFACE-NAME__
42869 description: PCI ID used to identify the sriov-vf
42872 example: __PCI-ID__
42875 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
42878 $ref: "#/definitions/sriov-vf"
42882 summary: update an existing sriov-vf
42884 Update an existing sriov-vf
42886 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42887 The PUT operation will entirely replace an existing object.
42888 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
42890 Other differences between PUT and PATCH are:
42892 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
42893 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42894 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42895 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
42904 description: Response codes found in [response codes](https://wiki.onap.org/).
42908 description: unique name of Physical Network Function.
42911 example: __PNF-NAME__
42912 - name: interface-name
42914 description: Name that identifies the link aggregate interface
42917 example: __INTERFACE-NAME__
42918 - name: interface-name
42920 description: Name given to the interface
42923 example: __INTERFACE-NAME__
42926 description: PCI ID used to identify the sriov-vf
42929 example: __PCI-ID__
42932 description: sriov-vf object that needs to be updated.
42935 $ref: "#/patchDefinitions/sriov-vf"
42939 summary: delete an existing sriov-vf
42940 description: delete an existing sriov-vf
42941 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
42950 description: Response codes found in [response codes](https://wiki.onap.org/).
42954 description: unique name of Physical Network Function.
42957 example: __PNF-NAME__
42958 - name: interface-name
42960 description: Name that identifies the link aggregate interface
42963 example: __INTERFACE-NAME__
42964 - name: interface-name
42966 description: Name given to the interface
42969 example: __INTERFACE-NAME__
42972 description: PCI ID used to identify the sriov-vf
42975 example: __PCI-ID__
42976 - name: resource-version
42978 description: resource-version for concurrency
42981 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
42985 summary: returns sriov-vfs
42986 description: returns sriov-vfs
42987 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
42993 description: successful operation
42995 $ref: "#/getDefinitions/sriov-vfs"
42997 description: Response codes found in [response codes](https://wiki.onap.org/).
43001 description: unique name of Physical Network Function.
43004 example: __PNF-NAME__
43005 - name: interface-name
43007 description: Name that identifies the link aggregate interface
43010 example: __INTERFACE-NAME__
43011 - name: interface-name
43013 description: Name given to the interface
43016 example: __INTERFACE-NAME__
43022 - name: vf-vlan-filter
43027 - name: vf-mac-filter
43032 - name: vf-vlan-strip
43037 - name: neutron-network-id
43042 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
43046 summary: see node definition for valid relationships
43047 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
43056 description: Response codes found in [response codes](https://wiki.onap.org/).
43060 description: unique name of Physical Network Function.
43063 example: __PNF-NAME__
43064 - name: interface-name
43066 description: Name that identifies the link aggregate interface
43069 example: __INTERFACE-NAME__
43070 - name: interface-name
43072 description: Name given to the interface
43075 example: __INTERFACE-NAME__
43078 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
43081 $ref: "#/definitions/relationship"
43085 summary: delete an existing relationship
43086 description: delete an existing relationship
43087 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
43096 description: Response codes found in [response codes](https://wiki.onap.org/).
43100 description: unique name of Physical Network Function.
43103 example: __PNF-NAME__
43104 - name: interface-name
43106 description: Name that identifies the link aggregate interface
43109 example: __INTERFACE-NAME__
43110 - name: interface-name
43112 description: Name given to the interface
43115 example: __INTERFACE-NAME__
43116 /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:
43120 summary: see node definition for valid relationships
43121 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
43130 description: Response codes found in [response codes](https://wiki.onap.org/).
43134 description: unique name of Physical Network Function.
43137 example: __PNF-NAME__
43138 - name: interface-name
43140 description: Name that identifies the link aggregate interface
43143 example: __INTERFACE-NAME__
43144 - name: interface-name
43146 description: Name given to the interface
43149 example: __INTERFACE-NAME__
43150 - name: l3-interface-ipv4-address
43152 description: IP address
43155 example: __L3-INTERFACE-IPV4-ADDRESS__
43158 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
43161 $ref: "#/definitions/relationship"
43165 summary: delete an existing relationship
43166 description: delete an existing relationship
43167 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
43176 description: Response codes found in [response codes](https://wiki.onap.org/).
43180 description: unique name of Physical Network Function.
43183 example: __PNF-NAME__
43184 - name: interface-name
43186 description: Name that identifies the link aggregate interface
43189 example: __INTERFACE-NAME__
43190 - name: interface-name
43192 description: Name given to the interface
43195 example: __INTERFACE-NAME__
43196 - name: l3-interface-ipv4-address
43198 description: IP address
43201 example: __L3-INTERFACE-IPV4-ADDRESS__
43202 /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}:
43206 summary: returns l3-interface-ipv4-address-list
43207 description: returns l3-interface-ipv4-address-list
43208 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
43214 description: successful operation
43216 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
43218 description: Response codes found in [response codes](https://wiki.onap.org/).
43222 description: unique name of Physical Network Function.
43225 example: __PNF-NAME__
43226 - name: interface-name
43228 description: Name that identifies the link aggregate interface
43231 example: __INTERFACE-NAME__
43232 - name: interface-name
43234 description: Name given to the interface
43237 example: __INTERFACE-NAME__
43238 - name: l3-interface-ipv4-address
43240 description: IP address
43243 example: __L3-INTERFACE-IPV4-ADDRESS__
43247 summary: create or update an existing l3-interface-ipv4-address-list
43249 Create or update an existing l3-interface-ipv4-address-list.
43251 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
43252 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
43261 description: Response codes found in [response codes](https://wiki.onap.org/).
43265 description: unique name of Physical Network Function.
43268 example: __PNF-NAME__
43269 - name: interface-name
43271 description: Name that identifies the link aggregate interface
43274 example: __INTERFACE-NAME__
43275 - name: interface-name
43277 description: Name given to the interface
43280 example: __INTERFACE-NAME__
43281 - name: l3-interface-ipv4-address
43283 description: IP address
43286 example: __L3-INTERFACE-IPV4-ADDRESS__
43289 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
43292 $ref: "#/definitions/l3-interface-ipv4-address-list"
43296 summary: update an existing l3-interface-ipv4-address-list
43298 Update an existing l3-interface-ipv4-address-list
43300 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43301 The PUT operation will entirely replace an existing object.
43302 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
43304 Other differences between PUT and PATCH are:
43306 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
43307 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43308 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43309 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
43318 description: Response codes found in [response codes](https://wiki.onap.org/).
43322 description: unique name of Physical Network Function.
43325 example: __PNF-NAME__
43326 - name: interface-name
43328 description: Name that identifies the link aggregate interface
43331 example: __INTERFACE-NAME__
43332 - name: interface-name
43334 description: Name given to the interface
43337 example: __INTERFACE-NAME__
43338 - name: l3-interface-ipv4-address
43340 description: IP address
43343 example: __L3-INTERFACE-IPV4-ADDRESS__
43346 description: l3-interface-ipv4-address-list object that needs to be updated.
43349 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
43353 summary: delete an existing l3-interface-ipv4-address-list
43354 description: delete an existing l3-interface-ipv4-address-list
43355 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
43364 description: Response codes found in [response codes](https://wiki.onap.org/).
43368 description: unique name of Physical Network Function.
43371 example: __PNF-NAME__
43372 - name: interface-name
43374 description: Name that identifies the link aggregate interface
43377 example: __INTERFACE-NAME__
43378 - name: interface-name
43380 description: Name given to the interface
43383 example: __INTERFACE-NAME__
43384 - name: l3-interface-ipv4-address
43386 description: IP address
43389 example: __L3-INTERFACE-IPV4-ADDRESS__
43390 - name: resource-version
43392 description: resource-version for concurrency
43395 /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:
43399 summary: see node definition for valid relationships
43400 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
43409 description: Response codes found in [response codes](https://wiki.onap.org/).
43413 description: unique name of Physical Network Function.
43416 example: __PNF-NAME__
43417 - name: interface-name
43419 description: Name that identifies the link aggregate interface
43422 example: __INTERFACE-NAME__
43423 - name: interface-name
43425 description: Name given to the interface
43428 example: __INTERFACE-NAME__
43429 - name: l3-interface-ipv6-address
43431 description: IP address
43434 example: __L3-INTERFACE-IPV6-ADDRESS__
43437 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
43440 $ref: "#/definitions/relationship"
43444 summary: delete an existing relationship
43445 description: delete an existing relationship
43446 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
43455 description: Response codes found in [response codes](https://wiki.onap.org/).
43459 description: unique name of Physical Network Function.
43462 example: __PNF-NAME__
43463 - name: interface-name
43465 description: Name that identifies the link aggregate interface
43468 example: __INTERFACE-NAME__
43469 - name: interface-name
43471 description: Name given to the interface
43474 example: __INTERFACE-NAME__
43475 - name: l3-interface-ipv6-address
43477 description: IP address
43480 example: __L3-INTERFACE-IPV6-ADDRESS__
43481 /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}:
43485 summary: returns l3-interface-ipv6-address-list
43486 description: returns l3-interface-ipv6-address-list
43487 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
43493 description: successful operation
43495 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
43497 description: Response codes found in [response codes](https://wiki.onap.org/).
43501 description: unique name of Physical Network Function.
43504 example: __PNF-NAME__
43505 - name: interface-name
43507 description: Name that identifies the link aggregate interface
43510 example: __INTERFACE-NAME__
43511 - name: interface-name
43513 description: Name given to the interface
43516 example: __INTERFACE-NAME__
43517 - name: l3-interface-ipv6-address
43519 description: IP address
43522 example: __L3-INTERFACE-IPV6-ADDRESS__
43526 summary: create or update an existing l3-interface-ipv6-address-list
43528 Create or update an existing l3-interface-ipv6-address-list.
43530 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
43531 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
43540 description: Response codes found in [response codes](https://wiki.onap.org/).
43544 description: unique name of Physical Network Function.
43547 example: __PNF-NAME__
43548 - name: interface-name
43550 description: Name that identifies the link aggregate interface
43553 example: __INTERFACE-NAME__
43554 - name: interface-name
43556 description: Name given to the interface
43559 example: __INTERFACE-NAME__
43560 - name: l3-interface-ipv6-address
43562 description: IP address
43565 example: __L3-INTERFACE-IPV6-ADDRESS__
43568 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
43571 $ref: "#/definitions/l3-interface-ipv6-address-list"
43575 summary: update an existing l3-interface-ipv6-address-list
43577 Update an existing l3-interface-ipv6-address-list
43579 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43580 The PUT operation will entirely replace an existing object.
43581 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
43583 Other differences between PUT and PATCH are:
43585 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
43586 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43587 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43588 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
43597 description: Response codes found in [response codes](https://wiki.onap.org/).
43601 description: unique name of Physical Network Function.
43604 example: __PNF-NAME__
43605 - name: interface-name
43607 description: Name that identifies the link aggregate interface
43610 example: __INTERFACE-NAME__
43611 - name: interface-name
43613 description: Name given to the interface
43616 example: __INTERFACE-NAME__
43617 - name: l3-interface-ipv6-address
43619 description: IP address
43622 example: __L3-INTERFACE-IPV6-ADDRESS__
43625 description: l3-interface-ipv6-address-list object that needs to be updated.
43628 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
43632 summary: delete an existing l3-interface-ipv6-address-list
43633 description: delete an existing l3-interface-ipv6-address-list
43634 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
43643 description: Response codes found in [response codes](https://wiki.onap.org/).
43647 description: unique name of Physical Network Function.
43650 example: __PNF-NAME__
43651 - name: interface-name
43653 description: Name that identifies the link aggregate interface
43656 example: __INTERFACE-NAME__
43657 - name: interface-name
43659 description: Name given to the interface
43662 example: __INTERFACE-NAME__
43663 - name: l3-interface-ipv6-address
43665 description: IP address
43668 example: __L3-INTERFACE-IPV6-ADDRESS__
43669 - name: resource-version
43671 description: resource-version for concurrency
43674 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
43678 summary: returns l-interface
43679 description: returns l-interface
43680 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
43686 description: successful operation
43688 $ref: "#/getDefinitions/l-interface"
43690 description: Response codes found in [response codes](https://wiki.onap.org/).
43694 description: unique name of Physical Network Function.
43697 example: __PNF-NAME__
43698 - name: interface-name
43700 description: Name that identifies the link aggregate interface
43703 example: __INTERFACE-NAME__
43704 - name: interface-name
43706 description: Name given to the interface
43709 example: __INTERFACE-NAME__
43713 summary: create or update an existing l-interface
43715 Create or update an existing l-interface.
43717 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
43718 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
43727 description: Response codes found in [response codes](https://wiki.onap.org/).
43731 description: unique name of Physical Network Function.
43734 example: __PNF-NAME__
43735 - name: interface-name
43737 description: Name that identifies the link aggregate interface
43740 example: __INTERFACE-NAME__
43741 - name: interface-name
43743 description: Name given to the interface
43746 example: __INTERFACE-NAME__
43749 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
43752 $ref: "#/definitions/l-interface"
43756 summary: update an existing l-interface
43758 Update an existing l-interface
43760 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43761 The PUT operation will entirely replace an existing object.
43762 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
43764 Other differences between PUT and PATCH are:
43766 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
43767 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43768 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43769 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
43778 description: Response codes found in [response codes](https://wiki.onap.org/).
43782 description: unique name of Physical Network Function.
43785 example: __PNF-NAME__
43786 - name: interface-name
43788 description: Name that identifies the link aggregate interface
43791 example: __INTERFACE-NAME__
43792 - name: interface-name
43794 description: Name given to the interface
43797 example: __INTERFACE-NAME__
43800 description: l-interface object that needs to be updated.
43803 $ref: "#/patchDefinitions/l-interface"
43807 summary: delete an existing l-interface
43808 description: delete an existing l-interface
43809 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
43818 description: Response codes found in [response codes](https://wiki.onap.org/).
43822 description: unique name of Physical Network Function.
43825 example: __PNF-NAME__
43826 - name: interface-name
43828 description: Name that identifies the link aggregate interface
43831 example: __INTERFACE-NAME__
43832 - name: interface-name
43834 description: Name given to the interface
43837 example: __INTERFACE-NAME__
43838 - name: resource-version
43840 description: resource-version for concurrency
43843 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
43847 summary: returns l-interfaces
43848 description: returns l-interfaces
43849 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces
43855 description: successful operation
43857 $ref: "#/getDefinitions/l-interfaces"
43859 description: Response codes found in [response codes](https://wiki.onap.org/).
43863 description: unique name of Physical Network Function.
43866 example: __PNF-NAME__
43867 - name: interface-name
43869 description: Name that identifies the link aggregate interface
43872 example: __INTERFACE-NAME__
43873 - name: interface-name
43878 - name: interface-id
43888 - name: network-name
43893 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}:
43897 summary: returns lag-interface
43898 description: returns lag-interface
43899 operationId: getNetworkPnfsPnfLagInterfacesLagInterface
43905 description: successful operation
43907 $ref: "#/getDefinitions/lag-interface"
43909 description: Response codes found in [response codes](https://wiki.onap.org/).
43913 description: unique name of Physical Network Function.
43916 example: __PNF-NAME__
43917 - name: interface-name
43919 description: Name that identifies the link aggregate interface
43922 example: __INTERFACE-NAME__
43926 summary: create or update an existing lag-interface
43928 Create or update an existing lag-interface.
43930 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
43931 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface
43940 description: Response codes found in [response codes](https://wiki.onap.org/).
43944 description: unique name of Physical Network Function.
43947 example: __PNF-NAME__
43948 - name: interface-name
43950 description: Name that identifies the link aggregate interface
43953 example: __INTERFACE-NAME__
43956 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnfLagInterfacesLagInterface.json)
43959 $ref: "#/definitions/lag-interface"
43963 summary: update an existing lag-interface
43965 Update an existing lag-interface
43967 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43968 The PUT operation will entirely replace an existing object.
43969 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
43971 Other differences between PUT and PATCH are:
43973 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
43974 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43975 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43976 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterface
43985 description: Response codes found in [response codes](https://wiki.onap.org/).
43989 description: unique name of Physical Network Function.
43992 example: __PNF-NAME__
43993 - name: interface-name
43995 description: Name that identifies the link aggregate interface
43998 example: __INTERFACE-NAME__
44001 description: lag-interface object that needs to be updated.
44004 $ref: "#/patchDefinitions/lag-interface"
44008 summary: delete an existing lag-interface
44009 description: delete an existing lag-interface
44010 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface
44019 description: Response codes found in [response codes](https://wiki.onap.org/).
44023 description: unique name of Physical Network Function.
44026 example: __PNF-NAME__
44027 - name: interface-name
44029 description: Name that identifies the link aggregate interface
44032 example: __INTERFACE-NAME__
44033 - name: resource-version
44035 description: resource-version for concurrency
44038 /network/pnfs/pnf/{pnf-name}/lag-interfaces:
44042 summary: returns lag-interfaces
44043 description: returns lag-interfaces
44044 operationId: getNetworkPnfsPnfLagInterfaces
44050 description: successful operation
44052 $ref: "#/getDefinitions/lag-interfaces"
44054 description: Response codes found in [response codes](https://wiki.onap.org/).
44058 description: unique name of Physical Network Function.
44061 example: __PNF-NAME__
44062 - name: interface-name
44067 - name: interface-id
44072 - name: interface-role
44077 /network/pnfs/pnf/{pnf-name}:
44081 summary: returns pnf
44082 description: returns pnf
44083 operationId: getNetworkPnfsPnf
44089 description: successful operation
44091 $ref: "#/getDefinitions/pnf"
44093 description: Response codes found in [response codes](https://wiki.onap.org/).
44097 description: unique name of Physical Network Function.
44100 example: __PNF-NAME__
44104 summary: create or update an existing pnf
44106 Create or update an existing pnf.
44108 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
44109 operationId: createOrUpdateNetworkPnfsPnf
44118 description: Response codes found in [response codes](https://wiki.onap.org/).
44122 description: unique name of Physical Network Function.
44125 example: __PNF-NAME__
44128 description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPnfsPnf.json)
44131 $ref: "#/definitions/pnf"
44135 summary: update an existing pnf
44137 Update an existing pnf
44139 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44140 The PUT operation will entirely replace an existing object.
44141 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
44143 Other differences between PUT and PATCH are:
44145 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
44146 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44147 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44148 operationId: UpdateNetworkPnfsPnf
44157 description: Response codes found in [response codes](https://wiki.onap.org/).
44161 description: unique name of Physical Network Function.
44164 example: __PNF-NAME__
44167 description: pnf object that needs to be updated.
44170 $ref: "#/patchDefinitions/pnf"
44174 summary: delete an existing pnf
44175 description: delete an existing pnf
44176 operationId: deleteNetworkPnfsPnf
44185 description: Response codes found in [response codes](https://wiki.onap.org/).
44189 description: unique name of Physical Network Function.
44192 example: __PNF-NAME__
44193 - name: resource-version
44195 description: resource-version for concurrency
44202 summary: returns pnfs
44203 description: returns pnfs
44204 operationId: getNetworkPnfs
44210 description: successful operation
44212 $ref: "#/getDefinitions/pnfs"
44214 description: Response codes found in [response codes](https://wiki.onap.org/).
44226 /network/physical-links/physical-link/{link-name}/relationship-list/relationship:
44230 summary: see node definition for valid relationships
44231 operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
44240 description: Response codes found in [response codes](https://wiki.onap.org/).
44244 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
44247 example: __LINK-NAME__
44250 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPhysicalLinksPhysicalLink.json)
44253 $ref: "#/definitions/relationship"
44257 summary: delete an existing relationship
44258 description: delete an existing relationship
44259 operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
44268 description: Response codes found in [response codes](https://wiki.onap.org/).
44272 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
44275 example: __LINK-NAME__
44276 /network/physical-links/physical-link/{link-name}:
44280 summary: returns physical-link
44281 description: returns physical-link
44282 operationId: getNetworkPhysicalLinksPhysicalLink
44288 description: successful operation
44290 $ref: "#/getDefinitions/physical-link"
44292 description: Response codes found in [response codes](https://wiki.onap.org/).
44296 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
44299 example: __LINK-NAME__
44303 summary: create or update an existing physical-link
44305 Create or update an existing physical-link.
44307 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
44308 operationId: createOrUpdateNetworkPhysicalLinksPhysicalLink
44317 description: Response codes found in [response codes](https://wiki.onap.org/).
44321 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
44324 example: __LINK-NAME__
44327 description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkPhysicalLinksPhysicalLink.json)
44330 $ref: "#/definitions/physical-link"
44334 summary: update an existing physical-link
44336 Update an existing physical-link
44338 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44339 The PUT operation will entirely replace an existing object.
44340 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
44342 Other differences between PUT and PATCH are:
44344 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
44345 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44346 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44347 operationId: UpdateNetworkPhysicalLinksPhysicalLink
44356 description: Response codes found in [response codes](https://wiki.onap.org/).
44360 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
44363 example: __LINK-NAME__
44366 description: physical-link object that needs to be updated.
44369 $ref: "#/patchDefinitions/physical-link"
44373 summary: delete an existing physical-link
44374 description: delete an existing physical-link
44375 operationId: deleteNetworkPhysicalLinksPhysicalLink
44384 description: Response codes found in [response codes](https://wiki.onap.org/).
44388 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
44391 example: __LINK-NAME__
44392 - name: resource-version
44394 description: resource-version for concurrency
44397 /network/physical-links:
44401 summary: returns physical-links
44402 description: returns physical-links
44403 operationId: getNetworkPhysicalLinks
44409 description: successful operation
44411 $ref: "#/getDefinitions/physical-links"
44413 description: Response codes found in [response codes](https://wiki.onap.org/).
44425 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship:
44429 summary: see node definition for valid relationships
44430 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
44439 description: Response codes found in [response codes](https://wiki.onap.org/).
44441 - name: ipsec-configuration-id
44443 description: UUID of this configuration
44446 example: __IPSEC-CONFIGURATION-ID__
44449 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfiguration.json)
44452 $ref: "#/definitions/relationship"
44456 summary: delete an existing relationship
44457 description: delete an existing relationship
44458 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
44467 description: Response codes found in [response codes](https://wiki.onap.org/).
44469 - name: ipsec-configuration-id
44471 description: UUID of this configuration
44474 example: __IPSEC-CONFIGURATION-ID__
44475 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship:
44479 summary: see node definition for valid relationships
44480 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
44489 description: Response codes found in [response codes](https://wiki.onap.org/).
44491 - name: ipsec-configuration-id
44493 description: UUID of this configuration
44496 example: __IPSEC-CONFIGURATION-ID__
44497 - name: vig-address-type
44499 description: indicates whether the VIG is for AVPN or INTERNET
44502 example: __VIG-ADDRESS-TYPE__
44505 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
44508 $ref: "#/definitions/relationship"
44512 summary: delete an existing relationship
44513 description: delete an existing relationship
44514 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
44523 description: Response codes found in [response codes](https://wiki.onap.org/).
44525 - name: ipsec-configuration-id
44527 description: UUID of this configuration
44530 example: __IPSEC-CONFIGURATION-ID__
44531 - name: vig-address-type
44533 description: indicates whether the VIG is for AVPN or INTERNET
44536 example: __VIG-ADDRESS-TYPE__
44537 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}:
44541 summary: returns vig-server
44542 description: returns vig-server
44543 operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
44549 description: successful operation
44551 $ref: "#/getDefinitions/vig-server"
44553 description: Response codes found in [response codes](https://wiki.onap.org/).
44555 - name: ipsec-configuration-id
44557 description: UUID of this configuration
44560 example: __IPSEC-CONFIGURATION-ID__
44561 - name: vig-address-type
44563 description: indicates whether the VIG is for AVPN or INTERNET
44566 example: __VIG-ADDRESS-TYPE__
44570 summary: create or update an existing vig-server
44572 Create or update an existing vig-server.
44574 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
44575 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
44584 description: Response codes found in [response codes](https://wiki.onap.org/).
44586 - name: ipsec-configuration-id
44588 description: UUID of this configuration
44591 example: __IPSEC-CONFIGURATION-ID__
44592 - name: vig-address-type
44594 description: indicates whether the VIG is for AVPN or INTERNET
44597 example: __VIG-ADDRESS-TYPE__
44600 description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
44603 $ref: "#/definitions/vig-server"
44607 summary: update an existing vig-server
44609 Update an existing vig-server
44611 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44612 The PUT operation will entirely replace an existing object.
44613 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
44615 Other differences between PUT and PATCH are:
44617 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
44618 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44619 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44620 operationId: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
44629 description: Response codes found in [response codes](https://wiki.onap.org/).
44631 - name: ipsec-configuration-id
44633 description: UUID of this configuration
44636 example: __IPSEC-CONFIGURATION-ID__
44637 - name: vig-address-type
44639 description: indicates whether the VIG is for AVPN or INTERNET
44642 example: __VIG-ADDRESS-TYPE__
44645 description: vig-server object that needs to be updated.
44648 $ref: "#/patchDefinitions/vig-server"
44652 summary: delete an existing vig-server
44653 description: delete an existing vig-server
44654 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
44663 description: Response codes found in [response codes](https://wiki.onap.org/).
44665 - name: ipsec-configuration-id
44667 description: UUID of this configuration
44670 example: __IPSEC-CONFIGURATION-ID__
44671 - name: vig-address-type
44673 description: indicates whether the VIG is for AVPN or INTERNET
44676 example: __VIG-ADDRESS-TYPE__
44677 - name: resource-version
44679 description: resource-version for concurrency
44682 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers:
44686 summary: returns vig-servers
44687 description: returns vig-servers
44688 operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers
44694 description: successful operation
44696 $ref: "#/getDefinitions/vig-servers"
44698 description: Response codes found in [response codes](https://wiki.onap.org/).
44700 - name: ipsec-configuration-id
44702 description: UUID of this configuration
44705 example: __IPSEC-CONFIGURATION-ID__
44706 - name: vig-address-type
44711 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}:
44715 summary: returns ipsec-configuration
44716 description: returns ipsec-configuration
44717 operationId: getNetworkIpsecConfigurationsIpsecConfiguration
44723 description: successful operation
44725 $ref: "#/getDefinitions/ipsec-configuration"
44727 description: Response codes found in [response codes](https://wiki.onap.org/).
44729 - name: ipsec-configuration-id
44731 description: UUID of this configuration
44734 example: __IPSEC-CONFIGURATION-ID__
44738 summary: create or update an existing ipsec-configuration
44740 Create or update an existing ipsec-configuration.
44742 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
44743 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration
44752 description: Response codes found in [response codes](https://wiki.onap.org/).
44754 - name: ipsec-configuration-id
44756 description: UUID of this configuration
44759 example: __IPSEC-CONFIGURATION-ID__
44762 description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkIpsecConfigurationsIpsecConfiguration.json)
44765 $ref: "#/definitions/ipsec-configuration"
44769 summary: update an existing ipsec-configuration
44771 Update an existing ipsec-configuration
44773 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44774 The PUT operation will entirely replace an existing object.
44775 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
44777 Other differences between PUT and PATCH are:
44779 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
44780 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44781 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44782 operationId: UpdateNetworkIpsecConfigurationsIpsecConfiguration
44791 description: Response codes found in [response codes](https://wiki.onap.org/).
44793 - name: ipsec-configuration-id
44795 description: UUID of this configuration
44798 example: __IPSEC-CONFIGURATION-ID__
44801 description: ipsec-configuration object that needs to be updated.
44804 $ref: "#/patchDefinitions/ipsec-configuration"
44808 summary: delete an existing ipsec-configuration
44809 description: delete an existing ipsec-configuration
44810 operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration
44819 description: Response codes found in [response codes](https://wiki.onap.org/).
44821 - name: ipsec-configuration-id
44823 description: UUID of this configuration
44826 example: __IPSEC-CONFIGURATION-ID__
44827 - name: resource-version
44829 description: resource-version for concurrency
44832 /network/ipsec-configurations:
44836 summary: returns ipsec-configurations
44837 description: returns ipsec-configurations
44838 operationId: getNetworkIpsecConfigurations
44844 description: successful operation
44846 $ref: "#/getDefinitions/ipsec-configurations"
44848 description: Response codes found in [response codes](https://wiki.onap.org/).
44850 - name: ipsec-configuration-id
44855 /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship:
44859 summary: see node definition for valid relationships
44860 operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
44869 description: Response codes found in [response codes](https://wiki.onap.org/).
44871 - name: route-table-reference-id
44873 description: Route Table Reference id, UUID assigned to this instance.
44876 example: __ROUTE-TABLE-REFERENCE-ID__
44879 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkRouteTableReferencesRouteTableReference.json)
44882 $ref: "#/definitions/relationship"
44886 summary: delete an existing relationship
44887 description: delete an existing relationship
44888 operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
44897 description: Response codes found in [response codes](https://wiki.onap.org/).
44899 - name: route-table-reference-id
44901 description: Route Table Reference id, UUID assigned to this instance.
44904 example: __ROUTE-TABLE-REFERENCE-ID__
44905 /network/route-table-references/route-table-reference/{route-table-reference-id}:
44909 summary: returns route-table-reference
44910 description: returns route-table-reference
44911 operationId: getNetworkRouteTableReferencesRouteTableReference
44917 description: successful operation
44919 $ref: "#/getDefinitions/route-table-reference"
44921 description: Response codes found in [response codes](https://wiki.onap.org/).
44923 - name: route-table-reference-id
44925 description: Route Table Reference id, UUID assigned to this instance.
44928 example: __ROUTE-TABLE-REFERENCE-ID__
44932 summary: create or update an existing route-table-reference
44934 Create or update an existing route-table-reference.
44936 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
44937 operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference
44946 description: Response codes found in [response codes](https://wiki.onap.org/).
44948 - name: route-table-reference-id
44950 description: Route Table Reference id, UUID assigned to this instance.
44953 example: __ROUTE-TABLE-REFERENCE-ID__
44956 description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkRouteTableReferencesRouteTableReference.json)
44959 $ref: "#/definitions/route-table-reference"
44963 summary: update an existing route-table-reference
44965 Update an existing route-table-reference
44967 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44968 The PUT operation will entirely replace an existing object.
44969 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
44971 Other differences between PUT and PATCH are:
44973 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
44974 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44975 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44976 operationId: UpdateNetworkRouteTableReferencesRouteTableReference
44985 description: Response codes found in [response codes](https://wiki.onap.org/).
44987 - name: route-table-reference-id
44989 description: Route Table Reference id, UUID assigned to this instance.
44992 example: __ROUTE-TABLE-REFERENCE-ID__
44995 description: route-table-reference object that needs to be updated.
44998 $ref: "#/patchDefinitions/route-table-reference"
45002 summary: delete an existing route-table-reference
45003 description: delete an existing route-table-reference
45004 operationId: deleteNetworkRouteTableReferencesRouteTableReference
45013 description: Response codes found in [response codes](https://wiki.onap.org/).
45015 - name: route-table-reference-id
45017 description: Route Table Reference id, UUID assigned to this instance.
45020 example: __ROUTE-TABLE-REFERENCE-ID__
45021 - name: resource-version
45023 description: resource-version for concurrency
45026 /network/route-table-references:
45030 summary: returns route-table-references
45031 description: returns route-table-references
45032 operationId: getNetworkRouteTableReferences
45038 description: successful operation
45040 $ref: "#/getDefinitions/route-table-references"
45042 description: Response codes found in [response codes](https://wiki.onap.org/).
45044 - name: route-table-reference-id
45049 - name: route-table-reference-fqdn
45054 /network/instance-groups/instance-group/{id}/relationship-list/relationship:
45058 summary: see node definition for valid relationships
45059 operationId: createOrUpdateNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
45068 description: Response codes found in [response codes](https://wiki.onap.org/).
45072 description: Instance Group ID, UUID assigned to this instance.
45078 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkInstanceGroupsInstanceGroup.json)
45081 $ref: "#/definitions/relationship"
45085 summary: delete an existing relationship
45086 description: delete an existing relationship
45087 operationId: deleteNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
45096 description: Response codes found in [response codes](https://wiki.onap.org/).
45100 description: Instance Group ID, UUID assigned to this instance.
45104 /network/instance-groups/instance-group/{id}:
45108 summary: returns instance-group
45109 description: returns instance-group
45110 operationId: getNetworkInstanceGroupsInstanceGroup
45116 description: successful operation
45118 $ref: "#/getDefinitions/instance-group"
45120 description: Response codes found in [response codes](https://wiki.onap.org/).
45124 description: Instance Group ID, UUID assigned to this instance.
45131 summary: create or update an existing instance-group
45133 Create or update an existing instance-group.
45135 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
45136 operationId: createOrUpdateNetworkInstanceGroupsInstanceGroup
45145 description: Response codes found in [response codes](https://wiki.onap.org/).
45149 description: Instance Group ID, UUID assigned to this instance.
45155 description: instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkInstanceGroupsInstanceGroup.json)
45158 $ref: "#/definitions/instance-group"
45162 summary: update an existing instance-group
45164 Update an existing instance-group
45166 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45167 The PUT operation will entirely replace an existing object.
45168 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
45170 Other differences between PUT and PATCH are:
45172 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
45173 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45174 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45175 operationId: UpdateNetworkInstanceGroupsInstanceGroup
45184 description: Response codes found in [response codes](https://wiki.onap.org/).
45188 description: Instance Group ID, UUID assigned to this instance.
45194 description: instance-group object that needs to be updated.
45197 $ref: "#/patchDefinitions/instance-group"
45201 summary: delete an existing instance-group
45202 description: delete an existing instance-group
45203 operationId: deleteNetworkInstanceGroupsInstanceGroup
45212 description: Response codes found in [response codes](https://wiki.onap.org/).
45216 description: Instance Group ID, UUID assigned to this instance.
45220 - name: resource-version
45222 description: resource-version for concurrency
45225 /network/instance-groups:
45229 summary: returns instance-groups
45230 description: returns instance-groups
45231 operationId: getNetworkInstanceGroups
45237 description: successful operation
45239 $ref: "#/getDefinitions/instance-groups"
45241 description: Response codes found in [response codes](https://wiki.onap.org/).
45248 - name: description
45263 /network/zones/zone/{zone-id}/relationship-list/relationship:
45267 summary: see node definition for valid relationships
45268 operationId: createOrUpdateNetworkZonesZoneRelationshipListRelationship
45277 description: Response codes found in [response codes](https://wiki.onap.org/).
45281 description: Code assigned by AIC to the zone
45284 example: __ZONE-ID__
45287 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkZonesZone.json)
45290 $ref: "#/definitions/relationship"
45294 summary: delete an existing relationship
45295 description: delete an existing relationship
45296 operationId: deleteNetworkZonesZoneRelationshipListRelationship
45305 description: Response codes found in [response codes](https://wiki.onap.org/).
45309 description: Code assigned by AIC to the zone
45312 example: __ZONE-ID__
45313 /network/zones/zone/{zone-id}:
45317 summary: returns zone
45318 description: returns zone
45319 operationId: getNetworkZonesZone
45325 description: successful operation
45327 $ref: "#/getDefinitions/zone"
45329 description: Response codes found in [response codes](https://wiki.onap.org/).
45333 description: Code assigned by AIC to the zone
45336 example: __ZONE-ID__
45340 summary: create or update an existing zone
45342 Create or update an existing zone.
45344 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
45345 operationId: createOrUpdateNetworkZonesZone
45354 description: Response codes found in [response codes](https://wiki.onap.org/).
45358 description: Code assigned by AIC to the zone
45361 example: __ZONE-ID__
45364 description: zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkZonesZone.json)
45367 $ref: "#/definitions/zone"
45371 summary: update an existing zone
45373 Update an existing zone
45375 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45376 The PUT operation will entirely replace an existing object.
45377 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
45379 Other differences between PUT and PATCH are:
45381 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
45382 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45383 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45384 operationId: UpdateNetworkZonesZone
45393 description: Response codes found in [response codes](https://wiki.onap.org/).
45397 description: Code assigned by AIC to the zone
45400 example: __ZONE-ID__
45403 description: zone object that needs to be updated.
45406 $ref: "#/patchDefinitions/zone"
45410 summary: delete an existing zone
45411 description: delete an existing zone
45412 operationId: deleteNetworkZonesZone
45421 description: Response codes found in [response codes](https://wiki.onap.org/).
45425 description: Code assigned by AIC to the zone
45428 example: __ZONE-ID__
45429 - name: resource-version
45431 description: resource-version for concurrency
45438 summary: returns zones
45439 description: returns zones
45440 operationId: getNetworkZones
45446 description: successful operation
45448 $ref: "#/getDefinitions/zones"
45450 description: Response codes found in [response codes](https://wiki.onap.org/).
45457 - name: design-type
45462 - name: zone-context
45467 /network/configurations/configuration/{configuration-id}/relationship-list/relationship:
45471 summary: see node definition for valid relationships
45472 operationId: createOrUpdateNetworkConfigurationsConfigurationRelationshipListRelationship
45481 description: Response codes found in [response codes](https://wiki.onap.org/).
45483 - name: configuration-id
45485 description: UUID assigned to configuration.
45488 example: __CONFIGURATION-ID__
45491 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfiguration.json)
45494 $ref: "#/definitions/relationship"
45498 summary: delete an existing relationship
45499 description: delete an existing relationship
45500 operationId: deleteNetworkConfigurationsConfigurationRelationshipListRelationship
45509 description: Response codes found in [response codes](https://wiki.onap.org/).
45511 - name: configuration-id
45513 description: UUID assigned to configuration.
45516 example: __CONFIGURATION-ID__
45517 /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}:
45521 summary: returns metadatum
45522 description: returns metadatum
45523 operationId: getNetworkConfigurationsConfigurationMetadataMetadatum
45529 description: successful operation
45531 $ref: "#/getDefinitions/metadatum"
45533 description: Response codes found in [response codes](https://wiki.onap.org/).
45535 - name: configuration-id
45537 description: UUID assigned to configuration.
45540 example: __CONFIGURATION-ID__
45545 example: __METANAME__
45549 summary: create or update an existing metadatum
45551 Create or update an existing metadatum.
45553 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
45554 operationId: createOrUpdateNetworkConfigurationsConfigurationMetadataMetadatum
45563 description: Response codes found in [response codes](https://wiki.onap.org/).
45565 - name: configuration-id
45567 description: UUID assigned to configuration.
45570 example: __CONFIGURATION-ID__
45575 example: __METANAME__
45578 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationMetadataMetadatum.json)
45581 $ref: "#/definitions/metadatum"
45585 summary: update an existing metadatum
45587 Update an existing metadatum
45589 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45590 The PUT operation will entirely replace an existing object.
45591 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
45593 Other differences between PUT and PATCH are:
45595 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
45596 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45597 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45598 operationId: UpdateNetworkConfigurationsConfigurationMetadataMetadatum
45607 description: Response codes found in [response codes](https://wiki.onap.org/).
45609 - name: configuration-id
45611 description: UUID assigned to configuration.
45614 example: __CONFIGURATION-ID__
45619 example: __METANAME__
45622 description: metadatum object that needs to be updated.
45625 $ref: "#/patchDefinitions/metadatum"
45629 summary: delete an existing metadatum
45630 description: delete an existing metadatum
45631 operationId: deleteNetworkConfigurationsConfigurationMetadataMetadatum
45640 description: Response codes found in [response codes](https://wiki.onap.org/).
45642 - name: configuration-id
45644 description: UUID assigned to configuration.
45647 example: __CONFIGURATION-ID__
45652 example: __METANAME__
45653 - name: resource-version
45655 description: resource-version for concurrency
45658 /network/configurations/configuration/{configuration-id}/metadata:
45662 summary: returns metadata
45663 description: returns metadata
45664 operationId: getNetworkConfigurationsConfigurationMetadata
45670 description: successful operation
45672 $ref: "#/getDefinitions/metadata"
45674 description: Response codes found in [response codes](https://wiki.onap.org/).
45676 - name: configuration-id
45678 description: UUID assigned to configuration.
45681 example: __CONFIGURATION-ID__
45687 /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship:
45691 summary: see node definition for valid relationships
45692 operationId: createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcRelationshipListRelationship
45701 description: Response codes found in [response codes](https://wiki.onap.org/).
45703 - name: configuration-id
45705 description: UUID assigned to configuration.
45708 example: __CONFIGURATION-ID__
45709 - name: forwarder-evc-id
45711 description: Key for forwarder-evc object
45714 example: __FORWARDER-EVC-ID__
45717 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json)
45720 $ref: "#/definitions/relationship"
45724 summary: delete an existing relationship
45725 description: delete an existing relationship
45726 operationId: deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcRelationshipListRelationship
45735 description: Response codes found in [response codes](https://wiki.onap.org/).
45737 - name: configuration-id
45739 description: UUID assigned to configuration.
45742 example: __CONFIGURATION-ID__
45743 - name: forwarder-evc-id
45745 description: Key for forwarder-evc object
45748 example: __FORWARDER-EVC-ID__
45749 /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}:
45753 summary: returns forwarder-evc
45754 description: returns forwarder-evc
45755 operationId: getNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
45761 description: successful operation
45763 $ref: "#/getDefinitions/forwarder-evc"
45765 description: Response codes found in [response codes](https://wiki.onap.org/).
45767 - name: configuration-id
45769 description: UUID assigned to configuration.
45772 example: __CONFIGURATION-ID__
45773 - name: forwarder-evc-id
45775 description: Key for forwarder-evc object
45778 example: __FORWARDER-EVC-ID__
45782 summary: create or update an existing forwarder-evc
45784 Create or update an existing forwarder-evc.
45786 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
45787 operationId: createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
45796 description: Response codes found in [response codes](https://wiki.onap.org/).
45798 - name: configuration-id
45800 description: UUID assigned to configuration.
45803 example: __CONFIGURATION-ID__
45804 - name: forwarder-evc-id
45806 description: Key for forwarder-evc object
45809 example: __FORWARDER-EVC-ID__
45812 description: forwarder-evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json)
45815 $ref: "#/definitions/forwarder-evc"
45819 summary: update an existing forwarder-evc
45821 Update an existing forwarder-evc
45823 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45824 The PUT operation will entirely replace an existing object.
45825 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
45827 Other differences between PUT and PATCH are:
45829 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
45830 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45831 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45832 operationId: UpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
45841 description: Response codes found in [response codes](https://wiki.onap.org/).
45843 - name: configuration-id
45845 description: UUID assigned to configuration.
45848 example: __CONFIGURATION-ID__
45849 - name: forwarder-evc-id
45851 description: Key for forwarder-evc object
45854 example: __FORWARDER-EVC-ID__
45857 description: forwarder-evc object that needs to be updated.
45860 $ref: "#/patchDefinitions/forwarder-evc"
45864 summary: delete an existing forwarder-evc
45865 description: delete an existing forwarder-evc
45866 operationId: deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
45875 description: Response codes found in [response codes](https://wiki.onap.org/).
45877 - name: configuration-id
45879 description: UUID assigned to configuration.
45882 example: __CONFIGURATION-ID__
45883 - name: forwarder-evc-id
45885 description: Key for forwarder-evc object
45888 example: __FORWARDER-EVC-ID__
45889 - name: resource-version
45891 description: resource-version for concurrency
45894 /network/configurations/configuration/{configuration-id}/forwarder-evcs:
45898 summary: returns forwarder-evcs
45899 description: returns forwarder-evcs
45900 operationId: getNetworkConfigurationsConfigurationForwarderEvcs
45906 description: successful operation
45908 $ref: "#/getDefinitions/forwarder-evcs"
45910 description: Response codes found in [response codes](https://wiki.onap.org/).
45912 - name: configuration-id
45914 description: UUID assigned to configuration.
45917 example: __CONFIGURATION-ID__
45918 /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship:
45922 summary: see node definition for valid relationships
45923 operationId: createOrUpdateNetworkConfigurationsConfigurationEvcsEvcRelationshipListRelationship
45932 description: Response codes found in [response codes](https://wiki.onap.org/).
45934 - name: configuration-id
45936 description: UUID assigned to configuration.
45939 example: __CONFIGURATION-ID__
45942 description: Unique/key field for the evc object
45945 example: __EVC-ID__
45948 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationEvcsEvc.json)
45951 $ref: "#/definitions/relationship"
45955 summary: delete an existing relationship
45956 description: delete an existing relationship
45957 operationId: deleteNetworkConfigurationsConfigurationEvcsEvcRelationshipListRelationship
45966 description: Response codes found in [response codes](https://wiki.onap.org/).
45968 - name: configuration-id
45970 description: UUID assigned to configuration.
45973 example: __CONFIGURATION-ID__
45976 description: Unique/key field for the evc object
45979 example: __EVC-ID__
45980 /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}:
45984 summary: returns evc
45985 description: returns evc
45986 operationId: getNetworkConfigurationsConfigurationEvcsEvc
45992 description: successful operation
45994 $ref: "#/getDefinitions/evc"
45996 description: Response codes found in [response codes](https://wiki.onap.org/).
45998 - name: configuration-id
46000 description: UUID assigned to configuration.
46003 example: __CONFIGURATION-ID__
46006 description: Unique/key field for the evc object
46009 example: __EVC-ID__
46013 summary: create or update an existing evc
46015 Create or update an existing evc.
46017 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
46018 operationId: createOrUpdateNetworkConfigurationsConfigurationEvcsEvc
46027 description: Response codes found in [response codes](https://wiki.onap.org/).
46029 - name: configuration-id
46031 description: UUID assigned to configuration.
46034 example: __CONFIGURATION-ID__
46037 description: Unique/key field for the evc object
46040 example: __EVC-ID__
46043 description: evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfigurationEvcsEvc.json)
46046 $ref: "#/definitions/evc"
46050 summary: update an existing evc
46052 Update an existing evc
46054 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46055 The PUT operation will entirely replace an existing object.
46056 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
46058 Other differences between PUT and PATCH are:
46060 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
46061 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46062 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46063 operationId: UpdateNetworkConfigurationsConfigurationEvcsEvc
46072 description: Response codes found in [response codes](https://wiki.onap.org/).
46074 - name: configuration-id
46076 description: UUID assigned to configuration.
46079 example: __CONFIGURATION-ID__
46082 description: Unique/key field for the evc object
46085 example: __EVC-ID__
46088 description: evc object that needs to be updated.
46091 $ref: "#/patchDefinitions/evc"
46095 summary: delete an existing evc
46096 description: delete an existing evc
46097 operationId: deleteNetworkConfigurationsConfigurationEvcsEvc
46106 description: Response codes found in [response codes](https://wiki.onap.org/).
46108 - name: configuration-id
46110 description: UUID assigned to configuration.
46113 example: __CONFIGURATION-ID__
46116 description: Unique/key field for the evc object
46119 example: __EVC-ID__
46120 - name: resource-version
46122 description: resource-version for concurrency
46125 /network/configurations/configuration/{configuration-id}/evcs:
46129 summary: returns evcs
46130 description: returns evcs
46131 operationId: getNetworkConfigurationsConfigurationEvcs
46137 description: successful operation
46139 $ref: "#/getDefinitions/evcs"
46141 description: Response codes found in [response codes](https://wiki.onap.org/).
46143 - name: configuration-id
46145 description: UUID assigned to configuration.
46148 example: __CONFIGURATION-ID__
46149 /network/configurations/configuration/{configuration-id}:
46153 summary: returns configuration
46154 description: returns configuration
46155 operationId: getNetworkConfigurationsConfiguration
46161 description: successful operation
46163 $ref: "#/getDefinitions/configuration"
46165 description: Response codes found in [response codes](https://wiki.onap.org/).
46167 - name: configuration-id
46169 description: UUID assigned to configuration.
46172 example: __CONFIGURATION-ID__
46176 summary: create or update an existing configuration
46178 Create or update an existing configuration.
46180 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
46181 operationId: createOrUpdateNetworkConfigurationsConfiguration
46190 description: Response codes found in [response codes](https://wiki.onap.org/).
46192 - name: configuration-id
46194 description: UUID assigned to configuration.
46197 example: __CONFIGURATION-ID__
46200 description: configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkConfigurationsConfiguration.json)
46203 $ref: "#/definitions/configuration"
46207 summary: update an existing configuration
46209 Update an existing configuration
46211 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46212 The PUT operation will entirely replace an existing object.
46213 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
46215 Other differences between PUT and PATCH are:
46217 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
46218 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46219 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46220 operationId: UpdateNetworkConfigurationsConfiguration
46229 description: Response codes found in [response codes](https://wiki.onap.org/).
46231 - name: configuration-id
46233 description: UUID assigned to configuration.
46236 example: __CONFIGURATION-ID__
46239 description: configuration object that needs to be updated.
46242 $ref: "#/patchDefinitions/configuration"
46246 summary: delete an existing configuration
46247 description: delete an existing configuration
46248 operationId: deleteNetworkConfigurationsConfiguration
46257 description: Response codes found in [response codes](https://wiki.onap.org/).
46259 - name: configuration-id
46261 description: UUID assigned to configuration.
46264 example: __CONFIGURATION-ID__
46265 - name: resource-version
46267 description: resource-version for concurrency
46270 /network/configurations:
46274 summary: returns configurations
46275 description: returns configurations
46276 operationId: getNetworkConfigurations
46282 description: successful operation
46284 $ref: "#/getDefinitions/configurations"
46286 description: Response codes found in [response codes](https://wiki.onap.org/).
46288 - name: configuration-id
46293 - name: model-invariant-id
46298 - name: model-version-id
46303 /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship:
46307 summary: see node definition for valid relationships
46308 operationId: createOrUpdateNetworkForwardingPathsForwardingPathRelationshipListRelationship
46317 description: Response codes found in [response codes](https://wiki.onap.org/).
46319 - name: forwarding-path-id
46321 description: Unique ID of this FP
46324 example: __FORWARDING-PATH-ID__
46327 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPath.json)
46330 $ref: "#/definitions/relationship"
46334 summary: delete an existing relationship
46335 description: delete an existing relationship
46336 operationId: deleteNetworkForwardingPathsForwardingPathRelationshipListRelationship
46345 description: Response codes found in [response codes](https://wiki.onap.org/).
46347 - name: forwarding-path-id
46349 description: Unique ID of this FP
46352 example: __FORWARDING-PATH-ID__
46353 /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship:
46357 summary: see node definition for valid relationships
46358 operationId: createOrUpdateNetworkForwardingPathsForwardingPathForwardersForwarderRelationshipListRelationship
46367 description: Response codes found in [response codes](https://wiki.onap.org/).
46369 - name: forwarding-path-id
46371 description: Unique ID of this FP
46374 example: __FORWARDING-PATH-ID__
46377 description: Unique ID of this segmentation
46381 example: __SEQUENCE__
46384 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPathForwardersForwarder.json)
46387 $ref: "#/definitions/relationship"
46391 summary: delete an existing relationship
46392 description: delete an existing relationship
46393 operationId: deleteNetworkForwardingPathsForwardingPathForwardersForwarderRelationshipListRelationship
46402 description: Response codes found in [response codes](https://wiki.onap.org/).
46404 - name: forwarding-path-id
46406 description: Unique ID of this FP
46409 example: __FORWARDING-PATH-ID__
46412 description: Unique ID of this segmentation
46416 example: __SEQUENCE__
46417 /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}:
46421 summary: returns forwarder
46422 description: returns forwarder
46423 operationId: getNetworkForwardingPathsForwardingPathForwardersForwarder
46429 description: successful operation
46431 $ref: "#/getDefinitions/forwarder"
46433 description: Response codes found in [response codes](https://wiki.onap.org/).
46435 - name: forwarding-path-id
46437 description: Unique ID of this FP
46440 example: __FORWARDING-PATH-ID__
46443 description: Unique ID of this segmentation
46447 example: __SEQUENCE__
46451 summary: create or update an existing forwarder
46453 Create or update an existing forwarder.
46455 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
46456 operationId: createOrUpdateNetworkForwardingPathsForwardingPathForwardersForwarder
46465 description: Response codes found in [response codes](https://wiki.onap.org/).
46467 - name: forwarding-path-id
46469 description: Unique ID of this FP
46472 example: __FORWARDING-PATH-ID__
46475 description: Unique ID of this segmentation
46479 example: __SEQUENCE__
46482 description: forwarder object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPathForwardersForwarder.json)
46485 $ref: "#/definitions/forwarder"
46489 summary: update an existing forwarder
46491 Update an existing forwarder
46493 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46494 The PUT operation will entirely replace an existing object.
46495 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
46497 Other differences between PUT and PATCH are:
46499 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
46500 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46501 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46502 operationId: UpdateNetworkForwardingPathsForwardingPathForwardersForwarder
46511 description: Response codes found in [response codes](https://wiki.onap.org/).
46513 - name: forwarding-path-id
46515 description: Unique ID of this FP
46518 example: __FORWARDING-PATH-ID__
46521 description: Unique ID of this segmentation
46525 example: __SEQUENCE__
46528 description: forwarder object that needs to be updated.
46531 $ref: "#/patchDefinitions/forwarder"
46535 summary: delete an existing forwarder
46536 description: delete an existing forwarder
46537 operationId: deleteNetworkForwardingPathsForwardingPathForwardersForwarder
46546 description: Response codes found in [response codes](https://wiki.onap.org/).
46548 - name: forwarding-path-id
46550 description: Unique ID of this FP
46553 example: __FORWARDING-PATH-ID__
46556 description: Unique ID of this segmentation
46560 example: __SEQUENCE__
46561 - name: resource-version
46563 description: resource-version for concurrency
46566 /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders:
46570 summary: returns forwarders
46571 description: returns forwarders
46572 operationId: getNetworkForwardingPathsForwardingPathForwarders
46578 description: successful operation
46580 $ref: "#/getDefinitions/forwarders"
46582 description: Response codes found in [response codes](https://wiki.onap.org/).
46584 - name: forwarding-path-id
46586 description: Unique ID of this FP
46589 example: __FORWARDING-PATH-ID__
46596 /network/forwarding-paths/forwarding-path/{forwarding-path-id}:
46600 summary: returns forwarding-path
46601 description: returns forwarding-path
46602 operationId: getNetworkForwardingPathsForwardingPath
46608 description: successful operation
46610 $ref: "#/getDefinitions/forwarding-path"
46612 description: Response codes found in [response codes](https://wiki.onap.org/).
46614 - name: forwarding-path-id
46616 description: Unique ID of this FP
46619 example: __FORWARDING-PATH-ID__
46623 summary: create or update an existing forwarding-path
46625 Create or update an existing forwarding-path.
46627 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
46628 operationId: createOrUpdateNetworkForwardingPathsForwardingPath
46637 description: Response codes found in [response codes](https://wiki.onap.org/).
46639 - name: forwarding-path-id
46641 description: Unique ID of this FP
46644 example: __FORWARDING-PATH-ID__
46647 description: forwarding-path object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v13/NetworkForwardingPathsForwardingPath.json)
46650 $ref: "#/definitions/forwarding-path"
46654 summary: update an existing forwarding-path
46656 Update an existing forwarding-path
46658 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46659 The PUT operation will entirely replace an existing object.
46660 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
46662 Other differences between PUT and PATCH are:
46664 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
46665 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46666 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46667 operationId: UpdateNetworkForwardingPathsForwardingPath
46676 description: Response codes found in [response codes](https://wiki.onap.org/).
46678 - name: forwarding-path-id
46680 description: Unique ID of this FP
46683 example: __FORWARDING-PATH-ID__
46686 description: forwarding-path object that needs to be updated.
46689 $ref: "#/patchDefinitions/forwarding-path"
46693 summary: delete an existing forwarding-path
46694 description: delete an existing forwarding-path
46695 operationId: deleteNetworkForwardingPathsForwardingPath
46704 description: Response codes found in [response codes](https://wiki.onap.org/).
46706 - name: forwarding-path-id
46708 description: Unique ID of this FP
46711 example: __FORWARDING-PATH-ID__
46712 - name: resource-version
46714 description: resource-version for concurrency
46717 /network/forwarding-paths:
46721 summary: returns forwarding-paths
46722 description: returns forwarding-paths
46723 operationId: getNetworkForwardingPaths
46729 description: successful operation
46731 $ref: "#/getDefinitions/forwarding-paths"
46733 description: Response codes found in [response codes](https://wiki.onap.org/).
46735 - name: forwarding-path-id
46740 - name: forwarding-path-name
46753 $ref: "#/definitions/action-data"
46762 APIs that are more action related than REST (e.g., notify, update).
46766 $ref: "#/definitions/update"
46769 $ref: "#/definitions/notify"
46772 Represents a slice or partial piece of a resource that gets separately allotted
46773 ###### Related Nodes
46774 - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
46775 - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
46776 - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
46777 - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
46778 - TO l-interface( allotted-resource Uses l-interface, ONE2MANY)
46779 - TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
46780 - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
46781 - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY)
46782 - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
46783 - TO model-ver( allotted-resource IsA model-ver, Many2One)
46784 - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
46785 - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3)
46786 - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
46787 - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
46789 -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
46790 -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also
46791 -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
46797 description: Allotted Resource id UUID assigned to this instance.
46800 description: The descriptive information assigned to this allotted resource instance
46803 description: Link back to more information in the controller
46804 model-invariant-id:
46806 description: the ASDC model id for this resource or service model.
46809 description: the ASDC model version for this resource or service model.
46810 persona-model-version:
46812 description: the ASDC model version for this resource or service model.
46815 description: Concurrency value
46816 orchestration-status:
46818 description: Orchestration status
46819 operational-status:
46821 description: Indicator for whether the resource is considered operational
46824 description: Generic description of the type of allotted resource.
46827 description: role in the network that this resource will be providing.
46831 $ref: "#/definitions/tunnel-xconnect"
46835 $ref: "#/definitions/relationship"
46836 allotted-resources:
46838 This object is used to store slices of services being offered
46843 $ref: "#/definitions/allotted-resource"
46846 Availability zone, a collection of compute hosts/pservers
46847 ###### Related Nodes
46848 - TO complex( availability-zone LocatedIn complex, MANY2ONE)
46849 - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
46850 - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
46851 - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
46852 - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
46853 - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
46854 - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
46855 - FROM vce( vce Uses availability-zone, MANY2MANY)
46857 -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
46858 -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
46861 - availability-zone-name
46864 availability-zone-name:
46866 description: Name of the availability zone. Unique across a cloud region
46869 description: Type of hypervisor. Source of truth should define valid values.
46870 operational-status:
46872 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
46875 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46879 $ref: "#/definitions/relationship"
46880 availability-zones:
46882 Collection of availability zones
46887 $ref: "#/definitions/availability-zone"
46888 az-and-dvs-switches:
46892 $ref: "#/definitions/dvs-switches"
46895 $ref: "#/definitions/availability-zone"
46898 Namespace for business related constructs
46903 $ref: "#/definitions/connector"
46907 $ref: "#/definitions/customer"
46911 $ref: "#/definitions/line-of-business"
46915 $ref: "#/definitions/owning-entity"
46919 $ref: "#/definitions/platform"
46923 $ref: "#/definitions/project"
46926 ###### Related Nodes
46927 - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
46929 -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
46935 description: unique identifier of probe
46938 description: identifier of probe
46941 description: type of probe
46944 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46948 $ref: "#/definitions/relationship"
46949 classes-of-service:
46951 class-of-service of probe
46956 $ref: "#/definitions/class-of-service"
46957 cloud-infrastructure:
46959 Namespace for cloud infrastructure.
46964 $ref: "#/definitions/complex"
46968 $ref: "#/definitions/cloud-region"
46972 $ref: "#/definitions/network-profile"
46976 $ref: "#/definitions/pserver"
46977 virtual-data-centers:
46980 $ref: "#/definitions/virtual-data-center"
46981 operational-environments:
46984 $ref: "#/definitions/operational-environment"
46987 cloud-region designates an installation of a cloud cluster or region or instantiation.
46988 ###### Related Nodes
46989 - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)(2)
46990 - TO complex( cloud-region LocatedIn complex, MANY2ONE)
46991 - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
46992 - TO zone( cloud-region LocatedIn zone, MANY2ONE)
46993 - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
46994 - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
46995 - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
46996 - FROM hpa-capability( hpa-capability BelongsTo cloud-region, MANY2ONE)
46997 - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
46998 - FROM image( image BelongsTo cloud-region, MANY2ONE)
46999 - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
47000 - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
47001 - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
47002 - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
47003 - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
47004 - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
47005 - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
47006 - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
47008 -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
47009 -(2) IF this CLOUD-REGION node is deleted, this TO node is DELETED also
47010 -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
47019 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
47022 description: Identifier used by the vendor for the region. Second part of composite key
47025 description: Type of the cloud (e.g., openstack)
47026 owner-defined-type:
47028 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
47029 cloud-region-version:
47031 description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
47034 description: URL of the keystone identity service
47037 description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
47040 description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
47043 description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation.
47046 description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
47049 description: MultiVIM will discover and expose EPA capabilities.
47052 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47056 $ref: "#/definitions/volume-group"
47060 $ref: "#/definitions/tenant"
47064 $ref: "#/definitions/flavor"
47068 $ref: "#/definitions/group-assignment"
47072 $ref: "#/definitions/snapshot"
47076 $ref: "#/definitions/image"
47080 $ref: "#/definitions/dvs-switch"
47084 $ref: "#/definitions/oam-network"
47085 availability-zones:
47088 $ref: "#/definitions/availability-zone"
47092 $ref: "#/definitions/relationship"
47093 vip-ipv4-address-list:
47096 $ref: "#/definitions/vip-ipv4-address-list"
47097 vip-ipv6-address-list:
47100 $ref: "#/definitions/vip-ipv6-address-list"
47104 $ref: "#/definitions/hpa-capability"
47105 description: List of cloud-region specific HPA Capabilities
47111 $ref: "#/definitions/cloud-region"
47114 Collection of physical locations that can house cloud-regions.
47115 ###### Related Nodes
47116 - TO l3-network( complex Uses l3-network, MANY2MANY)
47117 - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
47118 - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
47119 - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
47120 - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY)
47121 - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
47122 - FROM pnf( pnf LocatedIn complex, MANY2ONE)
47123 - FROM pserver( pserver LocatedIn complex, MANY2ONE)
47124 - FROM vce( vce LocatedIn complex, MANY2MANY)
47125 - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
47126 - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
47127 - FROM zone( zone LocatedIn complex, MANY2ONE)
47129 -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
47130 -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
47133 - physical-location-id
47134 - physical-location-type
47141 physical-location-id:
47143 description: Unique identifier for physical location, e.g., CLLI
47146 description: Data center code which can be an alternate way to identify a complex
47149 description: Gamma complex name for LCP instance.
47152 description: URL of the keystone identity service
47155 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47156 physical-location-type:
47158 description: Type, e.g., central office, data center.
47184 $ref: "#/definitions/ctag-pool"
47188 $ref: "#/definitions/relationship"
47191 Collection of physical locations that can house cloud-regions.
47196 $ref: "#/definitions/complex"
47199 Port Mirror Configuration.
47200 ###### Related Nodes
47201 - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
47202 - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
47203 - TO l-interface( configuration AppliesTo l-interface, ONE2MANY)
47204 - TO pnf( configuration AppliesTo pnf, ONE2MANY)
47205 - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
47206 - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
47207 - FROM service-instance( service-instance Uses configuration, ONE2MANY)
47208 - FROM forwarder( forwarder Uses configuration, ONE2ONE)(3)
47209 - FROM forwarding-path( forwarding-path Uses configuration, ONE2ONE)(3)
47210 - FROM evc( evc BelongsTo configuration, ONE2ONE)(1)
47211 - FROM forwarder-evc( forwarder-evc BelongsTo configuration, ONE2ONE)(1)
47213 -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
47214 -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
47215 -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
47218 - configuration-type
47219 - configuration-sub-type
47220 - orchestration-status
47221 - operational-status
47222 - configuration-selflink
47223 - model-customization-id
47227 description: UUID assigned to configuration.
47230 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
47231 configuration-name:
47233 description: Name of the configuration.
47234 configuration-type:
47236 description: port-mirroring-configuration.
47237 configuration-sub-type:
47239 description: vprobe, pprobe.
47240 model-invariant-id:
47242 description: the ASDC model id for this resource or service model.
47245 description: the ASDC model version for this resource or service model.
47246 orchestration-status:
47248 description: Orchestration status of the configuration.
47249 operational-status:
47251 description: Indicator for whether the resource is considered operational.
47252 configuration-selflink:
47254 description: URL to endpoint where AAI can get more details from SDN-GC.
47255 model-customization-id:
47257 description: id of the configuration used to customize the resource
47260 description: DHV Site Effective Bandwidth
47261 vendor-allowed-max-bandwidth:
47263 description: Velocloud Nominal Throughput - VNT
47266 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47270 $ref: "#/definitions/relationship"
47274 $ref: "#/definitions/metadatum"
47278 $ref: "#/definitions/forwarder-evc"
47282 $ref: "#/definitions/evc"
47285 Collection of configurations
47290 $ref: "#/definitions/configuration"
47293 Collection of resource instances used to connect a variety of disparate inventory widgets
47294 ###### Related Nodes
47295 - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
47296 - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
47297 - FROM service-instance( service-instance Uses connector, MANY2MANY)
47299 -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
47301 - resource-instance-id
47303 resource-instance-id:
47305 description: Unique id of resource instance.
47308 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47309 model-invariant-id:
47311 description: the ASDC model id for this resource or service model.
47314 description: the ASDC model version for this resource or service model.
47315 persona-model-version:
47317 description: the ASDC model version for this resource or service model.
47320 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
47321 widget-model-version:
47323 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
47327 $ref: "#/definitions/relationship"
47331 $ref: "#/definitions/metadatum"
47334 Collection of resource instances used to connect a variety of disparate inventory widgets
47339 $ref: "#/definitions/connector"
47340 constrained-element-set:
47342 This is how we would capture constraints defining allowed sets of elements.
47343 ###### Related Nodes
47344 - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
47345 - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
47346 - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
47348 -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
47349 -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
47351 - constrained-element-set-uuid
47355 constrained-element-set-uuid:
47363 element-choice-sets:
47366 $ref: "#/definitions/element-choice-set"
47370 $ref: "#/definitions/relationship"
47371 constrained-element-sets:
47373 constrained-element-set:
47376 $ref: "#/definitions/constrained-element-set"
47379 ###### Related Nodes
47380 - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
47381 - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
47383 -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
47393 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47397 $ref: "#/definitions/relationship"
47403 $ref: "#/definitions/ctag-assignment"
47406 A collection of C tags (vlan tags) grouped for a specific purpose.
47407 ###### Related Nodes
47408 - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
47409 - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
47410 - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY)
47411 - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
47413 -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
47416 - availability-zone-name
47417 - ctag-pool-purpose
47421 description: The Target provider edge router
47422 availability-zone-name:
47424 description: Name of the availability zone
47427 description: Describes what the intended purpose of this pool is.
47430 description: Comma separated list of ctags
47433 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47437 $ref: "#/definitions/relationship"
47443 $ref: "#/definitions/ctag-pool"
47446 customer identifiers to provide linkage back to BSS information.
47447 ###### Related Nodes
47448 - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
47450 -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
47452 - global-customer-id
47456 global-customer-id:
47458 description: Global customer id used across ECOMP to uniquely identify customer.
47461 description: Subscriber name, an alternate way to retrieve a customer.
47464 description: Subscriber type, a way to provide VID with only the INFRA customers.
47467 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47468 service-subscriptions:
47471 $ref: "#/definitions/service-subscription"
47475 $ref: "#/definitions/relationship"
47478 Collection of customer identifiers to provide linkage back to BSS information.
47483 $ref: "#/definitions/customer"
47491 description: See mis-na-virtualization-platform.yang
47494 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47498 $ref: "#/definitions/relationship"
47504 $ref: "#/definitions/cvlan-tag-entry"
47507 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.
47508 ###### Related Nodes
47509 - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
47510 - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
47518 description: DVS switch name
47521 description: URL used to reach the vcenter
47524 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47528 $ref: "#/definitions/relationship"
47531 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
47536 $ref: "#/definitions/dvs-switch"
47539 Internal map to define the properties of an edge and interpret the map EdgeRules
47557 edge-tag-query-request:
47568 $ref: "#/definitions/start-node-filter"
47569 include-node-filter:
47572 $ref: "#/definitions/include-node-filter"
47576 $ref: "#/definitions/secondary-filter"
47577 edge-tag-query-result:
47579 tagged-inventory-item-list:
47582 $ref: "#/definitions/tagged-inventory-item-list"
47583 element-choice-set:
47585 This is how we would capture constraints defining allowed sets of elements.
47586 ###### Related Nodes
47587 - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
47588 - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
47590 -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
47591 -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
47593 - element-choice-set-uuid
47594 - element-choice-set-name
47596 element-choice-set-uuid:
47598 element-choice-set-name:
47607 $ref: "#/definitions/model-element"
47611 $ref: "#/definitions/relationship"
47612 element-choice-sets:
47614 element-choice-set:
47617 $ref: "#/definitions/element-choice-set"
47620 Metadata for entitlement group.
47621 ###### Related Nodes
47622 - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
47623 - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
47625 -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
47632 description: Unique ID for the entitlement group the resource comes from, should be uuid.
47635 description: Unique ID of an entitlement resource.
47638 description: Concurrency value
47642 $ref: "#/definitions/relationship"
47645 Entitlements, keyed by group-uuid and resource-uuid, related to license management
47650 $ref: "#/definitions/entitlement"
47653 Persist EMS address information used by EMS driver.
47654 ###### Related Nodes
47655 - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2)
47657 -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also
47663 description: Unique ID of EMS.
47666 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47667 esr-system-info-list:
47669 $ref: "#/definitions/esr-system-info-list"
47672 $ref: "#/definitions/relationship-list"
47678 $ref: "#/definitions/esr-ems"
47681 Persist common address information of external systems.
47682 ###### Related Nodes
47683 - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3)
47684 - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3)
47685 - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3)
47686 - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3)
47688 -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also
47690 - esr-system-info-id
47695 esr-system-info-id:
47697 description: Unique ID of esr system info.
47700 description: name of external system.
47703 description: type of external systems.
47706 description: vendor of external systems.
47709 description: version of external systems.
47712 description: url used to access external systems.
47715 description: username used to access external systems.
47718 description: password used to access external systems.
47721 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
47724 description: protocol of third party SDNC, for example netconf/snmp.
47727 description: ca file content if enabled ssl on auth-url.
47730 description: Whether to verify VIM's certificate.
47733 description: service IP of ftp server.
47736 description: service port of ftp server.
47739 description: domain info for authentication.
47742 description: default tenant of VIM.
47745 description: ftp passive mode or not.
47748 description: resource or performance data file path.
47751 description: the status of external system.
47754 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47757 $ref: "#/definitions/relationship-list"
47758 esr-system-info-list:
47760 Collection of persistent block-level external system auth info.
47765 $ref: "#/definitions/esr-system-info"
47766 esr-thirdparty-sdnc:
47768 Persist SDNC address information used by ONAP SDNC.
47769 ###### Related Nodes
47770 - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2)
47771 - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
47773 -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also
47775 - thirdparty-sdnc-id
47777 thirdparty-sdnc-id:
47779 description: Unique ID of SDNC.
47782 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
47785 description: password used to access SDNC server.
47788 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47789 esr-system-info-list:
47791 $ref: "#/definitions/esr-system-info-list"
47794 $ref: "#/definitions/relationship-list"
47795 esr-thirdparty-sdnc-list:
47797 esr-thirdparty-sdnc:
47800 $ref: "#/definitions/esr-thirdparty-sdnc"
47803 Persist VNFM address information used by VF-C.
47804 ###### Related Nodes
47805 - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2)
47807 -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also
47813 description: Unique ID of VNFM.
47816 description: indecate the VIM to deploy VNF.
47819 description: certificate url of VNFM.
47822 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47823 esr-system-info-list:
47825 $ref: "#/definitions/esr-system-info-list"
47828 $ref: "#/definitions/relationship-list"
47834 $ref: "#/definitions/esr-vnfm"
47837 evc object is an optional child object of the Configuration object.
47838 ###### Related Nodes
47839 - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
47841 -(4) IF this TO node is deleted, this EVC is DELETED also
47847 description: Unique/key field for the evc object
47848 forwarding-path-topology:
47850 description: Point-to-Point, Multi-Point
47853 description: Commited Information Rate
47856 description: CIR units
47857 connection-diversity-group-id:
47859 description: Diversity Group ID
47862 description: formerly Performance Group
47863 esp-evc-circuit-id:
47865 description: EVC Circuit ID of ESP EVC
47868 description: Committed Information Rate (For ESP)
47871 description: CIR units (For ESP)
47874 description: Identifies ESP
47875 collector-pop-clli:
47877 description: Collector POP CLLI (from the hostname of the access pnf)
47878 inter-connect-type-ingress:
47880 description: Interconnect type on ingress side of EVC.
47881 tagmode-access-ingress:
47883 description: tagode for collector side of EVC
47884 tagmode-access-egress:
47886 description: tagMode for network side of EVC
47890 $ref: "#/definitions/relationship"
47893 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47899 $ref: "#/definitions/evc"
47902 Namespace for external system.
47906 $ref: "#/definitions/esr-ems-list"
47909 $ref: "#/definitions/esr-vnfm-list"
47910 esr-thirdparty-sdnc-list:
47912 $ref: "#/definitions/esr-thirdparty-sdnc-list"
47915 Extra properties for inventory item for response list
47920 $ref: "#/definitions/extra-property"
47930 ###### Related Nodes
47931 - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
47932 - FROM hpa-capability( hpa-capability BelongsTo flavor, MANY2ONE)
47933 - FROM vserver( vserver Uses flavor, MANY2ONE)
47935 -FLAVOR cannot be deleted if related to HPA-CAPABILITY,VSERVER
47944 description: Flavor id, expected to be unique across cloud-region.
47947 description: Cloud Region Flavor name
47951 description: Number of CPUs
47955 description: Amount of memory
47959 description: Disk space
47963 description: Amount of ephemeral disk space
47966 description: amount of swap space allocation
47969 description: whether flavor is available to all users or private to the tenant it was created in.
47972 description: URL to endpoint where AAI can get more details
47975 description: Boolean as to whether this flavor is no longer enabled
47979 $ref: "#/definitions/hpa-capability"
47980 description: List of flavor specific HPA Capabilities
47983 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47987 $ref: "#/definitions/relationship"
47990 Collection of openstack flavors.
47995 $ref: "#/definitions/flavor"
47998 Entity describing a sequenced segment of forwarding path
47999 ###### Related Nodes
48000 - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
48001 - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
48002 - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
48003 - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
48004 - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
48006 -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
48007 -(4) IF this TO node is deleted, this FORWARDER is DELETED also
48014 description: Unique ID of this segmentation
48017 description: ingress, intermediate, egress
48021 $ref: "#/definitions/relationship"
48024 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48027 forwarder object is an optional child object of the Configuration object.
48028 ###### Related Nodes
48029 - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
48031 -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
48037 description: Key for forwarder-evc object
48040 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
48043 description: Internal VLAN.
48046 description: SVLAN value for ingress of egress forwarder.
48049 description: CVLAN value for ingress of egress forwarder.
48053 $ref: "#/definitions/relationship"
48056 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48062 $ref: "#/definitions/forwarder-evc"
48068 $ref: "#/definitions/forwarder"
48071 Entity that describes the sequenced forwarding path between interfaces of services or resources
48072 ###### Related Nodes
48073 - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
48074 - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
48075 - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
48077 -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
48078 -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
48079 -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
48081 - forwarding-path-id
48082 - forwarding-path-name
48084 forwarding-path-id:
48086 description: Unique ID of this FP
48087 forwarding-path-name:
48089 description: Name of the FP
48093 $ref: "#/definitions/relationship"
48096 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48099 description: the self link for this FP
48103 $ref: "#/definitions/forwarder"
48109 $ref: "#/definitions/forwarding-path"
48112 General purpose VNF
48113 ###### Related Nodes
48114 - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
48115 - TO complex( generic-vnf LocatedIn complex, MANY2MANY)
48116 - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2)
48117 - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY)
48118 - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
48119 - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
48120 - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
48121 - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
48122 - TO pnf( generic-vnf HostedOn pnf, MANY2MANY)
48123 - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
48124 - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
48125 - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
48126 - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
48127 - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
48128 - TO model-ver( generic-vnf IsA model-ver, Many2One)
48129 - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
48130 - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
48131 - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
48132 - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
48133 - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
48134 - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
48135 - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
48136 - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
48137 - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
48138 - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
48139 - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY)
48140 - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
48141 - FROM platform( platform Uses generic-vnf, MANY2MANY)
48143 -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
48144 -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also
48150 - is-closed-loop-disabled
48154 description: Unique id of VNF. This is unique across the graph.
48157 description: vnf instance id.
48160 description: Name of VNF.
48163 description: Alternate name of VNF.
48166 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.
48169 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
48170 regional-resource-zone:
48172 description: Regional way of organizing pservers, source of truth should define values
48175 description: Trigger for operational monitoring of this resource by Service Assurance systems.
48176 operational-status:
48178 description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
48181 description: OBSOLETE - do not use
48184 description: Client should send valid enumerated value
48185 orchestration-status:
48187 description: Orchestration status of this VNF, used by MSO.
48190 vnf-discriptor-name:
48192 description: vnf discriptor name
48195 description: job id corresponding to vnf
48198 description: Heat stack id corresponding to this instance, managed by MSO
48201 description: Corresponds to the SDN-C catalog id used to configure this VCE
48204 description: identifier of managed by ATT or customer
48207 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
48208 ipv4-loopback0-address:
48210 description: v4 Loopback0 address
48213 description: v6 Loopback address
48214 management-v6-address:
48216 description: v6 management address
48220 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
48223 description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
48227 description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
48230 description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
48234 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
48237 description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
48241 description: number of associated SHD in vnf.
48245 description: number of vms in vnf.
48249 description: number of network in vnf.
48252 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.
48253 is-closed-loop-disabled:
48255 description: used to indicate whether closed loop function is enabled on this node
48258 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48261 description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
48262 encrypted-access-flag:
48264 description: indicates whether generic-vnf access uses SSH
48265 entitlement-assignment-group-uuid:
48267 description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships.
48268 entitlement-resource-uuid:
48270 description: UUID of the specific entitlement resource. OBSOLETE - See child relationships.
48271 license-assignment-group-uuid:
48273 description: UUID of the license assignment group. OBSOLETE - See child relationships.
48276 description: UUID of the actual license resource. OBSOLETE - See child relationships.
48277 model-invariant-id:
48279 description: the ASDC model id for this resource or service model.
48282 description: the ASDC model version for this resource or service model.
48283 persona-model-version:
48285 description: the ASDC model version for this resource or service model.
48286 model-customization-id:
48288 description: captures the id of all the configuration used to customize the resource for the service.
48291 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
48292 widget-model-version:
48294 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
48297 description: as-number of the VNF
48298 regional-resource-subzone:
48300 description: represents sub zone of the rr plane
48303 description: Generic description of the type of NF
48306 description: English description of Network function that the specific VNF deployment is providing
48309 description: role in the network that this model will be providing
48312 description: string assigned to this model used for naming purposes
48315 description: Path to the controller object.
48316 ipv4-oam-gateway-address:
48318 description: Gateway address
48319 ipv4-oam-gateway-address-prefix-length:
48322 description: Prefix length for oam-address
48326 description: Temporary location for S-TAG to get to VCE
48329 description: Network Management profile of this VNF
48333 $ref: "#/definitions/relationship"
48337 $ref: "#/definitions/l-interface"
48341 $ref: "#/definitions/lag-interface"
48345 $ref: "#/definitions/vf-module"
48349 $ref: "#/definitions/license"
48353 $ref: "#/definitions/entitlement"
48361 $ref: "#/definitions/generic-vnf"
48364 Openstack group-assignment used to store exclusivity groups (EG).
48365 ###### Related Nodes
48366 - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
48367 - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
48368 - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
48377 description: Group id, expected to be unique across cloud-region.
48380 description: Group type - the type of group this instance refers to
48383 description: Group name - name assigned to the group
48386 description: Group description - description of the group
48389 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48393 $ref: "#/definitions/relationship"
48396 Collection of openstack group assignments
48401 $ref: "#/definitions/group-assignment"
48404 ###### Related Nodes
48405 - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
48407 -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
48415 description: host-route id
48418 description: subnet prefix
48421 description: Could be ip-address, hostname, or service-instance
48424 description: Should be ip-address, hostname, or service-instance to match next-hop
48427 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48431 $ref: "#/definitions/relationship"
48437 $ref: "#/definitions/host-route"
48440 Collection of HPA Capabilities
48445 $ref: "#/definitions/hpa-capability"
48448 Represents a HPA capability
48449 ###### Related Nodes
48450 - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
48451 - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
48452 - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
48454 -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
48456 - hpa-capability-id
48461 description: UUID to uniquely identify a HPA capability
48464 description: Name of the HPACapability
48467 description: HPA schema version
48470 description: Hardware architecture
48473 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48477 $ref: "#/definitions/relationship"
48478 hpa-feature-attributes:
48481 $ref: "#/definitions/hpa-feature-attributes"
48482 hpa-feature-attributes:
48484 HPA Capability Feature attributes
48485 ###### Related Nodes
48486 - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
48488 -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
48490 - hpa-attribute-key
48494 description: name of the specific HPA attribute
48495 hpa-attribute-value:
48497 description: JSON string specifying the value, unit and type of the specific HPA attribute
48500 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48504 $ref: "#/definitions/relationship"
48508 ###### Related Nodes
48509 - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
48510 - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
48511 - FROM vserver( vserver Uses image, MANY2ONE)
48513 -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
48514 -IMAGE cannot be deleted if related to VSERVER
48525 description: Image id, expected to be unique across cloud region
48528 description: Image name
48529 image-architecture:
48531 description: Operating system architecture.
48534 description: The common name of the operating system distribution in lowercase
48537 description: The operating system version as specified by the distributor.
48540 description: The application that the image instantiates.
48541 application-vendor:
48543 description: The vendor of the application.
48544 application-version:
48546 description: The version of the application.
48549 description: URL to endpoint where AAI can get more details
48552 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48556 $ref: "#/definitions/relationship"
48560 $ref: "#/definitions/metadatum"
48563 Collectio of Openstack images.
48568 $ref: "#/definitions/image"
48569 include-node-filter:
48575 InstanceFilter for performing a named-query or model query
48578 InstanceFilters for performing a named-query or model query
48583 $ref: "#/definitions/instance-filter"
48586 General mechanism for grouping instances
48587 ###### Related Nodes
48588 - TO model( instance-group Targets model, MANY2MANY)
48589 - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
48590 - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
48591 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
48592 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
48593 - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY)
48594 - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
48595 - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
48596 - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
48597 - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
48598 - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
48599 - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY)
48606 instance-group-role:
48608 description: role of the instance group.
48609 model-invariant-id:
48611 description: ASDC model id for this resource or service model.
48614 description: ASDC model version uid for this resource model.
48617 description: Instance Group ID, UUID assigned to this instance.
48620 description: Descriptive text to help identify the usage of this instance-group
48623 description: Only valid value today is lower case ha for high availability
48626 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
48629 description: Concurrency value
48633 $ref: "#/definitions/relationship"
48636 Collection of openstack route table references
48641 $ref: "#/definitions/instance-group"
48646 $ref: "#/definitions/search"
48649 $ref: "#/definitions/actions"
48650 cloud-infrastructure:
48652 $ref: "#/definitions/cloud-infrastructure"
48655 $ref: "#/definitions/external-system"
48658 $ref: "#/definitions/business"
48659 service-design-and-creation:
48661 $ref: "#/definitions/service-design-and-creation"
48664 $ref: "#/definitions/network"
48667 $ref: "#/definitions/nodes"
48670 inventory-item-type:
48672 inventory-item-link:
48674 inventory-item-data:
48677 $ref: "#/definitions/inventory-item-data"
48678 tagged-inventory-item-list:
48681 $ref: "#/definitions/tagged-inventory-item-list"
48682 inventory-item-data:
48688 inventory-response-item:
48690 Inventory item for response list
48696 $ref: "#/definitions/extra-properties"
48697 inventory-response-items:
48699 $ref: "#/definitions/inventory-response-items"
48700 inventory-response-items:
48702 Container for inventory items in response list
48704 inventory-response-item:
48707 $ref: "#/definitions/inventory-response-item"
48708 ipsec-configuration:
48710 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
48711 ###### Related Nodes
48712 - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
48713 - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
48715 -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
48717 - ipsec-configuration-id
48719 ipsec-configuration-id:
48721 description: UUID of this configuration
48722 requested-vig-address-type:
48724 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
48725 requested-encryption-strength:
48727 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
48728 requested-dmz-type:
48730 description: ATT can offer a shared DMZ or a DMZ specific to a customer
48731 shared-dmz-network-address:
48733 description: Network address of shared DMZ
48734 requested-customer-name:
48736 description: If the DMZ is a custom DMZ, this field will indicate the customer information
48739 description: can be 1 or 2
48740 ikev1-authentication:
48742 description: Contains values like md5, sha1, sha256, sha384
48745 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,ĆĀ aes-192-cbc, aes-265-cbc
48748 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
48751 description: Group name defined in VIG for clients using aggressive mode
48754 description: pre-shared key for the above group name
48757 description: Lifetime for IKEv1 SA
48758 ipsec-authentication:
48760 description: md5, sha1, sha256, sha384
48763 description: 3des-cbc, des-cbc, aes-128-cbc,ĆĀ aes-192-cbc, aes-265-cbc
48766 description: Life time for IPSec SA
48769 description: enable PFS or not
48772 description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
48773 xauth-user-password:
48775 description: Encrypted using the Juniper $9$ algorithm
48778 description: The time between DPD probe
48781 description: Maximum number of DPD before claiming the tunnel is down
48784 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48788 $ref: "#/definitions/relationship"
48792 $ref: "#/definitions/vig-server"
48793 ipsec-configurations:
48795 ipsec-configuration:
48798 $ref: "#/definitions/ipsec-configuration"
48807 Logical interfaces, e.g., a vnic.
48808 ###### Related Nodes
48809 - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
48810 - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
48811 - TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
48812 - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
48813 - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
48814 - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
48815 - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
48816 - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
48817 - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY)
48818 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
48819 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
48820 - FROM logical-link( logical-link Source l-interface, ONE2MANY)(1)
48821 - FROM logical-link( logical-link Destination l-interface, ONE2MANY)(1)
48822 - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
48823 - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
48824 - FROM configuration( configuration AppliesTo l-interface, ONE2MANY)
48825 - FROM forwarder( forwarder ForwardsTo l-interface, MANY2ONE)
48826 - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
48828 -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
48829 -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
48830 -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
48839 description: Name given to the interface
48842 description: E.g., CUSTOMER, UPLINK, etc.
48845 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
48848 description: URL to endpoint where AAI can get more details
48851 description: ID of interface
48854 description: MAC address for the interface
48857 description: Name of the network
48860 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
48861 interface-description:
48863 description: Human friendly text regarding this interface.
48866 description: boolean indicatating whether or not port is a mirrored.
48869 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48872 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
48875 description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
48878 description: Flag indicating the interface uses the IP Unnumbered configuration.
48879 allowed-address-pairs:
48881 description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
48885 $ref: "#/definitions/vlan"
48889 $ref: "#/definitions/sriov-vf"
48893 $ref: "#/definitions/l-interface"
48897 $ref: "#/definitions/relationship"
48898 l3-interface-ipv4-address-list:
48901 $ref: "#/definitions/l3-interface-ipv4-address-list"
48902 l3-interface-ipv6-address-list:
48905 $ref: "#/definitions/l3-interface-ipv6-address-list"
48908 Collection of logical interfaces.
48913 $ref: "#/definitions/l-interface"
48914 l3-interface-ipv4-address-list:
48917 ###### Related Nodes
48918 - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
48919 - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
48920 - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
48921 - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
48922 - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
48923 - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4)
48925 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
48927 - l3-interface-ipv4-address
48929 l3-interface-ipv4-address:
48931 description: IP address
48932 l3-interface-ipv4-prefix-length:
48935 description: Prefix length, 32 for single address
48939 description: Inner VLAN tag
48943 description: Outer VLAN tag
48946 description: Indicator of fixed or floating address
48949 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48950 neutron-network-id:
48952 description: Neutron network id of the interface that address belongs to
48955 description: Neutron id of subnet that address belongs to
48959 $ref: "#/definitions/relationship"
48960 l3-interface-ipv6-address-list:
48963 ###### Related Nodes
48964 - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
48965 - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
48966 - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
48967 - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
48968 - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
48969 - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4)
48971 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
48973 - l3-interface-ipv6-address
48975 l3-interface-ipv6-address:
48977 description: IP address
48978 l3-interface-ipv6-prefix-length:
48981 description: Prefix length, 128 for single address
48985 description: Inner VLAN tag
48989 description: Outer VLAN tag
48992 description: Indicator of fixed or floating address
48995 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48996 neutron-network-id:
48998 description: Neutron network id of the interface that address belongs to
49001 description: Neutron id of subnet that address belongs to
49005 $ref: "#/definitions/relationship"
49008 Generic network definition
49009 ###### Related Nodes
49010 - TO instance-group( l3-network MemberOf instance-group, MANY2MANY)
49011 - TO network-policy( l3-network Uses network-policy, MANY2MANY)
49012 - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
49013 - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
49014 - TO model-ver( l3-network IsA model-ver, Many2One)
49015 - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
49016 - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
49017 - FROM complex( complex Uses l3-network, MANY2MANY)
49018 - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
49019 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
49020 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
49021 - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
49022 - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
49023 - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
49024 - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
49025 - FROM tenant( tenant Uses l3-network, MANY2MANY)
49026 - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
49028 -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
49033 - is-provider-network
49034 - is-shared-network
49035 - is-external-network
49039 description: Network ID, should be uuid. Unique across A&AI.
49042 description: Name of the network, governed by some naming convention..
49045 description: Type of the network - who defines these values?
49048 description: Role the network plans - who defines these values?
49049 network-technology:
49051 description: Network technology - who defines these values?
49052 neutron-network-id:
49054 description: Neutron network id of this Interface
49057 description: Set to true if bound to VPN
49060 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
49061 network-role-instance:
49064 description: network role instance
49067 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49068 orchestration-status:
49070 description: Orchestration status of this VNF, mastered by MSO
49073 description: Heat stack id corresponding to this instance, managed by MSO
49076 description: Corresponds to the SDN-C catalog id used to configure this VCE
49077 contrail-network-fqdn:
49079 description: Contrail FQDN for the network
49080 model-invariant-id:
49082 description: the ASDC model id for this resource or service model.
49085 description: the ASDC model version for this resource or service model.
49086 persona-model-version:
49088 description: the ASDC model version for this resource or service model.
49089 model-customization-id:
49091 description: captures the id of all the configuration used to customize the resource for the service.
49094 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
49095 widget-model-version:
49097 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
49098 physical-network-name:
49100 description: Name associated with the physical network.
49101 is-provider-network:
49103 description: boolean indicatating whether or not network is a provider network.
49106 description: boolean indicatating whether or not network is a shared network.
49107 is-external-network:
49109 description: boolean indicatating whether or not network is an external network.
49112 description: Path to the controller object.
49113 operational-status:
49115 description: Indicator for whether the resource is considered operational.
49119 $ref: "#/definitions/subnet"
49123 $ref: "#/definitions/ctag-assignment"
49124 segmentation-assignments:
49127 $ref: "#/definitions/segmentation-assignment"
49131 $ref: "#/definitions/relationship"
49132 description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
49138 $ref: "#/definitions/l3-network"
49141 Link aggregate interface
49142 ###### Related Nodes
49143 - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
49144 - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
49145 - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
49146 - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
49147 - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
49148 - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
49149 - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
49150 - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
49151 - FROM forwarder( forwarder ForwardsTo lag-interface, MANY2ONE)
49153 -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
49154 -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
49155 -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
49162 description: Name that identifies the link aggregate interface
49163 interface-description:
49165 description: Human friendly text regarding this interface.
49168 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49171 description: Captures the numeric part of the speed
49174 description: Captures the units corresponding to the speed
49177 description: ID of interface
49180 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
49183 description: Trigger for operational monitoring of this resource by Service Assurance systems.
49186 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
49190 $ref: "#/definitions/relationship"
49194 $ref: "#/definitions/l-interface"
49197 Collection of link aggregate interfaces.
49202 $ref: "#/definitions/lag-interface"
49205 LAG links can connect lag-interfaces
49206 ###### Related Nodes
49207 - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
49208 - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
49210 -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
49216 description: Alphabetical concatenation of lag-interface names
49219 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49223 $ref: "#/definitions/relationship"
49226 Collection of link aggregation connections
49231 $ref: "#/definitions/lag-link"
49234 Metadata for license group.
49235 ###### Related Nodes
49236 - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
49237 - TO vce( license BelongsTo vce, MANY2ONE)(4)
49239 -(4) IF this TO node is deleted, this LICENSE is DELETED also
49246 description: Unique ID for the license group the resource belongs to, should be uuid.
49249 description: Unique ID of a license resource.
49252 description: Concurrency value
49256 $ref: "#/definitions/relationship"
49259 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
49264 $ref: "#/definitions/license"
49267 describes a line-of-business
49268 ###### Related Nodes
49269 - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
49272 - line-of-business-name
49274 line-of-business-name:
49276 description: Name of the line-of-business (product)
49279 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49283 $ref: "#/definitions/relationship"
49286 Collection of lines-of-business
49291 $ref: "#/definitions/line-of-business"
49294 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
49295 ###### Related Nodes
49296 - TO l-interface( logical-link Source l-interface, ONE2MANY)(4)
49297 - TO l-interface( logical-link Destination l-interface, ONE2MANY)(4)
49298 - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
49299 - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
49300 - TO lag-link( logical-link Uses lag-link, MANY2MANY)
49301 - TO logical-link( logical-link Uses logical-link, MANY2MANY)
49302 - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
49303 - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
49304 - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
49305 - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
49306 - TO model-ver( logical-link IsA model-ver, Many2One)
49307 - FROM configuration( configuration Uses logical-link, ONE2MANY)(3)
49308 - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)
49309 - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
49310 - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
49311 - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
49312 - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
49313 - FROM logical-link( logical-link Uses logical-link, MANY2MANY)
49315 -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
49316 -(4) IF this TO node is deleted, this LOGICAL-LINK is DELETED also
49324 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
49327 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.
49330 description: Type of logical link, e.g., evc
49333 description: Captures the numeric part of the speed
49336 description: Captures the units corresponding to the speed
49339 description: v4, v6, or ds for dual stack
49342 description: For example, static or BGP
49345 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49346 model-invariant-id:
49348 description: the ASDC model id for this resource or service model.
49351 description: the ASDC model version for this resource or service model.
49352 persona-model-version:
49354 description: the ASDC model version for this resource or service model.
49357 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
49358 widget-model-version:
49360 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
49361 operational-status:
49363 description: Indication of operational status of the logical link.
49366 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
49369 description: Indication of the network use of the logical link.
49372 description: Alias or alternate name (CLCI or D1 name).
49375 description: UUID of the logical-link, SDNC generates this.
49378 description: Circuit id
49381 description: Reason for this entity, role it is playing
49385 $ref: "#/definitions/relationship"
49388 Collection of logical connections
49393 $ref: "#/definitions/logical-link"
49396 Collection of metadatum (key/value pairs)
49401 $ref: "#/definitions/metadatum"
49405 ###### Related Nodes
49406 - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4)
49407 - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
49408 - TO image( metadatum BelongsTo image, MANY2ONE)(4)
49409 - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
49410 - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
49412 -(4) IF this TO node is deleted, this METADATUM is DELETED also
49423 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49426 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
49427 ###### Related Nodes
49428 - TO model( model-ver BelongsTo model, MANY2ONE)(1)
49429 - FROM instance-group( instance-group Targets model, MANY2MANY)
49430 - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
49431 - FROM named-query( named-query AppliesTo model, ONE2MANY)
49432 - FROM named-query-element( named-query-element IsA model, MANY2ONE)
49434 -(1) IF this MODEL node is deleted, this FROM node is DELETED also
49435 -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
49438 - model-invariant-id
49441 model-invariant-id:
49443 description: Unique identifier corresponding to the main definition of a model in ASDC
49446 description: Type of the model, e.g., service, resource, widget, etc.
49449 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49453 $ref: "#/definitions/model-ver"
49457 $ref: "#/definitions/relationship"
49458 model-and-named-query-search:
49460 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
49464 $ref: "#/definitions/query-parameters"
49467 $ref: "#/definitions/instance-filters"
49470 $ref: "#/definitions/secondary-filts"
49473 secondary-filter-cut-point:
49477 This is how we would capture constraints defining allowed sets of elements.
49478 ###### Related Nodes
49479 - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
49480 - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
49482 -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
49483 -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
49485 - model-constraint-uuid
49486 - constrained-element-set-uuid-to-replace
49488 model-constraint-uuid:
49490 constrained-element-set-uuid-to-replace:
49492 constrained-element-sets:
49495 $ref: "#/definitions/constrained-element-set"
49498 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49504 $ref: "#/definitions/model-constraint"
49507 Defines how other models combine to make up a higher-level model.
49508 ###### Related Nodes
49509 - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
49510 - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
49511 - TO model-ver( model-element IsA model-ver, MANY2ONE)
49512 - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
49513 - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
49514 - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
49515 - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
49517 -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
49518 -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
49520 - model-element-uuid
49521 - new-data-del-flag
49524 model-element-uuid:
49528 description: Indicates whether this element was created as part of instantiation from this model
49531 description: How many of this type of element are required/allowed
49536 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49540 $ref: "#/definitions/model-element"
49541 description: Defines how other models combine to make up a higher-level model
49545 $ref: "#/definitions/model-constraint"
49546 description: Describes new constraints on this model element that are not part of that model's definition
49550 $ref: "#/definitions/relationship"
49556 $ref: "#/definitions/model-element"
49559 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
49560 ###### Related Nodes
49561 - TO model( model-ver BelongsTo model, MANY2ONE)(4)
49562 - FROM model-element( model-element IsA model-ver, MANY2ONE)
49563 - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
49564 - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
49565 - FROM allotted-resource( allotted-resource IsA model-ver, Many2One)
49566 - FROM generic-vnf( generic-vnf IsA model-ver, Many2One)
49567 - FROM l3-network( l3-network IsA model-ver, Many2One)
49568 - FROM logical-link( logical-link IsA model-ver, Many2One)
49569 - FROM service-instance( service-instance IsA model-ver, Many2One)
49570 - FROM vf-module( vf-module IsA model-ver, Many2One)
49572 -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
49573 -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
49574 -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
49583 description: Unique identifier corresponding to one version of a model in ASDC
49586 description: Name of the model, which can change from version to version.
49589 description: Version
49590 distribution-status:
49592 description: Distribution Status
49595 description: Description
49598 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49602 $ref: "#/definitions/model-element"
49606 $ref: "#/definitions/metadatum"
49610 $ref: "#/definitions/relationship"
49616 $ref: "#/definitions/model-ver"
49619 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
49624 $ref: "#/definitions/model"
49625 multicast-configuration:
49627 ###### Related Nodes
49628 - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
49631 - multicast-configuration-id
49632 - multicast-protocol
49635 multicast-configuration-id:
49637 description: Unique id of multicast configuration.
49638 multicast-protocol:
49640 description: protocol of multicast configuration
49643 description: rp type of multicast configuration
49646 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49650 $ref: "#/definitions/relationship"
49651 multicast-configurations:
49653 multicast configuration of generic-vnf ip-address
49655 multicast-configuration:
49658 $ref: "#/definitions/multicast-configuration"
49664 $ref: "#/definitions/named-query"
49668 ###### Related Nodes
49669 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
49670 - TO model( named-query AppliesTo model, ONE2MANY)
49671 - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
49673 -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
49677 - named-query-version
49683 named-query-version:
49685 required-input-param:
49691 named-query-elements:
49694 $ref: "#/definitions/named-query-element"
49698 $ref: "#/definitions/relationship"
49699 named-query-element:
49702 ###### Related Nodes
49703 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
49704 - TO model( named-query-element IsA model, MANY2ONE)
49705 - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
49706 - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
49707 - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
49708 - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
49710 -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
49711 -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
49713 - named-query-element-uuid
49715 named-query-element-uuid:
49717 property-collect-list:
49721 property-limit-desc:
49725 named-query-elements:
49728 $ref: "#/definitions/named-query-element"
49732 $ref: "#/definitions/related-lookup"
49733 property-constraints:
49736 $ref: "#/definitions/property-constraint"
49740 $ref: "#/definitions/relationship"
49741 named-query-elements:
49743 named-query-element:
49746 $ref: "#/definitions/named-query-element"
49749 Namespace for network inventory resources.
49754 $ref: "#/definitions/logical-link"
49758 $ref: "#/definitions/site-pair-set"
49762 $ref: "#/definitions/vpn-binding"
49766 $ref: "#/definitions/vpls-pe"
49767 multicast-configurations:
49770 $ref: "#/definitions/multicast-configuration"
49774 $ref: "#/definitions/vce"
49778 $ref: "#/definitions/vnfc"
49782 $ref: "#/definitions/l3-network"
49786 $ref: "#/definitions/network-policy"
49790 $ref: "#/definitions/generic-vnf"
49794 $ref: "#/definitions/lag-link"
49798 $ref: "#/definitions/newvce"
49802 $ref: "#/definitions/pnf"
49806 $ref: "#/definitions/physical-link"
49807 ipsec-configurations:
49810 $ref: "#/definitions/ipsec-configuration"
49811 route-table-references:
49814 $ref: "#/definitions/route-table-reference"
49818 $ref: "#/definitions/instance-group"
49822 $ref: "#/definitions/zone"
49826 $ref: "#/definitions/configuration"
49830 $ref: "#/definitions/forwarding-path"
49836 $ref: "#/definitions/network-policy"
49839 ###### Related Nodes
49840 - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
49841 - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
49844 - network-policy-id
49848 description: UUID representing unique key to this instance
49849 network-policy-fqdn:
49851 description: Contrail FQDN for the policy
49854 description: ID for the openStack Heat instance
49857 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49861 $ref: "#/definitions/relationship"
49864 Network profile populated by SDN-GP for SNMP
49865 ###### Related Nodes
49866 - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
49873 description: Unique name of network profile.
49876 description: Encrypted SNMP community string
49879 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49883 $ref: "#/definitions/relationship"
49886 Collection of network profiles
49891 $ref: "#/definitions/network-profile"
49894 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
49895 ###### Related Nodes
49896 - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
49898 -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
49906 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
49909 description: Name of VNF.
49912 description: Alternate name of VNF.
49915 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.
49918 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
49919 operational-status:
49921 description: Indicator for whether the resource is considered operational
49924 description: OBSOLETE - do not use
49927 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).
49930 description: Client should send valid enumerated value.
49933 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49934 ipv4-loopback0-address:
49936 description: v4 Loopback0 address
49937 orchestration-status:
49939 description: Orchestration status of this VNF, mastered by MSO.
49942 description: Heat stack id corresponding to this instance, managed by MSO
49945 description: Corresponds to the SDN-C catalog id used to configure this VCE
49949 $ref: "#/definitions/relationship"
49953 $ref: "#/definitions/l-interface"
49956 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
49961 $ref: "#/definitions/newvce"
49964 inventory-item-data:
49967 $ref: "#/definitions/inventory-item-data"
49968 notification-event:
49972 notification-event-header:
49974 $ref: "#/definitions/notification-event-header"
49975 notification-event-header:
50016 $ref: "#/definitions/key-data"
50021 OAM network, to be deprecated shortly. Do not use for new purposes.
50022 ###### Related Nodes
50023 - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
50024 - TO complex( oam-network AppliesTo complex, MANY2MANY)
50025 - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
50034 description: UUID of the network. Unique across a cloud-region
50037 description: Name of the network.
50041 description: cvlan-id
50042 ipv4-oam-gateway-address:
50044 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
50045 ipv4-oam-gateway-address-prefix-length:
50048 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
50051 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50055 $ref: "#/definitions/relationship"
50058 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
50063 $ref: "#/definitions/oam-network"
50064 operational-environment:
50066 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
50067 ###### Related Nodes
50068 - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
50069 - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
50072 - operational-environment-id
50073 - operational-environment-name
50074 - operational-environment-type
50075 - operational-environment-status
50079 operational-environment-id:
50081 description: UUID of an operational environment
50082 operational-environment-name:
50084 description: Operational Environment name
50085 operational-environment-type:
50087 description: Operational Environment Type.
50088 operational-environment-status:
50090 description: Status
50093 description: Tenant Context.
50096 description: Workload Context.
50099 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50103 $ref: "#/definitions/relationship"
50104 operational-environments:
50106 a logical partition of the cloud which allows to have multiple environments in the production AIC.
50108 operational-environment:
50111 $ref: "#/definitions/operational-environment"
50114 Allows for legacy POST of old-style and new-style models
50116 - model-invariant-id
50117 - model-name-version-id
50123 model-invariant-id:
50125 description: Unique identifier corresponding to the main definition of a model in ASDC
50126 model-name-version-id:
50128 description: Unique identifier corresponding to one version of a model in ASDC
50131 description: Type of the model, e.g., service, resource, widget, etc.
50134 description: Name of the model, which can change from version to version.
50137 description: Invariant unique ID which does not change from version to version
50140 description: Version
50143 description: Description
50146 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50149 $ref: "#/definitions/model-vers"
50152 $ref: "#/definitions/relationship-list"
50155 Collection of owning-entities
50160 $ref: "#/definitions/owning-entity"
50163 describes an owning-entity
50164 ###### Related Nodes
50165 - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
50169 - owning-entity-name
50173 description: UUID of an owning entity
50174 owning-entity-name:
50176 description: Owning entity name
50179 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50183 $ref: "#/definitions/relationship"
50186 Physical interface (e.g., nic)
50187 ###### Related Nodes
50188 - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
50189 - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
50190 - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
50191 - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
50192 - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
50193 - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
50194 - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
50195 - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1)
50196 - FROM forwarder( forwarder ForwardsTo p-interface, MANY2ONE)
50198 -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
50199 -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
50200 -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
50207 description: Name that identifies the physical interface
50210 description: URL to endpoint where AAI can get more details.
50213 description: Captures the numeric part of the speed
50216 description: Captures the units corresponding to the speed
50219 description: Nature of the services and connectivity on this port.
50220 equipment-identifier:
50222 description: CLEI or other specification for p-interface hardware.
50225 description: Role specification for p-interface hardware.
50228 description: Indicates the physical properties of the interface.
50231 description: Trigger for operational monitoring of this resource by Service Assurance systems.
50234 description: MAC Address of the p-interface.
50237 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50240 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
50243 description: inventory status
50247 $ref: "#/definitions/relationship"
50251 $ref: "#/definitions/sriov-pf"
50255 $ref: "#/definitions/l-interface"
50258 Collection of physical interfaces.
50263 $ref: "#/definitions/p-interface"
50266 Collection of physical connections, typically between p-interfaces
50267 ###### Related Nodes
50268 - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
50270 -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
50276 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
50279 description: Captures the numeric part of the speed
50282 description: Captures the units corresponding to the speed
50285 description: Circuit it
50288 description: Dual access mode (e.g., primary, secondary
50291 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
50292 service-provider-name:
50294 description: Name of the service Provider on this link.
50295 service-provider-bandwidth-up-value:
50298 description: Upstream Bandwidth value agreed with the service provider
50299 service-provider-bandwidth-up-units:
50301 description: Units for the upstream BW value
50302 service-provider-bandwidth-down-value:
50305 description: Downstream Bandwidth value agreed with the service provider
50306 service-provider-bandwidth-down-units:
50308 description: Units for downstream BW value
50311 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50315 $ref: "#/definitions/relationship"
50318 Collection of physical connections, typically between p-interfaces
50323 $ref: "#/definitions/physical-link"
50326 describes a platform
50327 ###### Related Nodes
50328 - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
50335 description: Name of the platform
50338 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50342 $ref: "#/definitions/relationship"
50345 Collection of platforms
50350 $ref: "#/definitions/platform"
50353 PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
50354 ###### Related Nodes
50355 - TO complex( pnf LocatedIn complex, MANY2ONE)
50356 - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
50357 - TO zone( pnf LocatedIn zone, MANY2ONE)
50358 - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many)
50359 - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY)
50360 - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
50361 - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
50362 - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
50363 - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
50364 - FROM configuration( configuration AppliesTo pnf, ONE2MANY)
50366 -(1) IF this PNF node is deleted, this FROM node is DELETED also
50373 description: unique name of Physical Network Function.
50376 description: name of Physical Network Function.
50379 description: URL to endpoint where AAI can get more details.
50382 description: source of name2
50385 description: id of pnf
50388 description: Equipment type. Source of truth should define valid values.
50391 description: Equipment vendor. Source of truth should define valid values.
50394 description: Equipment model. Source of truth should define valid values.
50397 description: identifier of managed by ATT or customer
50400 description: ipv4-oam-address with new naming convention for IP addresses
50403 description: sw-version is the version of SW for the hosted application on the PNF.
50406 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.
50409 description: ID of the physical frame (relay rack) where pnf is installed.
50412 description: Serial number of the device
50413 ipaddress-v4-loopback-0:
50415 description: IPV4 Loopback 0 address
50416 ipaddress-v6-loopback-0:
50418 description: IPV6 Loopback 0 address
50421 description: IPV4 AIM address
50424 description: IPV6 AIM address
50427 description: IPV6 OAM address
50430 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
50433 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50436 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
50439 description: Nf Role is the role performed by this instance in the network.
50443 $ref: "#/definitions/relationship"
50447 $ref: "#/definitions/p-interface"
50451 $ref: "#/definitions/lag-interface"
50454 Collection of Physical Network Functions.
50459 $ref: "#/definitions/pnf"
50462 Used to capture the network interfaces of this VCE
50463 ###### Related Nodes
50464 - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
50465 - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
50467 -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
50468 -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
50471 - orchestration-status
50475 description: Unique ID of the interface
50476 neutron-network-id:
50478 description: Neutron network id of this Interface
50479 neutron-network-name:
50481 description: Neutron network name of this Interface
50484 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50487 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50490 description: Unique ID for port group in vmware
50493 description: Likely to duplicate value of neutron network name
50496 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
50497 orchestration-status:
50499 description: Orchestration status of this VNF, mastered by MSO
50502 description: Heat stack id corresponding to this instance, managed by MSO
50505 description: Corresponds to the SDN-C catalog id used to configure this VCE
50509 $ref: "#/definitions/cvlan-tag-entry"
50513 $ref: "#/definitions/relationship"
50519 $ref: "#/definitions/port-group"
50522 describes the project
50523 ###### Related Nodes
50524 - TO service-instance( project Uses service-instance, ONE2MANY)
50531 description: Name of the project deploying a service
50534 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50538 $ref: "#/definitions/relationship"
50541 Collection of projects
50546 $ref: "#/definitions/project"
50549 Property holder for query properties or instance properties
50555 property-constraint:
50558 ###### Related Nodes
50559 - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
50561 -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
50563 - property-constraint-uuid
50568 property-constraint-uuid:
50578 property-constraints:
50580 property-constraint:
50583 $ref: "#/definitions/property-constraint"
50586 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
50587 ###### Related Nodes
50588 - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
50589 - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
50590 - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
50591 - TO complex( pserver LocatedIn complex, MANY2ONE)
50592 - TO zone( pserver LocatedIn zone, MANY2ONE)
50593 - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
50594 - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
50595 - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
50596 - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
50597 - FROM vserver( vserver HostedOn pserver, MANY2ONE)
50599 -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
50600 -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
50608 description: Value from executing hostname on the compute node.
50611 description: PTNII name
50615 description: Number of cpus
50619 description: Disk size, in GBs
50623 description: RAM size, in MBs
50626 description: Equipment type. Source of truth should define valid values.
50629 description: Equipment vendor. Source of truth should define valid values.
50632 description: Equipment model. Source of truth should define valid values.
50635 description: Fully-qualified domain name
50638 description: URL to endpoint where AAI can get more details
50641 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
50644 description: Serial number, may be queried
50645 ipaddress-v4-loopback-0:
50647 description: IPV4 Loopback 0 address
50648 ipaddress-v6-loopback-0:
50650 description: IPV6 Loopback 0 address
50653 description: IPV4 AIM address
50656 description: IPV6 AIM address
50659 description: IPV6 OAM address
50662 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
50665 description: ID of Pserver
50668 description: internet topology of Pserver
50671 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.
50674 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50677 description: alternative pserver name
50680 description: purpose of pserver
50683 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
50686 description: Indicates who owns and or manages the device.
50689 description: The host profile that defines the configuration of the pserver.
50693 $ref: "#/definitions/relationship"
50697 $ref: "#/definitions/p-interface"
50701 $ref: "#/definitions/lag-interface"
50704 Collection of compute hosts.
50709 $ref: "#/definitions/pserver"
50712 QueryParameters for performing a named-query or model query
50716 $ref: "#/definitions/named-query"
50719 $ref: "#/definitions/overloaded-model"
50723 ###### Related Nodes
50724 - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
50726 -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
50728 - related-lookup-uuid
50730 - source-node-property
50732 - target-node-property
50734 related-lookup-uuid:
50738 source-node-property:
50742 target-node-property:
50744 property-collect-list:
50751 $ref: "#/definitions/relationship"
50757 $ref: "#/definitions/related-lookup"
50758 related-to-property:
50762 description: Key part of a key/value pair
50765 description: Value part of a key/value pair
50770 description: A keyword provided by A&AI to indicate type of node.
50771 relationship-label:
50773 description: The edge label for this relationship.
50776 description: URL to the object in A&AI.
50780 $ref: "#/definitions/relationship-data"
50784 - relationship-value
50788 description: A keyword provided by A&AI to indicate an attribute.
50789 relationship-value:
50791 description: Value of the attribute.
50797 $ref: "#/definitions/relationship"
50798 reserved-prop-names:
50800 Internal map to define some reserved properties of a vertex
50802 last-mod-source-of-truth:
50820 Response container for the results of a named-query or model query
50822 inventory-response-items:
50824 $ref: "#/definitions/inventory-response-items"
50829 description: The specific type of node in the A&AI graph
50832 description: The URL to the specific resource
50833 route-table-reference:
50835 Openstack route table reference.
50836 ###### Related Nodes
50837 - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
50840 - route-table-reference-id
50841 - route-table-reference-fqdn
50843 route-table-reference-id:
50845 description: Route Table Reference id, UUID assigned to this instance.
50846 route-table-reference-fqdn:
50848 description: FQDN entry in the route table.
50851 description: Concurrency value
50855 $ref: "#/definitions/relationship"
50856 route-table-references:
50858 Collection of openstack route table references
50860 route-table-reference:
50863 $ref: "#/definitions/route-table-reference"
50866 Route target information
50867 ###### Related Nodes
50868 - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
50870 -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
50872 - global-route-target
50873 - route-target-role
50875 global-route-target:
50877 description: Number used to identify an RT, globally unique in the network
50880 description: Role assigned to this route target
50883 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50887 $ref: "#/definitions/relationship"
50890 Collection of route target information
50895 $ref: "#/definitions/route-target"
50898 ###### Related Nodes
50899 - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
50900 - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
50902 -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
50903 -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
50905 - routing-instance-id
50907 routing-instance-id:
50909 description: Unique id of routing instance
50912 description: rpm owner
50915 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50919 $ref: "#/definitions/site-pair"
50923 $ref: "#/definitions/relationship"
50926 set of probes related to generic-vnf routing instance
50931 $ref: "#/definitions/routing-instance"
50936 $ref: "#/definitions/oam-networks"
50937 az-and-dvs-switches:
50940 $ref: "#/definitions/az-and-dvs-switches"
50943 edge-tag-query-result:
50945 $ref: "#/definitions/edge-tag-query-result"
50946 edge-tag-query-request:
50948 $ref: "#/definitions/edge-tag-query-request"
50951 $ref: "#/definitions/search-results"
50954 $ref: "#/definitions/sdn-zone-response"
50960 $ref: "#/definitions/result-data"
50963 SecondaryFilt for performing a named-query or model query
50974 SecondaryFilts for performing a named-query or model query
50979 $ref: "#/definitions/secondary-filt"
50980 segmentation-assignment:
50982 Openstack segmentation assignment.
50983 ###### Related Nodes
50984 - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
50986 -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
50992 description: Route Table Reference id, UUID assigned to this instance.
50995 description: Concurrency value
50999 $ref: "#/definitions/relationship"
51000 segmentation-assignments:
51002 Collection of openstack segmentation assignments
51004 segmentation-assignment:
51007 $ref: "#/definitions/segmentation-assignment"
51010 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
51013 - service-description
51017 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
51018 service-description:
51020 description: Description of the service
51023 description: URL to endpoint where AAI can get more details
51026 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51029 description: service version
51033 $ref: "#/definitions/relationship"
51034 service-capabilities:
51036 Collection of service capabilities.
51038 service-capability:
51041 $ref: "#/definitions/service-capability"
51042 service-capability:
51044 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
51045 ###### Related Nodes
51046 - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
51047 - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
51049 -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
51057 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
51060 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.
51063 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51067 $ref: "#/definitions/relationship"
51068 service-design-and-creation:
51070 Namespace for objects managed by ASDC
51075 $ref: "#/definitions/vnf-image"
51079 $ref: "#/definitions/service"
51080 service-capabilities:
51083 $ref: "#/definitions/service-capability"
51087 $ref: "#/definitions/model"
51091 $ref: "#/definitions/named-query"
51094 Instance of a service
51095 ###### Related Nodes
51096 - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
51097 - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
51098 - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE)
51099 - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
51100 - TO configuration( service-instance Uses configuration, ONE2MANY)
51101 - TO connector( service-instance Uses connector, MANY2MANY)
51102 - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
51103 - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
51104 - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
51105 - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
51106 - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
51107 - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
51108 - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
51109 - TO zone( service-instance LocatedIn zone, MANY2ONE)
51110 - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
51111 - TO vce( service-instance ComposedOf vce, ONE2MANY)
51112 - TO model-ver( service-instance IsA model-ver, Many2One)
51113 - FROM project( project Uses service-instance, ONE2MANY)
51114 - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
51115 - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
51116 - FROM forwarding-path( forwarding-path AppliesTo service-instance, MANY2ONE)(1)
51117 - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
51119 -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
51120 -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
51121 -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
51123 - service-instance-id
51125 service-instance-id:
51127 description: Uniquely identifies this instance of a service
51128 service-instance-name:
51130 description: This field will store a name assigned to the service-instance.
51133 description: String capturing type of service.
51136 description: String capturing the service role.
51137 environment-context:
51139 description: This field will store the environment context assigned to the service-instance.
51142 description: This field will store the workload context assigned to the service-instance.
51145 description: create time of Network Service.
51148 description: last update of Network Service.
51151 description: short description for service-instance.
51152 model-invariant-id:
51154 description: the ASDC model id for this resource or service model.
51157 description: the ASDC model version for this resource or service model.
51158 persona-model-version:
51160 description: the ASDC model version for this resource or service model.
51163 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
51164 widget-model-version:
51166 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
51169 description: Indicates the total bandwidth to be used for this service.
51172 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
51173 bandwidth-down-wan1:
51175 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
51178 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
51179 bandwidth-down-wan2:
51181 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
51184 description: URL customers will use to access the vHN Portal.
51185 service-instance-location-id:
51187 description: An identifier that customers assign to the location where this service is being used.
51190 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51193 description: Path to the controller object.
51194 orchestration-status:
51196 description: Orchestration status of this service.
51200 $ref: "#/definitions/relationship"
51204 $ref: "#/definitions/metadatum"
51205 allotted-resources:
51208 $ref: "#/definitions/allotted-resource"
51211 Collection of service instances
51216 $ref: "#/definitions/service-instance"
51217 service-subscription:
51219 Object that group service instances.
51220 ###### Related Nodes
51221 - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
51222 - TO tenant( service-subscription Uses tenant, MANY2MANY)
51223 - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
51225 -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
51226 -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
51232 description: Value defined by orchestration to identify this service across ECOMP.
51233 temp-ub-sub-account-id:
51235 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
51238 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51242 $ref: "#/definitions/service-instance"
51246 $ref: "#/definitions/relationship"
51247 service-subscriptions:
51249 Collection of objects that group service instances.
51251 service-subscription:
51254 $ref: "#/definitions/service-subscription"
51257 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
51262 $ref: "#/definitions/service"
51265 ###### Related Nodes
51266 - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
51267 - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
51269 -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
51270 -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
51276 description: unique identifier of probe
51279 description: Prefix address
51282 description: Prefix address
51285 description: ip version, v4, v6
51286 destination-hostname:
51288 description: Hostname of the destination equipment to which SLAs are measured against.
51289 destination-equip-type:
51291 description: The type of destinatination equipment. Could be Router, UCPE, etc.
51294 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51295 classes-of-service:
51298 $ref: "#/definitions/class-of-service"
51302 $ref: "#/definitions/relationship"
51305 Set of instances for probes used to measure service level agreements
51306 ###### Related Nodes
51307 - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
51308 - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
51310 -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
51316 description: Unique id of site pair set.
51319 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51323 $ref: "#/definitions/routing-instance"
51327 $ref: "#/definitions/relationship"
51330 Collection of sets of instances for probes related to generic-vnf
51335 $ref: "#/definitions/site-pair-set"
51343 $ref: "#/definitions/site-pair"
51347 ###### Related Nodes
51348 - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
51349 - FROM vserver( vserver Uses snapshot, ONE2ONE)
51356 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
51359 description: Snapshot name
51360 snapshot-architecture:
51362 description: Operating system architecture
51363 snapshot-os-distro:
51365 description: The common name of the operating system distribution in lowercase
51366 snapshot-os-version:
51368 description: The operating system version as specified by the distributor.
51371 description: The application that the image instantiates.
51372 application-vendor:
51374 description: The vendor of the application.
51375 application-version:
51377 description: The version of the application.
51380 description: URL to endpoint where AAI can get more details
51383 description: This field contains the UUID of the previous snapshot (if any).
51386 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51390 $ref: "#/definitions/relationship"
51393 Collection of openstack snapshots
51398 $ref: "#/definitions/snapshot"
51401 SR-IOV Physical Function
51402 ###### Related Nodes
51403 - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
51404 - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
51406 -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
51412 description: Identifier for the sriov-pf
51415 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51419 $ref: "#/definitions/relationship"
51422 Collection of SR-IOV Physical Functions.
51427 $ref: "#/definitions/sriov-pf"
51430 SR-IOV Virtual Function (not to be confused with virtual network function)
51431 ###### Related Nodes
51432 - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
51433 - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE)
51435 -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
51441 description: PCI ID used to identify the sriov-vf
51444 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
51447 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
51450 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
51451 vf-vlan-anti-spoof-check:
51453 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.
51454 vf-mac-anti-spoof-check:
51456 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.
51459 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
51460 vf-broadcast-allow:
51462 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
51463 vf-unknown-multicast-allow:
51465 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
51466 vf-unknown-unicast-allow:
51468 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
51471 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
51474 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
51477 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51478 neutron-network-id:
51480 description: Neutron network id of the interface
51484 $ref: "#/definitions/relationship"
51487 Collection of SR-IOV Virtual Functions.
51492 $ref: "#/definitions/sriov-vf"
51501 ###### Related Nodes
51502 - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
51503 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
51504 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
51505 - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1)
51506 - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
51507 - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
51509 -(1) IF this SUBNET node is deleted, this FROM node is DELETED also
51510 -(4) IF this TO node is deleted, this SUBNET is DELETED also
51511 -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
51519 description: Subnet ID, should be UUID.
51522 description: Name associated with the subnet.
51525 description: Neutron id of this subnet
51528 description: gateway ip address
51529 network-start-address:
51531 description: network start address
51534 description: cidr mask
51537 description: ip version
51538 orchestration-status:
51540 description: Orchestration status of this VNF, mastered by MSO
51543 description: dhcp enabled
51546 description: the start address reserved for use by dhcp
51549 description: the last address reserved for use by dhcp
51552 description: role of the subnet, referenced when assigning IPs
51553 ip-assignment-direction:
51555 description: ip address assignment direction of the subnet
51558 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51562 description: sequence of the subnet
51566 $ref: "#/definitions/host-route"
51570 $ref: "#/definitions/relationship"
51576 $ref: "#/definitions/subnet"
51577 tagged-inventory-item-list:
51582 $ref: "#/definitions/inventory-item"
51586 ###### Related Nodes
51587 - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
51588 - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
51589 - TO l3-network( tenant Uses l3-network, MANY2MANY)
51590 - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
51591 - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
51592 - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
51594 -TENANT cannot be deleted if related to VSERVER
51602 description: Unique id relative to the cloud-region.
51605 description: Readable name of tenant
51608 description: This field will store the tenant context.
51611 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51615 $ref: "#/definitions/vserver"
51619 $ref: "#/definitions/relationship"
51622 Collection of openstack tenants.
51627 $ref: "#/definitions/tenant"
51630 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
51631 ###### Related Nodes
51632 - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
51634 -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
51640 description: Allotted Resource id UUID assigned to this instance.
51643 description: The WAN uplink bandwidth for WAN1
51644 bandwidth-down-wan1:
51646 description: The WAN downlink bandwidth for WAN1
51649 description: The WAN uplink bandwidth for WAN2
51650 bandwidth-down-wan2:
51652 description: The WAN downlink bandwidth for WAN2
51655 description: Concurrency value
51659 $ref: "#/definitions/relationship"
51662 This object is used to store the specific tunnel cross connect aspects of an allotted resource
51667 $ref: "#/definitions/tunnel-xconnect"
51670 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
51679 $ref: "#/definitions/update-node-key"
51685 $ref: "#/definitions/action"
51694 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
51695 ###### Related Nodes
51696 - TO availability-zone( vce Uses availability-zone, MANY2MANY)
51697 - TO complex( vce LocatedIn complex, MANY2MANY)
51698 - TO vserver( vce HostedOn vserver, ONE2MANY)
51699 - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
51700 - FROM license( license BelongsTo vce, MANY2ONE)(1)
51701 - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
51702 - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
51704 -(1) IF this VCE node is deleted, this FROM node is DELETED also
51712 description: Unique id of VNF. This is unique across the graph.
51715 description: Name of VNF.
51718 description: Alternate name of VNF.
51721 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.
51724 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
51725 regional-resource-zone:
51727 description: Regional way of organizing pservers, source of truth should define values
51730 description: Trigger for operational monitoring of this resource by Service Assurance systems.
51731 operational-status:
51733 description: Indicator for whether the resource is considered operational
51736 description: OBSOLETE - do not use
51739 description: Network role being played by this VNF
51740 orchestration-status:
51742 description: Orchestration status of this VNF, mastered by MSO
51745 description: Heat stack id corresponding to this instance, managed by MSO
51748 description: Corresponds to the SDN-C catalog id used to configure this VCE
51751 description: Unique ID of VPE connected to this VCE.
51752 v6-vce-wan-address:
51754 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
51757 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
51760 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51761 ipv4-loopback0-address:
51763 description: Loopback0 address
51764 entitlement-resource-uuid:
51766 description: OBSOLETE - see child relationships
51770 $ref: "#/definitions/port-group"
51774 $ref: "#/definitions/license"
51778 $ref: "#/definitions/entitlement"
51782 $ref: "#/definitions/relationship"
51785 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
51790 $ref: "#/definitions/vce"
51793 a deployment unit of VNFCs
51794 ###### Related Nodes
51795 - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
51796 - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
51797 - TO vnfc( vf-module Uses vnfc, ONE2MANY)
51798 - TO volume-group( vf-module Uses volume-group, ONE2ONE)
51799 - TO vserver( vf-module Uses vserver, ONE2MANY)
51800 - TO model-ver( vf-module IsA model-ver, Many2One)
51802 -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
51803 -VF-MODULE cannot be deleted if related to VNFC
51807 - is-base-vf-module
51811 description: Unique ID of vf-module.
51814 description: Name of vf-module
51817 description: Heat stack id corresponding to this instance.
51818 orchestration-status:
51820 description: orchestration status of this vf-module, mastered by MSO
51823 description: used to indicate whether or not this object is base vf module
51826 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51827 model-invariant-id:
51829 description: the ASDC model id for this resource or service model.
51832 description: the ASDC model version for this resource or service model.
51833 persona-model-version:
51835 description: the ASDC model version for this resource or service model.
51836 model-customization-id:
51838 description: captures the id of all the configuration used to customize the resource for the service.
51841 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
51842 widget-model-version:
51844 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
51845 contrail-service-instance-fqdn:
51847 description: the Contrail unique ID for a service-instance
51851 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
51854 description: Path to the controller object.
51858 $ref: "#/definitions/relationship"
51861 Collection of vf-modules, a deployment unit of VNFCs
51866 $ref: "#/definitions/vf-module"
51869 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
51870 ###### Related Nodes
51871 - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
51873 -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
51879 description: indicates whether the VIG is for AVPN or INTERNET
51882 description: v4 IP of the vig server
51885 description: v6 IP of the vig server
51888 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51892 $ref: "#/definitions/relationship"
51898 $ref: "#/definitions/vig-server"
51899 vip-ipv4-address-list:
51902 ###### Related Nodes
51903 - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
51904 - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
51905 - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
51906 - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
51913 description: IP address
51914 vip-ipv4-prefix-length:
51917 description: Prefix length, 32 for single address
51921 description: Inner VLAN tag
51925 description: Outer VLAN tag
51928 description: Indicator of fixed or floating address
51931 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51932 neutron-network-id:
51934 description: Neutron network id of the interface that address belongs to
51937 description: Neutron id of subnet that address belongs to
51941 $ref: "#/definitions/relationship"
51942 vip-ipv6-address-list:
51945 ###### Related Nodes
51946 - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
51947 - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
51948 - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
51949 - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
51956 description: IP address
51957 vip-ipv6-prefix-length:
51960 description: Prefix length, 128 for single address
51964 description: Inner VLAN tag
51968 description: Outer VLAN tag
51971 description: Indicator of fixed or floating address
51974 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51975 neutron-network-id:
51977 description: Neutron network id of the interface that address belongs to
51980 description: Neutron id of subnet that address belongs to
51984 $ref: "#/definitions/relationship"
51985 virtual-data-center:
51987 Virtual organization of cloud infrastructure elements in a data center context
51988 ###### Related Nodes
51989 - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
51990 - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
51991 - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
51999 description: Unique ID of the vdc
52002 description: Name of the virtual data center
52005 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52009 $ref: "#/definitions/relationship"
52010 virtual-data-centers:
52012 Virtual organization of cloud infrastructure elements in a data center context
52014 virtual-data-center:
52017 $ref: "#/definitions/virtual-data-center"
52021 ###### Related Nodes
52022 - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
52023 - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
52024 - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
52025 - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
52026 - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
52027 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
52028 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
52030 -(1) IF this VLAN node is deleted, this FROM node is DELETED also
52031 -(2) IF this VLAN node is deleted, this TO node is DELETED also
52032 -(4) IF this TO node is deleted, this VLAN is DELETED also
52040 description: String that identifies the interface
52044 description: Inner VLAN tag
52048 description: Outer VLAN tag
52051 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52054 description: Captures the numeric part of the speed
52057 description: Captures the units corresponding to the speed
52060 description: Used to describe (the service associated with) the vlan
52061 backdoor-connection:
52063 description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
52066 description: This indicates the customers VPN ID associated with this vlan
52067 orchestration-status:
52069 description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
52072 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
52075 description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
52078 description: Flag indicating the interface uses the IP Unnumbered configuration.
52082 $ref: "#/definitions/relationship"
52083 l3-interface-ipv4-address-list:
52086 $ref: "#/definitions/l3-interface-ipv4-address-list"
52087 l3-interface-ipv6-address-list:
52090 $ref: "#/definitions/l3-interface-ipv6-address-list"
52096 $ref: "#/definitions/vlan"
52105 description: Unique id of VNF. This is unique across the graph.
52108 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
52109 ###### Related Nodes
52110 - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
52112 -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
52117 - application-vendor
52121 description: Unique ID of this asset
52124 description: The application that the image instantiates.
52125 application-vendor:
52127 description: The vendor of the application.
52128 application-version:
52130 description: The version of the application.
52133 description: URL to endpoint where AAI can get more details
52136 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52140 $ref: "#/definitions/relationship"
52143 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
52148 $ref: "#/definitions/vnf-image"
52151 ###### Related Nodes
52152 - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
52153 - TO instance-group( vnfc MemberOf instance-group, MANY2MANY)
52154 - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY)
52155 - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY)
52156 - TO vserver( vnfc HostedOn vserver, ONE2MANY)
52157 - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
52158 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1)
52159 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1)
52161 -(1) IF this VNFC node is deleted, this FROM node is DELETED also
52162 -(4) IF this TO node is deleted, this VNFC is DELETED also
52168 - is-closed-loop-disabled
52172 description: Unique ID of vnfc.
52175 description: Short code that is used in naming instances of the item being modeled
52178 description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
52181 description: prov status of this vnfc
52182 orchestration-status:
52184 description: Orchestration status of this VNF, mastered by APP-C
52185 ipaddress-v4-oam-vip:
52187 description: Oam V4 vip address of this vnfc
52190 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
52191 is-closed-loop-disabled:
52193 description: used to indicate whether closed loop function is enabled on this node
52196 description: Group notation of VNFC
52197 model-invariant-id:
52199 description: the ASDC model id for this resource or service model.
52202 description: the ASDC model version for this resource or service model.
52205 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52209 $ref: "#/definitions/relationship"
52210 l3-interface-ipv4-address-list:
52213 $ref: "#/definitions/l3-interface-ipv4-address-list"
52214 l3-interface-ipv6-address-list:
52217 $ref: "#/definitions/l3-interface-ipv6-address-list"
52220 virtual network components associated with a vserver from application controller.
52225 $ref: "#/definitions/vnfc"
52228 Ephemeral Block storage volume.
52229 ###### Related Nodes
52230 - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
52232 -(3) IF this FROM node is deleted, this VOLUME is DELETED also
52239 description: Unique ID of block storage volume relative to the vserver.
52242 description: URL to endpoint where AAI can get more details
52245 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52249 $ref: "#/definitions/relationship"
52252 Persistent block-level storage.
52253 ###### Related Nodes
52254 - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
52255 - TO complex( volume-group LocatedIn complex, MANY2ONE)
52256 - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
52257 - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
52258 - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
52262 - volume-group-name
52267 description: Unique ID of volume-group.
52270 description: Name of the volume group.
52273 description: Heat stack id corresponding to this volume-group
52276 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.
52277 orchestration-status:
52279 description: Orchestration status of this volume-group
52280 model-customization-id:
52282 description: captures the id of all the configuration used to customize the resource for the service.
52283 vf-module-model-customization-id:
52285 description: helps relate the volume group to the vf-module whose components will require the volume group
52288 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52292 $ref: "#/definitions/relationship"
52295 Collection of persistent block-level storage.
52300 $ref: "#/definitions/volume-group"
52303 Collection of ephemeral Block storage volumes.
52308 $ref: "#/definitions/volume"
52311 VPLS Provider Edge routers.
52312 ###### Related Nodes
52313 - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
52314 - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
52315 - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
52316 - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
52318 -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
52326 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
52329 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).
52332 description: Client should send valid enumerated value, e.g., VPLS-PE.
52336 description: Temporary location for stag to get to VCE
52339 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52343 $ref: "#/definitions/relationship"
52347 $ref: "#/definitions/p-interface"
52351 $ref: "#/definitions/lag-interface"
52354 Collection of VPLS Provider Edge routers
52359 $ref: "#/definitions/vpls-pe"
52363 ###### Related Nodes
52364 - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY)
52365 - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
52366 - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
52367 - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)
52369 -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
52370 -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
52378 description: VPN ID, globally unique within A&AI
52381 description: VPN Name
52384 description: the platform associated with the VPN example AVPN, Mobility
52387 description: Type of the vpn, should be taken from enumerated/valid values
52390 description: region of customer vpn
52393 description: id for this customer vpn
52394 route-distinguisher:
52396 description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
52399 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52403 $ref: "#/definitions/route-target"
52407 $ref: "#/definitions/relationship"
52408 description: l3-networks relate to vpn-bindings
52414 $ref: "#/definitions/vpn-binding"
52417 Virtual Servers, aka virtual machine or VM.
52418 ###### Related Nodes
52419 - TO tenant( vserver BelongsTo tenant, MANY2ONE)
52420 - TO flavor( vserver Uses flavor, MANY2ONE)
52421 - TO image( vserver Uses image, MANY2ONE)
52422 - TO pserver( vserver HostedOn pserver, MANY2ONE)
52423 - TO snapshot( vserver Uses snapshot, ONE2ONE)
52424 - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
52425 - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
52426 - FROM vce( vce HostedOn vserver, ONE2MANY)
52427 - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
52428 - FROM vf-module( vf-module Uses vserver, ONE2MANY)
52429 - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
52431 -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
52432 -(2) IF this VSERVER node is deleted, this TO node is DELETED also
52438 - is-closed-loop-disabled
52442 description: Unique identifier for this vserver relative to its tenant
52445 description: Name of vserver
52448 description: Alternative name of vserver
52451 description: Trigger for operational monitoring of this resource by Service Assurance systems.
52454 description: URL to endpoint where AAI can get more details
52457 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.
52458 is-closed-loop-disabled:
52460 description: Used to indicate whether closed loop function is enabled on this node
52463 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52467 $ref: "#/definitions/volume"
52471 $ref: "#/definitions/relationship"
52475 $ref: "#/definitions/l-interface"
52478 Collection of virtual Servers, aka virtual machines or VMs.
52483 $ref: "#/definitions/vserver"
52486 A zone is a grouping of assets in a location homing to the same connections into the CBB
52487 ###### Related Nodes
52488 - TO complex( zone LocatedIn complex, MANY2ONE)
52489 - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
52490 - FROM pnf( pnf LocatedIn zone, MANY2ONE)
52491 - FROM pserver( pserver LocatedIn zone, MANY2ONE)
52492 - FROM service-instance( service-instance LocatedIn zone, MANY2ONE)
52502 description: Code assigned by AIC to the zone
52505 description: English name associated with the zone
52508 description: Design of zone [Medium/Largeā¦]
52511 description: Context of zone [production/test]
52514 description: Status of a zone.
52517 description: Concurrency value
52521 $ref: "#/definitions/relationship"
52524 Collection of zones
52529 $ref: "#/definitions/zone"
52538 $ref: "#/patchDefinitions/action-data"
52547 APIs that are more action related than REST (e.g., notify, update).
52551 $ref: "#/patchDefinitions/update"
52554 $ref: "#/patchDefinitions/notify"
52557 Represents a slice or partial piece of a resource that gets separately allotted
52558 ###### Related Nodes
52559 - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
52560 - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
52561 - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
52562 - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
52563 - TO l-interface( allotted-resource Uses l-interface, ONE2MANY)
52564 - TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
52565 - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
52566 - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY)
52567 - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
52568 - TO model-ver( allotted-resource IsA model-ver, Many2One)
52569 - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
52570 - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3)
52571 - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
52572 - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
52574 -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
52575 -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also
52576 -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
52582 description: Allotted Resource id UUID assigned to this instance.
52585 description: The descriptive information assigned to this allotted resource instance
52588 description: Link back to more information in the controller
52589 model-invariant-id:
52591 description: the ASDC model id for this resource or service model.
52594 description: the ASDC model version for this resource or service model.
52595 persona-model-version:
52597 description: the ASDC model version for this resource or service model.
52598 allotted-resources:
52600 This object is used to store slices of services being offered
52605 $ref: "#/patchDefinitions/allotted-resource"
52608 Availability zone, a collection of compute hosts/pservers
52609 ###### Related Nodes
52610 - TO complex( availability-zone LocatedIn complex, MANY2ONE)
52611 - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
52612 - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
52613 - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
52614 - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
52615 - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
52616 - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
52617 - FROM vce( vce Uses availability-zone, MANY2MANY)
52619 -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
52620 -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
52623 - availability-zone-name
52626 availability-zone-name:
52628 description: Name of the availability zone. Unique across a cloud region
52631 description: Type of hypervisor. Source of truth should define valid values.
52632 operational-status:
52634 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
52635 availability-zones:
52637 Collection of availability zones
52642 $ref: "#/patchDefinitions/availability-zone"
52643 az-and-dvs-switches:
52647 $ref: "#/patchDefinitions/dvs-switches"
52650 $ref: "#/patchDefinitions/availability-zone"
52653 Namespace for business related constructs
52658 $ref: "#/patchDefinitions/connector"
52662 $ref: "#/patchDefinitions/customer"
52666 $ref: "#/patchDefinitions/line-of-business"
52670 $ref: "#/patchDefinitions/owning-entity"
52674 $ref: "#/patchDefinitions/platform"
52678 $ref: "#/patchDefinitions/project"
52681 ###### Related Nodes
52682 - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
52684 -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
52690 description: unique identifier of probe
52693 description: identifier of probe
52696 description: type of probe
52697 classes-of-service:
52699 class-of-service of probe
52704 $ref: "#/patchDefinitions/class-of-service"
52705 cloud-infrastructure:
52707 Namespace for cloud infrastructure.
52712 $ref: "#/patchDefinitions/complex"
52716 $ref: "#/patchDefinitions/cloud-region"
52720 $ref: "#/patchDefinitions/network-profile"
52724 $ref: "#/patchDefinitions/pserver"
52725 virtual-data-centers:
52728 $ref: "#/patchDefinitions/virtual-data-center"
52729 operational-environments:
52732 $ref: "#/patchDefinitions/operational-environment"
52735 cloud-region designates an installation of a cloud cluster or region or instantiation.
52736 ###### Related Nodes
52737 - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)(2)
52738 - TO complex( cloud-region LocatedIn complex, MANY2ONE)
52739 - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
52740 - TO zone( cloud-region LocatedIn zone, MANY2ONE)
52741 - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
52742 - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
52743 - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
52744 - FROM hpa-capability( hpa-capability BelongsTo cloud-region, MANY2ONE)
52745 - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
52746 - FROM image( image BelongsTo cloud-region, MANY2ONE)
52747 - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
52748 - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
52749 - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
52750 - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
52751 - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
52752 - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
52753 - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
52754 - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
52756 -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
52757 -(2) IF this CLOUD-REGION node is deleted, this TO node is DELETED also
52758 -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
52767 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
52770 description: Identifier used by the vendor for the region. Second part of composite key
52773 description: Type of the cloud (e.g., openstack)
52774 owner-defined-type:
52776 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
52777 cloud-region-version:
52779 description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
52782 description: URL of the keystone identity service
52785 description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
52788 description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
52791 description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation.
52794 description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
52797 description: MultiVIM will discover and expose EPA capabilities.
52803 $ref: "#/patchDefinitions/cloud-region"
52806 Collection of physical locations that can house cloud-regions.
52807 ###### Related Nodes
52808 - TO l3-network( complex Uses l3-network, MANY2MANY)
52809 - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
52810 - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
52811 - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
52812 - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY)
52813 - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
52814 - FROM pnf( pnf LocatedIn complex, MANY2ONE)
52815 - FROM pserver( pserver LocatedIn complex, MANY2ONE)
52816 - FROM vce( vce LocatedIn complex, MANY2MANY)
52817 - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
52818 - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
52819 - FROM zone( zone LocatedIn complex, MANY2ONE)
52821 -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
52822 -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
52825 - physical-location-id
52826 - physical-location-type
52833 physical-location-id:
52835 description: Unique identifier for physical location, e.g., CLLI
52838 description: Data center code which can be an alternate way to identify a complex
52841 description: Gamma complex name for LCP instance.
52844 description: URL of the keystone identity service
52847 Collection of physical locations that can house cloud-regions.
52852 $ref: "#/patchDefinitions/complex"
52855 Port Mirror Configuration.
52856 ###### Related Nodes
52857 - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
52858 - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
52859 - TO l-interface( configuration AppliesTo l-interface, ONE2MANY)
52860 - TO pnf( configuration AppliesTo pnf, ONE2MANY)
52861 - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
52862 - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
52863 - FROM service-instance( service-instance Uses configuration, ONE2MANY)
52864 - FROM forwarder( forwarder Uses configuration, ONE2ONE)(3)
52865 - FROM forwarding-path( forwarding-path Uses configuration, ONE2ONE)(3)
52866 - FROM evc( evc BelongsTo configuration, ONE2ONE)(1)
52867 - FROM forwarder-evc( forwarder-evc BelongsTo configuration, ONE2ONE)(1)
52869 -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
52870 -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
52871 -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
52874 - configuration-type
52875 - configuration-sub-type
52876 - orchestration-status
52877 - operational-status
52878 - configuration-selflink
52879 - model-customization-id
52883 description: UUID assigned to configuration.
52886 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
52887 configuration-name:
52889 description: Name of the configuration.
52890 configuration-type:
52892 description: port-mirroring-configuration.
52893 configuration-sub-type:
52895 description: vprobe, pprobe.
52896 model-invariant-id:
52898 description: the ASDC model id for this resource or service model.
52901 description: the ASDC model version for this resource or service model.
52902 orchestration-status:
52904 description: Orchestration status of the configuration.
52905 operational-status:
52907 description: Indicator for whether the resource is considered operational.
52908 configuration-selflink:
52910 description: URL to endpoint where AAI can get more details from SDN-GC.
52911 model-customization-id:
52913 description: id of the configuration used to customize the resource
52916 description: DHV Site Effective Bandwidth
52917 vendor-allowed-max-bandwidth:
52919 description: Velocloud Nominal Throughput - VNT
52922 Collection of configurations
52927 $ref: "#/patchDefinitions/configuration"
52930 Collection of resource instances used to connect a variety of disparate inventory widgets
52931 ###### Related Nodes
52932 - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
52933 - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
52934 - FROM service-instance( service-instance Uses connector, MANY2MANY)
52936 -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
52938 - resource-instance-id
52940 resource-instance-id:
52942 description: Unique id of resource instance.
52945 Collection of resource instances used to connect a variety of disparate inventory widgets
52950 $ref: "#/patchDefinitions/connector"
52951 constrained-element-set:
52953 This is how we would capture constraints defining allowed sets of elements.
52954 ###### Related Nodes
52955 - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
52956 - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
52957 - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
52959 -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
52960 -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
52962 - constrained-element-set-uuid
52966 constrained-element-set-uuid:
52972 constrained-element-sets:
52974 constrained-element-set:
52977 $ref: "#/patchDefinitions/constrained-element-set"
52980 ###### Related Nodes
52981 - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
52982 - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
52984 -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
52997 $ref: "#/patchDefinitions/ctag-assignment"
53000 A collection of C tags (vlan tags) grouped for a specific purpose.
53001 ###### Related Nodes
53002 - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
53003 - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
53004 - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY)
53005 - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
53007 -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
53010 - availability-zone-name
53011 - ctag-pool-purpose
53015 description: The Target provider edge router
53016 availability-zone-name:
53018 description: Name of the availability zone
53021 description: Describes what the intended purpose of this pool is.
53024 description: Comma separated list of ctags
53030 $ref: "#/patchDefinitions/ctag-pool"
53033 customer identifiers to provide linkage back to BSS information.
53034 ###### Related Nodes
53035 - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
53037 -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
53039 - global-customer-id
53043 global-customer-id:
53045 description: Global customer id used across ECOMP to uniquely identify customer.
53048 description: Subscriber name, an alternate way to retrieve a customer.
53051 description: Subscriber type, a way to provide VID with only the INFRA customers.
53054 Collection of customer identifiers to provide linkage back to BSS information.
53059 $ref: "#/patchDefinitions/customer"
53067 description: See mis-na-virtualization-platform.yang
53073 $ref: "#/patchDefinitions/cvlan-tag-entry"
53076 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.
53077 ###### Related Nodes
53078 - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
53079 - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
53087 description: DVS switch name
53090 description: URL used to reach the vcenter
53093 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
53098 $ref: "#/patchDefinitions/dvs-switch"
53101 Internal map to define the properties of an edge and interpret the map EdgeRules
53119 edge-tag-query-request:
53130 $ref: "#/patchDefinitions/start-node-filter"
53131 include-node-filter:
53134 $ref: "#/patchDefinitions/include-node-filter"
53138 $ref: "#/patchDefinitions/secondary-filter"
53139 edge-tag-query-result:
53141 tagged-inventory-item-list:
53144 $ref: "#/patchDefinitions/tagged-inventory-item-list"
53145 element-choice-set:
53147 This is how we would capture constraints defining allowed sets of elements.
53148 ###### Related Nodes
53149 - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
53150 - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
53152 -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
53153 -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
53155 - element-choice-set-uuid
53156 - element-choice-set-name
53158 element-choice-set-uuid:
53160 element-choice-set-name:
53164 element-choice-sets:
53166 element-choice-set:
53169 $ref: "#/patchDefinitions/element-choice-set"
53172 Metadata for entitlement group.
53173 ###### Related Nodes
53174 - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
53175 - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
53177 -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
53184 description: Unique ID for the entitlement group the resource comes from, should be uuid.
53187 description: Unique ID of an entitlement resource.
53190 Entitlements, keyed by group-uuid and resource-uuid, related to license management
53195 $ref: "#/patchDefinitions/entitlement"
53198 Persist EMS address information used by EMS driver.
53199 ###### Related Nodes
53200 - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2)
53202 -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also
53208 description: Unique ID of EMS.
53214 $ref: "#/patchDefinitions/esr-ems"
53217 Persist common address information of external systems.
53218 ###### Related Nodes
53219 - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3)
53220 - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3)
53221 - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3)
53222 - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3)
53224 -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also
53226 - esr-system-info-id
53231 esr-system-info-id:
53233 description: Unique ID of esr system info.
53236 description: name of external system.
53239 description: type of external systems.
53242 description: vendor of external systems.
53245 description: version of external systems.
53248 description: url used to access external systems.
53251 description: username used to access external systems.
53254 description: password used to access external systems.
53257 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
53260 description: protocol of third party SDNC, for example netconf/snmp.
53263 description: ca file content if enabled ssl on auth-url.
53266 description: Whether to verify VIM's certificate.
53269 description: service IP of ftp server.
53272 description: service port of ftp server.
53275 description: domain info for authentication.
53278 description: default tenant of VIM.
53281 description: ftp passive mode or not.
53284 description: resource or performance data file path.
53287 description: the status of external system.
53288 esr-system-info-list:
53290 Collection of persistent block-level external system auth info.
53295 $ref: "#/patchDefinitions/esr-system-info"
53296 esr-thirdparty-sdnc:
53298 Persist SDNC address information used by ONAP SDNC.
53299 ###### Related Nodes
53300 - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2)
53301 - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
53303 -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also
53305 - thirdparty-sdnc-id
53307 thirdparty-sdnc-id:
53309 description: Unique ID of SDNC.
53312 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
53315 description: password used to access SDNC server.
53316 esr-thirdparty-sdnc-list:
53318 esr-thirdparty-sdnc:
53321 $ref: "#/patchDefinitions/esr-thirdparty-sdnc"
53324 Persist VNFM address information used by VF-C.
53325 ###### Related Nodes
53326 - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2)
53328 -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also
53334 description: Unique ID of VNFM.
53337 description: indecate the VIM to deploy VNF.
53340 description: certificate url of VNFM.
53346 $ref: "#/patchDefinitions/esr-vnfm"
53349 evc object is an optional child object of the Configuration object.
53350 ###### Related Nodes
53351 - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
53353 -(4) IF this TO node is deleted, this EVC is DELETED also
53359 description: Unique/key field for the evc object
53360 forwarding-path-topology:
53362 description: Point-to-Point, Multi-Point
53365 description: Commited Information Rate
53368 description: CIR units
53369 connection-diversity-group-id:
53371 description: Diversity Group ID
53374 description: formerly Performance Group
53375 esp-evc-circuit-id:
53377 description: EVC Circuit ID of ESP EVC
53380 description: Committed Information Rate (For ESP)
53383 description: CIR units (For ESP)
53386 description: Identifies ESP
53387 collector-pop-clli:
53389 description: Collector POP CLLI (from the hostname of the access pnf)
53390 inter-connect-type-ingress:
53392 description: Interconnect type on ingress side of EVC.
53393 tagmode-access-ingress:
53395 description: tagode for collector side of EVC
53396 tagmode-access-egress:
53398 description: tagMode for network side of EVC
53404 $ref: "#/patchDefinitions/evc"
53407 Namespace for external system.
53411 $ref: "#/patchDefinitions/esr-ems-list"
53414 $ref: "#/patchDefinitions/esr-vnfm-list"
53415 esr-thirdparty-sdnc-list:
53417 $ref: "#/patchDefinitions/esr-thirdparty-sdnc-list"
53420 Extra properties for inventory item for response list
53425 $ref: "#/patchDefinitions/extra-property"
53435 ###### Related Nodes
53436 - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
53437 - FROM hpa-capability( hpa-capability BelongsTo flavor, MANY2ONE)
53438 - FROM vserver( vserver Uses flavor, MANY2ONE)
53440 -FLAVOR cannot be deleted if related to HPA-CAPABILITY,VSERVER
53449 description: Flavor id, expected to be unique across cloud-region.
53452 description: Cloud Region Flavor name
53456 description: Number of CPUs
53460 description: Amount of memory
53464 description: Disk space
53468 description: Amount of ephemeral disk space
53471 description: amount of swap space allocation
53474 description: whether flavor is available to all users or private to the tenant it was created in.
53477 description: URL to endpoint where AAI can get more details
53480 description: Boolean as to whether this flavor is no longer enabled
53484 $ref: "#/patchDefinitions/hpa-capability"
53485 description: List of flavor specific HPA Capabilities
53488 Collection of openstack flavors.
53493 $ref: "#/patchDefinitions/flavor"
53496 Entity describing a sequenced segment of forwarding path
53497 ###### Related Nodes
53498 - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
53499 - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
53500 - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
53501 - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
53502 - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
53504 -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
53505 -(4) IF this TO node is deleted, this FORWARDER is DELETED also
53512 description: Unique ID of this segmentation
53515 description: ingress, intermediate, egress
53518 forwarder object is an optional child object of the Configuration object.
53519 ###### Related Nodes
53520 - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
53522 -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
53528 description: Key for forwarder-evc object
53531 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
53534 description: Internal VLAN.
53537 description: SVLAN value for ingress of egress forwarder.
53540 description: CVLAN value for ingress of egress forwarder.
53546 $ref: "#/patchDefinitions/forwarder-evc"
53552 $ref: "#/patchDefinitions/forwarder"
53555 Entity that describes the sequenced forwarding path between interfaces of services or resources
53556 ###### Related Nodes
53557 - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
53558 - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
53559 - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
53561 -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
53562 -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
53563 -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
53565 - forwarding-path-id
53566 - forwarding-path-name
53568 forwarding-path-id:
53570 description: Unique ID of this FP
53571 forwarding-path-name:
53573 description: Name of the FP
53579 $ref: "#/patchDefinitions/forwarding-path"
53582 General purpose VNF
53583 ###### Related Nodes
53584 - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
53585 - TO complex( generic-vnf LocatedIn complex, MANY2MANY)
53586 - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2)
53587 - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY)
53588 - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
53589 - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
53590 - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
53591 - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
53592 - TO pnf( generic-vnf HostedOn pnf, MANY2MANY)
53593 - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
53594 - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
53595 - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
53596 - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
53597 - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
53598 - TO model-ver( generic-vnf IsA model-ver, Many2One)
53599 - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
53600 - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
53601 - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
53602 - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
53603 - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
53604 - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
53605 - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
53606 - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
53607 - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
53608 - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
53609 - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY)
53610 - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
53611 - FROM platform( platform Uses generic-vnf, MANY2MANY)
53613 -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
53614 -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also
53620 - is-closed-loop-disabled
53624 description: Unique id of VNF. This is unique across the graph.
53627 description: vnf instance id.
53630 description: Name of VNF.
53633 description: Alternate name of VNF.
53636 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.
53639 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
53640 regional-resource-zone:
53642 description: Regional way of organizing pservers, source of truth should define values
53645 description: Trigger for operational monitoring of this resource by Service Assurance systems.
53646 operational-status:
53648 description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
53651 description: OBSOLETE - do not use
53654 description: Client should send valid enumerated value
53655 orchestration-status:
53657 description: Orchestration status of this VNF, used by MSO.
53660 vnf-discriptor-name:
53662 description: vnf discriptor name
53665 description: job id corresponding to vnf
53668 description: Heat stack id corresponding to this instance, managed by MSO
53671 description: Corresponds to the SDN-C catalog id used to configure this VCE
53674 description: identifier of managed by ATT or customer
53677 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
53678 ipv4-loopback0-address:
53680 description: v4 Loopback0 address
53683 description: v6 Loopback address
53684 management-v6-address:
53686 description: v6 management address
53690 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
53693 description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
53697 description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
53700 description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
53704 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
53707 description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
53711 description: number of associated SHD in vnf.
53715 description: number of vms in vnf.
53719 description: number of network in vnf.
53722 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.
53723 is-closed-loop-disabled:
53725 description: used to indicate whether closed loop function is enabled on this node
53733 $ref: "#/patchDefinitions/generic-vnf"
53736 Openstack group-assignment used to store exclusivity groups (EG).
53737 ###### Related Nodes
53738 - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
53739 - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
53740 - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
53749 description: Group id, expected to be unique across cloud-region.
53752 description: Group type - the type of group this instance refers to
53755 description: Group name - name assigned to the group
53758 description: Group description - description of the group
53761 Collection of openstack group assignments
53766 $ref: "#/patchDefinitions/group-assignment"
53769 ###### Related Nodes
53770 - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
53772 -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
53780 description: host-route id
53783 description: subnet prefix
53786 description: Could be ip-address, hostname, or service-instance
53789 description: Should be ip-address, hostname, or service-instance to match next-hop
53795 $ref: "#/patchDefinitions/host-route"
53798 Collection of HPA Capabilities
53803 $ref: "#/patchDefinitions/hpa-capability"
53806 Represents a HPA capability
53807 ###### Related Nodes
53808 - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
53809 - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
53810 - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
53812 -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
53814 - hpa-capability-id
53819 description: UUID to uniquely identify a HPA capability
53822 description: Name of the HPACapability
53825 description: HPA schema version
53828 description: Hardware architecture
53829 hpa-feature-attributes:
53831 HPA Capability Feature attributes
53832 ###### Related Nodes
53833 - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
53835 -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
53837 - hpa-attribute-key
53841 description: name of the specific HPA attribute
53842 hpa-attribute-value:
53844 description: JSON string specifying the value, unit and type of the specific HPA attribute
53848 ###### Related Nodes
53849 - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
53850 - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
53851 - FROM vserver( vserver Uses image, MANY2ONE)
53853 -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
53854 -IMAGE cannot be deleted if related to VSERVER
53865 description: Image id, expected to be unique across cloud region
53868 description: Image name
53869 image-architecture:
53871 description: Operating system architecture.
53874 description: The common name of the operating system distribution in lowercase
53877 description: The operating system version as specified by the distributor.
53880 description: The application that the image instantiates.
53881 application-vendor:
53883 description: The vendor of the application.
53884 application-version:
53886 description: The version of the application.
53889 description: URL to endpoint where AAI can get more details
53892 Collectio of Openstack images.
53897 $ref: "#/patchDefinitions/image"
53898 include-node-filter:
53904 InstanceFilter for performing a named-query or model query
53907 InstanceFilters for performing a named-query or model query
53912 $ref: "#/patchDefinitions/instance-filter"
53915 General mechanism for grouping instances
53916 ###### Related Nodes
53917 - TO model( instance-group Targets model, MANY2MANY)
53918 - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
53919 - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
53920 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
53921 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
53922 - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY)
53923 - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
53924 - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
53925 - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
53926 - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
53927 - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
53928 - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY)
53935 instance-group-role:
53937 description: role of the instance group.
53938 model-invariant-id:
53940 description: ASDC model id for this resource or service model.
53943 description: ASDC model version uid for this resource model.
53946 description: Instance Group ID, UUID assigned to this instance.
53949 description: Descriptive text to help identify the usage of this instance-group
53952 description: Only valid value today is lower case ha for high availability
53955 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
53958 Collection of openstack route table references
53963 $ref: "#/patchDefinitions/instance-group"
53968 $ref: "#/patchDefinitions/search"
53971 $ref: "#/patchDefinitions/actions"
53972 cloud-infrastructure:
53974 $ref: "#/patchDefinitions/cloud-infrastructure"
53977 $ref: "#/patchDefinitions/external-system"
53980 $ref: "#/patchDefinitions/business"
53981 service-design-and-creation:
53983 $ref: "#/patchDefinitions/service-design-and-creation"
53986 $ref: "#/patchDefinitions/network"
53989 $ref: "#/patchDefinitions/nodes"
53992 inventory-item-type:
53994 inventory-item-link:
53996 inventory-item-data:
53999 $ref: "#/patchDefinitions/inventory-item-data"
54000 tagged-inventory-item-list:
54003 $ref: "#/patchDefinitions/tagged-inventory-item-list"
54004 inventory-item-data:
54010 inventory-response-item:
54012 Inventory item for response list
54018 $ref: "#/patchDefinitions/extra-properties"
54019 inventory-response-items:
54021 $ref: "#/patchDefinitions/inventory-response-items"
54022 inventory-response-items:
54024 Container for inventory items in response list
54026 inventory-response-item:
54029 $ref: "#/patchDefinitions/inventory-response-item"
54030 ipsec-configuration:
54032 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
54033 ###### Related Nodes
54034 - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
54035 - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
54037 -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
54039 - ipsec-configuration-id
54041 ipsec-configuration-id:
54043 description: UUID of this configuration
54044 requested-vig-address-type:
54046 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
54047 requested-encryption-strength:
54049 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
54050 requested-dmz-type:
54052 description: ATT can offer a shared DMZ or a DMZ specific to a customer
54053 shared-dmz-network-address:
54055 description: Network address of shared DMZ
54056 requested-customer-name:
54058 description: If the DMZ is a custom DMZ, this field will indicate the customer information
54061 description: can be 1 or 2
54062 ikev1-authentication:
54064 description: Contains values like md5, sha1, sha256, sha384
54067 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,ĆĀ aes-192-cbc, aes-265-cbc
54070 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
54073 description: Group name defined in VIG for clients using aggressive mode
54076 description: pre-shared key for the above group name
54079 description: Lifetime for IKEv1 SA
54080 ipsec-authentication:
54082 description: md5, sha1, sha256, sha384
54085 description: 3des-cbc, des-cbc, aes-128-cbc,ĆĀ aes-192-cbc, aes-265-cbc
54088 description: Life time for IPSec SA
54091 description: enable PFS or not
54094 description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
54095 xauth-user-password:
54097 description: Encrypted using the Juniper $9$ algorithm
54100 description: The time between DPD probe
54103 description: Maximum number of DPD before claiming the tunnel is down
54104 ipsec-configurations:
54106 ipsec-configuration:
54109 $ref: "#/patchDefinitions/ipsec-configuration"
54118 Logical interfaces, e.g., a vnic.
54119 ###### Related Nodes
54120 - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
54121 - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
54122 - TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
54123 - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
54124 - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
54125 - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
54126 - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
54127 - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
54128 - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY)
54129 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
54130 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
54131 - FROM logical-link( logical-link Source l-interface, ONE2MANY)(1)
54132 - FROM logical-link( logical-link Destination l-interface, ONE2MANY)(1)
54133 - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
54134 - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
54135 - FROM configuration( configuration AppliesTo l-interface, ONE2MANY)
54136 - FROM forwarder( forwarder ForwardsTo l-interface, MANY2ONE)
54137 - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
54139 -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
54140 -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
54141 -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
54150 description: Name given to the interface
54153 description: E.g., CUSTOMER, UPLINK, etc.
54156 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
54159 description: URL to endpoint where AAI can get more details
54162 description: ID of interface
54165 description: MAC address for the interface
54168 description: Name of the network
54171 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
54172 interface-description:
54174 description: Human friendly text regarding this interface.
54177 description: boolean indicatating whether or not port is a mirrored.
54180 Collection of logical interfaces.
54185 $ref: "#/patchDefinitions/l-interface"
54186 l3-interface-ipv4-address-list:
54189 ###### Related Nodes
54190 - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
54191 - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
54192 - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
54193 - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
54194 - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
54195 - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4)
54197 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
54199 - l3-interface-ipv4-address
54201 l3-interface-ipv4-address:
54203 description: IP address
54204 l3-interface-ipv4-prefix-length:
54207 description: Prefix length, 32 for single address
54211 description: Inner VLAN tag
54215 description: Outer VLAN tag
54218 description: Indicator of fixed or floating address
54219 l3-interface-ipv6-address-list:
54222 ###### Related Nodes
54223 - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
54224 - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
54225 - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
54226 - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
54227 - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
54228 - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4)
54230 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
54232 - l3-interface-ipv6-address
54234 l3-interface-ipv6-address:
54236 description: IP address
54237 l3-interface-ipv6-prefix-length:
54240 description: Prefix length, 128 for single address
54244 description: Inner VLAN tag
54248 description: Outer VLAN tag
54251 description: Indicator of fixed or floating address
54254 Generic network definition
54255 ###### Related Nodes
54256 - TO instance-group( l3-network MemberOf instance-group, MANY2MANY)
54257 - TO network-policy( l3-network Uses network-policy, MANY2MANY)
54258 - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
54259 - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
54260 - TO model-ver( l3-network IsA model-ver, Many2One)
54261 - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
54262 - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
54263 - FROM complex( complex Uses l3-network, MANY2MANY)
54264 - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
54265 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
54266 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
54267 - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
54268 - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
54269 - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
54270 - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
54271 - FROM tenant( tenant Uses l3-network, MANY2MANY)
54272 - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
54274 -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
54279 - is-provider-network
54280 - is-shared-network
54281 - is-external-network
54285 description: Network ID, should be uuid. Unique across A&AI.
54288 description: Name of the network, governed by some naming convention..
54291 description: Type of the network - who defines these values?
54294 description: Role the network plans - who defines these values?
54295 network-technology:
54297 description: Network technology - who defines these values?
54298 neutron-network-id:
54300 description: Neutron network id of this Interface
54303 description: Set to true if bound to VPN
54306 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
54307 network-role-instance:
54310 description: network role instance
54316 $ref: "#/patchDefinitions/l3-network"
54319 Link aggregate interface
54320 ###### Related Nodes
54321 - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
54322 - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
54323 - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
54324 - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
54325 - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
54326 - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
54327 - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
54328 - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
54329 - FROM forwarder( forwarder ForwardsTo lag-interface, MANY2ONE)
54331 -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
54332 -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
54333 -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
54340 description: Name that identifies the link aggregate interface
54341 interface-description:
54343 description: Human friendly text regarding this interface.
54346 Collection of link aggregate interfaces.
54351 $ref: "#/patchDefinitions/lag-interface"
54354 LAG links can connect lag-interfaces
54355 ###### Related Nodes
54356 - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
54357 - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
54359 -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
54365 description: Alphabetical concatenation of lag-interface names
54368 Collection of link aggregation connections
54373 $ref: "#/patchDefinitions/lag-link"
54376 Metadata for license group.
54377 ###### Related Nodes
54378 - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
54379 - TO vce( license BelongsTo vce, MANY2ONE)(4)
54381 -(4) IF this TO node is deleted, this LICENSE is DELETED also
54388 description: Unique ID for the license group the resource belongs to, should be uuid.
54391 description: Unique ID of a license resource.
54394 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
54399 $ref: "#/patchDefinitions/license"
54402 describes a line-of-business
54403 ###### Related Nodes
54404 - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
54407 - line-of-business-name
54409 line-of-business-name:
54411 description: Name of the line-of-business (product)
54414 Collection of lines-of-business
54419 $ref: "#/patchDefinitions/line-of-business"
54422 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
54423 ###### Related Nodes
54424 - TO l-interface( logical-link Source l-interface, ONE2MANY)(4)
54425 - TO l-interface( logical-link Destination l-interface, ONE2MANY)(4)
54426 - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
54427 - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
54428 - TO lag-link( logical-link Uses lag-link, MANY2MANY)
54429 - TO logical-link( logical-link Uses logical-link, MANY2MANY)
54430 - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
54431 - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
54432 - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
54433 - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
54434 - TO model-ver( logical-link IsA model-ver, Many2One)
54435 - FROM configuration( configuration Uses logical-link, ONE2MANY)(3)
54436 - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)
54437 - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
54438 - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
54439 - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
54440 - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
54441 - FROM logical-link( logical-link Uses logical-link, MANY2MANY)
54443 -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
54444 -(4) IF this TO node is deleted, this LOGICAL-LINK is DELETED also
54452 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
54455 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.
54458 description: Type of logical link, e.g., evc
54461 description: Captures the numeric part of the speed
54464 description: Captures the units corresponding to the speed
54467 description: v4, v6, or ds for dual stack
54470 description: For example, static or BGP
54473 Collection of logical connections
54478 $ref: "#/patchDefinitions/logical-link"
54481 Collection of metadatum (key/value pairs)
54486 $ref: "#/patchDefinitions/metadatum"
54490 ###### Related Nodes
54491 - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4)
54492 - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
54493 - TO image( metadatum BelongsTo image, MANY2ONE)(4)
54494 - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
54495 - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
54497 -(4) IF this TO node is deleted, this METADATUM is DELETED also
54508 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
54509 ###### Related Nodes
54510 - TO model( model-ver BelongsTo model, MANY2ONE)(1)
54511 - FROM instance-group( instance-group Targets model, MANY2MANY)
54512 - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
54513 - FROM named-query( named-query AppliesTo model, ONE2MANY)
54514 - FROM named-query-element( named-query-element IsA model, MANY2ONE)
54516 -(1) IF this MODEL node is deleted, this FROM node is DELETED also
54517 -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
54520 - model-invariant-id
54523 model-invariant-id:
54525 description: Unique identifier corresponding to the main definition of a model in ASDC
54528 description: Type of the model, e.g., service, resource, widget, etc.
54529 model-and-named-query-search:
54531 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
54535 $ref: "#/patchDefinitions/query-parameters"
54538 $ref: "#/patchDefinitions/instance-filters"
54541 $ref: "#/patchDefinitions/secondary-filts"
54544 secondary-filter-cut-point:
54548 This is how we would capture constraints defining allowed sets of elements.
54549 ###### Related Nodes
54550 - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
54551 - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
54553 -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
54554 -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
54556 - model-constraint-uuid
54557 - constrained-element-set-uuid-to-replace
54559 model-constraint-uuid:
54561 constrained-element-set-uuid-to-replace:
54563 constrained-element-sets:
54566 $ref: "#/patchDefinitions/constrained-element-set"
54572 $ref: "#/patchDefinitions/model-constraint"
54575 Defines how other models combine to make up a higher-level model.
54576 ###### Related Nodes
54577 - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
54578 - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
54579 - TO model-ver( model-element IsA model-ver, MANY2ONE)
54580 - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
54581 - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
54582 - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
54583 - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
54585 -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
54586 -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
54588 - model-element-uuid
54589 - new-data-del-flag
54592 model-element-uuid:
54596 description: Indicates whether this element was created as part of instantiation from this model
54599 description: How many of this type of element are required/allowed
54607 $ref: "#/patchDefinitions/model-element"
54610 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
54611 ###### Related Nodes
54612 - TO model( model-ver BelongsTo model, MANY2ONE)(4)
54613 - FROM model-element( model-element IsA model-ver, MANY2ONE)
54614 - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
54615 - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
54616 - FROM allotted-resource( allotted-resource IsA model-ver, Many2One)
54617 - FROM generic-vnf( generic-vnf IsA model-ver, Many2One)
54618 - FROM l3-network( l3-network IsA model-ver, Many2One)
54619 - FROM logical-link( logical-link IsA model-ver, Many2One)
54620 - FROM service-instance( service-instance IsA model-ver, Many2One)
54621 - FROM vf-module( vf-module IsA model-ver, Many2One)
54623 -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
54624 -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
54625 -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
54634 description: Unique identifier corresponding to one version of a model in ASDC
54637 description: Name of the model, which can change from version to version.
54640 description: Version
54641 distribution-status:
54643 description: Distribution Status
54646 description: Description
54652 $ref: "#/patchDefinitions/model-ver"
54655 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
54660 $ref: "#/patchDefinitions/model"
54661 multicast-configuration:
54663 ###### Related Nodes
54664 - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
54667 - multicast-configuration-id
54668 - multicast-protocol
54671 multicast-configuration-id:
54673 description: Unique id of multicast configuration.
54674 multicast-protocol:
54676 description: protocol of multicast configuration
54679 description: rp type of multicast configuration
54680 multicast-configurations:
54682 multicast configuration of generic-vnf ip-address
54684 multicast-configuration:
54687 $ref: "#/patchDefinitions/multicast-configuration"
54693 $ref: "#/patchDefinitions/named-query"
54697 ###### Related Nodes
54698 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
54699 - TO model( named-query AppliesTo model, ONE2MANY)
54700 - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
54702 -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
54706 - named-query-version
54712 named-query-version:
54714 required-input-param:
54718 named-query-element:
54721 ###### Related Nodes
54722 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
54723 - TO model( named-query-element IsA model, MANY2ONE)
54724 - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
54725 - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
54726 - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
54727 - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
54729 -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
54730 -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
54732 - named-query-element-uuid
54734 named-query-element-uuid:
54736 property-collect-list:
54738 named-query-elements:
54740 named-query-element:
54743 $ref: "#/patchDefinitions/named-query-element"
54746 Namespace for network inventory resources.
54751 $ref: "#/patchDefinitions/logical-link"
54755 $ref: "#/patchDefinitions/site-pair-set"
54759 $ref: "#/patchDefinitions/vpn-binding"
54763 $ref: "#/patchDefinitions/vpls-pe"
54764 multicast-configurations:
54767 $ref: "#/patchDefinitions/multicast-configuration"
54771 $ref: "#/patchDefinitions/vce"
54775 $ref: "#/patchDefinitions/vnfc"
54779 $ref: "#/patchDefinitions/l3-network"
54783 $ref: "#/patchDefinitions/network-policy"
54787 $ref: "#/patchDefinitions/generic-vnf"
54791 $ref: "#/patchDefinitions/lag-link"
54795 $ref: "#/patchDefinitions/newvce"
54799 $ref: "#/patchDefinitions/pnf"
54803 $ref: "#/patchDefinitions/physical-link"
54804 ipsec-configurations:
54807 $ref: "#/patchDefinitions/ipsec-configuration"
54808 route-table-references:
54811 $ref: "#/patchDefinitions/route-table-reference"
54815 $ref: "#/patchDefinitions/instance-group"
54819 $ref: "#/patchDefinitions/zone"
54823 $ref: "#/patchDefinitions/configuration"
54827 $ref: "#/patchDefinitions/forwarding-path"
54833 $ref: "#/patchDefinitions/network-policy"
54836 ###### Related Nodes
54837 - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
54838 - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
54841 - network-policy-id
54845 description: UUID representing unique key to this instance
54846 network-policy-fqdn:
54848 description: Contrail FQDN for the policy
54851 description: ID for the openStack Heat instance
54854 Network profile populated by SDN-GP for SNMP
54855 ###### Related Nodes
54856 - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
54863 description: Unique name of network profile.
54866 description: Encrypted SNMP community string
54869 Collection of network profiles
54874 $ref: "#/patchDefinitions/network-profile"
54877 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
54878 ###### Related Nodes
54879 - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
54881 -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
54889 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
54892 description: Name of VNF.
54895 description: Alternate name of VNF.
54898 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.
54901 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
54902 operational-status:
54904 description: Indicator for whether the resource is considered operational
54907 description: OBSOLETE - do not use
54910 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).
54913 description: Client should send valid enumerated value.
54916 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
54921 $ref: "#/patchDefinitions/newvce"
54924 inventory-item-data:
54927 $ref: "#/patchDefinitions/inventory-item-data"
54928 notification-event:
54932 notification-event-header:
54934 $ref: "#/patchDefinitions/notification-event-header"
54935 notification-event-header:
54976 $ref: "#/patchDefinitions/key-data"
54981 OAM network, to be deprecated shortly. Do not use for new purposes.
54982 ###### Related Nodes
54983 - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
54984 - TO complex( oam-network AppliesTo complex, MANY2MANY)
54985 - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
54994 description: UUID of the network. Unique across a cloud-region
54997 description: Name of the network.
55001 description: cvlan-id
55002 ipv4-oam-gateway-address:
55004 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
55005 ipv4-oam-gateway-address-prefix-length:
55008 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
55011 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
55016 $ref: "#/patchDefinitions/oam-network"
55017 operational-environment:
55019 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
55020 ###### Related Nodes
55021 - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
55022 - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
55025 - operational-environment-id
55026 - operational-environment-name
55027 - operational-environment-type
55028 - operational-environment-status
55032 operational-environment-id:
55034 description: UUID of an operational environment
55035 operational-environment-name:
55037 description: Operational Environment name
55038 operational-environment-type:
55040 description: Operational Environment Type.
55041 operational-environment-status:
55043 description: Status
55046 description: Tenant Context.
55049 description: Workload Context.
55050 operational-environments:
55052 a logical partition of the cloud which allows to have multiple environments in the production AIC.
55054 operational-environment:
55057 $ref: "#/patchDefinitions/operational-environment"
55060 Allows for legacy POST of old-style and new-style models
55062 - model-invariant-id
55063 - model-name-version-id
55069 model-invariant-id:
55071 description: Unique identifier corresponding to the main definition of a model in ASDC
55072 model-name-version-id:
55074 description: Unique identifier corresponding to one version of a model in ASDC
55077 description: Type of the model, e.g., service, resource, widget, etc.
55080 description: Name of the model, which can change from version to version.
55083 description: Invariant unique ID which does not change from version to version
55086 description: Version
55089 description: Description
55092 Collection of owning-entities
55097 $ref: "#/patchDefinitions/owning-entity"
55100 describes an owning-entity
55101 ###### Related Nodes
55102 - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
55106 - owning-entity-name
55110 description: UUID of an owning entity
55111 owning-entity-name:
55113 description: Owning entity name
55116 Physical interface (e.g., nic)
55117 ###### Related Nodes
55118 - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
55119 - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
55120 - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
55121 - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
55122 - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
55123 - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
55124 - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
55125 - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1)
55126 - FROM forwarder( forwarder ForwardsTo p-interface, MANY2ONE)
55128 -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
55129 -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
55130 -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
55137 description: Name that identifies the physical interface
55140 description: URL to endpoint where AAI can get more details.
55143 description: Captures the numeric part of the speed
55146 description: Captures the units corresponding to the speed
55149 description: Nature of the services and connectivity on this port.
55150 equipment-identifier:
55152 description: CLEI or other specification for p-interface hardware.
55155 description: Role specification for p-interface hardware.
55158 description: Indicates the physical properties of the interface.
55161 description: Trigger for operational monitoring of this resource by Service Assurance systems.
55164 description: MAC Address of the p-interface.
55167 Collection of physical interfaces.
55172 $ref: "#/patchDefinitions/p-interface"
55175 Collection of physical connections, typically between p-interfaces
55176 ###### Related Nodes
55177 - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
55179 -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
55185 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
55188 description: Captures the numeric part of the speed
55191 description: Captures the units corresponding to the speed
55194 description: Circuit it
55197 description: Dual access mode (e.g., primary, secondary
55200 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
55201 service-provider-name:
55203 description: Name of the service Provider on this link.
55204 service-provider-bandwidth-up-value:
55207 description: Upstream Bandwidth value agreed with the service provider
55208 service-provider-bandwidth-up-units:
55210 description: Units for the upstream BW value
55211 service-provider-bandwidth-down-value:
55214 description: Downstream Bandwidth value agreed with the service provider
55215 service-provider-bandwidth-down-units:
55217 description: Units for downstream BW value
55220 Collection of physical connections, typically between p-interfaces
55225 $ref: "#/patchDefinitions/physical-link"
55228 describes a platform
55229 ###### Related Nodes
55230 - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
55237 description: Name of the platform
55240 Collection of platforms
55245 $ref: "#/patchDefinitions/platform"
55248 PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
55249 ###### Related Nodes
55250 - TO complex( pnf LocatedIn complex, MANY2ONE)
55251 - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
55252 - TO zone( pnf LocatedIn zone, MANY2ONE)
55253 - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many)
55254 - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY)
55255 - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
55256 - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
55257 - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
55258 - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
55259 - FROM configuration( configuration AppliesTo pnf, ONE2MANY)
55261 -(1) IF this PNF node is deleted, this FROM node is DELETED also
55268 description: unique name of Physical Network Function.
55271 description: name of Physical Network Function.
55274 description: URL to endpoint where AAI can get more details.
55277 description: source of name2
55280 description: id of pnf
55283 description: Equipment type. Source of truth should define valid values.
55286 description: Equipment vendor. Source of truth should define valid values.
55289 description: Equipment model. Source of truth should define valid values.
55292 description: identifier of managed by ATT or customer
55295 description: ipv4-oam-address with new naming convention for IP addresses
55298 description: sw-version is the version of SW for the hosted application on the PNF.
55301 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.
55304 description: ID of the physical frame (relay rack) where pnf is installed.
55307 description: Serial number of the device
55308 ipaddress-v4-loopback-0:
55310 description: IPV4 Loopback 0 address
55311 ipaddress-v6-loopback-0:
55313 description: IPV6 Loopback 0 address
55316 description: IPV4 AIM address
55319 description: IPV6 AIM address
55322 description: IPV6 OAM address
55325 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
55328 Collection of Physical Network Functions.
55333 $ref: "#/patchDefinitions/pnf"
55336 Used to capture the network interfaces of this VCE
55337 ###### Related Nodes
55338 - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
55339 - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
55341 -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
55342 -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
55345 - orchestration-status
55349 description: Unique ID of the interface
55350 neutron-network-id:
55352 description: Neutron network id of this Interface
55353 neutron-network-name:
55355 description: Neutron network name of this Interface
55358 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
55364 $ref: "#/patchDefinitions/port-group"
55367 describes the project
55368 ###### Related Nodes
55369 - TO service-instance( project Uses service-instance, ONE2MANY)
55376 description: Name of the project deploying a service
55379 Collection of projects
55384 $ref: "#/patchDefinitions/project"
55387 Property holder for query properties or instance properties
55393 property-constraint:
55396 ###### Related Nodes
55397 - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
55399 -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
55401 - property-constraint-uuid
55406 property-constraint-uuid:
55414 property-constraints:
55416 property-constraint:
55419 $ref: "#/patchDefinitions/property-constraint"
55422 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
55423 ###### Related Nodes
55424 - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
55425 - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
55426 - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
55427 - TO complex( pserver LocatedIn complex, MANY2ONE)
55428 - TO zone( pserver LocatedIn zone, MANY2ONE)
55429 - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
55430 - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
55431 - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
55432 - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
55433 - FROM vserver( vserver HostedOn pserver, MANY2ONE)
55435 -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
55436 -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
55444 description: Value from executing hostname on the compute node.
55447 description: PTNII name
55451 description: Number of cpus
55455 description: Disk size, in GBs
55459 description: RAM size, in MBs
55462 description: Equipment type. Source of truth should define valid values.
55465 description: Equipment vendor. Source of truth should define valid values.
55468 description: Equipment model. Source of truth should define valid values.
55471 description: Fully-qualified domain name
55474 description: URL to endpoint where AAI can get more details
55477 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
55480 description: Serial number, may be queried
55481 ipaddress-v4-loopback-0:
55483 description: IPV4 Loopback 0 address
55484 ipaddress-v6-loopback-0:
55486 description: IPV6 Loopback 0 address
55489 description: IPV4 AIM address
55492 description: IPV6 AIM address
55495 description: IPV6 OAM address
55498 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
55501 description: ID of Pserver
55504 description: internet topology of Pserver
55507 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.
55510 Collection of compute hosts.
55515 $ref: "#/patchDefinitions/pserver"
55518 QueryParameters for performing a named-query or model query
55522 $ref: "#/patchDefinitions/named-query"
55525 $ref: "#/patchDefinitions/overloaded-model"
55529 ###### Related Nodes
55530 - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
55532 -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
55534 - related-lookup-uuid
55536 - source-node-property
55538 - target-node-property
55540 related-lookup-uuid:
55544 source-node-property:
55548 target-node-property:
55550 property-collect-list:
55557 $ref: "#/patchDefinitions/related-lookup"
55558 related-to-property:
55562 description: Key part of a key/value pair
55565 description: Value part of a key/value pair
55570 description: A keyword provided by A&AI to indicate type of node.
55571 relationship-label:
55573 description: The edge label for this relationship.
55576 description: URL to the object in A&AI.
55580 $ref: "#/patchDefinitions/relationship-data"
55581 related-to-property:
55584 $ref: "#/patchDefinitions/related-to-property"
55588 - relationship-value
55592 description: A keyword provided by A&AI to indicate an attribute.
55593 relationship-value:
55595 description: Value of the attribute.
55596 reserved-prop-names:
55598 Internal map to define some reserved properties of a vertex
55600 last-mod-source-of-truth:
55618 Response container for the results of a named-query or model query
55620 inventory-response-items:
55622 $ref: "#/patchDefinitions/inventory-response-items"
55627 description: The specific type of node in the A&AI graph
55630 description: The URL to the specific resource
55631 route-table-reference:
55633 Openstack route table reference.
55634 ###### Related Nodes
55635 - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
55638 - route-table-reference-id
55639 - route-table-reference-fqdn
55641 route-table-reference-id:
55643 description: Route Table Reference id, UUID assigned to this instance.
55644 route-table-reference-fqdn:
55646 description: FQDN entry in the route table.
55647 route-table-references:
55649 Collection of openstack route table references
55651 route-table-reference:
55654 $ref: "#/patchDefinitions/route-table-reference"
55657 Route target information
55658 ###### Related Nodes
55659 - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
55661 -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
55663 - global-route-target
55664 - route-target-role
55666 global-route-target:
55668 description: Number used to identify an RT, globally unique in the network
55671 description: Role assigned to this route target
55674 Collection of route target information
55679 $ref: "#/patchDefinitions/route-target"
55682 ###### Related Nodes
55683 - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
55684 - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
55686 -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
55687 -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
55689 - routing-instance-id
55691 routing-instance-id:
55693 description: Unique id of routing instance
55696 description: rpm owner
55699 set of probes related to generic-vnf routing instance
55704 $ref: "#/patchDefinitions/routing-instance"
55709 $ref: "#/patchDefinitions/oam-networks"
55710 az-and-dvs-switches:
55713 $ref: "#/patchDefinitions/az-and-dvs-switches"
55716 edge-tag-query-result:
55718 $ref: "#/patchDefinitions/edge-tag-query-result"
55719 edge-tag-query-request:
55721 $ref: "#/patchDefinitions/edge-tag-query-request"
55724 $ref: "#/patchDefinitions/search-results"
55727 $ref: "#/patchDefinitions/sdn-zone-response"
55733 $ref: "#/patchDefinitions/result-data"
55736 SecondaryFilt for performing a named-query or model query
55747 SecondaryFilts for performing a named-query or model query
55752 $ref: "#/patchDefinitions/secondary-filt"
55753 segmentation-assignment:
55755 Openstack segmentation assignment.
55756 ###### Related Nodes
55757 - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
55759 -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
55765 description: Route Table Reference id, UUID assigned to this instance.
55766 segmentation-assignments:
55768 Collection of openstack segmentation assignments
55770 segmentation-assignment:
55773 $ref: "#/patchDefinitions/segmentation-assignment"
55776 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
55779 - service-description
55783 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
55784 service-description:
55786 description: Description of the service
55789 description: URL to endpoint where AAI can get more details
55790 service-capabilities:
55792 Collection of service capabilities.
55794 service-capability:
55797 $ref: "#/patchDefinitions/service-capability"
55798 service-capability:
55800 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
55801 ###### Related Nodes
55802 - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
55803 - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
55805 -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
55813 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
55816 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.
55817 service-design-and-creation:
55819 Namespace for objects managed by ASDC
55824 $ref: "#/patchDefinitions/vnf-image"
55828 $ref: "#/patchDefinitions/service"
55829 service-capabilities:
55832 $ref: "#/patchDefinitions/service-capability"
55836 $ref: "#/patchDefinitions/model"
55840 $ref: "#/patchDefinitions/named-query"
55843 Instance of a service
55844 ###### Related Nodes
55845 - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
55846 - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
55847 - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE)
55848 - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
55849 - TO configuration( service-instance Uses configuration, ONE2MANY)
55850 - TO connector( service-instance Uses connector, MANY2MANY)
55851 - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
55852 - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
55853 - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
55854 - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
55855 - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
55856 - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
55857 - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
55858 - TO zone( service-instance LocatedIn zone, MANY2ONE)
55859 - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
55860 - TO vce( service-instance ComposedOf vce, ONE2MANY)
55861 - TO model-ver( service-instance IsA model-ver, Many2One)
55862 - FROM project( project Uses service-instance, ONE2MANY)
55863 - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
55864 - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
55865 - FROM forwarding-path( forwarding-path AppliesTo service-instance, MANY2ONE)(1)
55866 - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
55868 -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
55869 -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
55870 -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
55872 - service-instance-id
55874 service-instance-id:
55876 description: Uniquely identifies this instance of a service
55877 service-instance-name:
55879 description: This field will store a name assigned to the service-instance.
55882 description: String capturing type of service.
55885 description: String capturing the service role.
55886 environment-context:
55888 description: This field will store the environment context assigned to the service-instance.
55891 description: This field will store the workload context assigned to the service-instance.
55894 description: create time of Network Service.
55897 description: last update of Network Service.
55900 description: short description for service-instance.
55901 model-invariant-id:
55903 description: the ASDC model id for this resource or service model.
55906 description: the ASDC model version for this resource or service model.
55907 persona-model-version:
55909 description: the ASDC model version for this resource or service model.
55912 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
55913 widget-model-version:
55915 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
55918 description: Indicates the total bandwidth to be used for this service.
55921 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
55922 bandwidth-down-wan1:
55924 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
55927 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
55928 bandwidth-down-wan2:
55930 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
55933 description: URL customers will use to access the vHN Portal.
55934 service-instance-location-id:
55936 description: An identifier that customers assign to the location where this service is being used.
55939 Collection of service instances
55944 $ref: "#/patchDefinitions/service-instance"
55945 service-subscription:
55947 Object that group service instances.
55948 ###### Related Nodes
55949 - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
55950 - TO tenant( service-subscription Uses tenant, MANY2MANY)
55951 - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
55953 -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
55954 -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
55960 description: Value defined by orchestration to identify this service across ECOMP.
55961 temp-ub-sub-account-id:
55963 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
55964 service-subscriptions:
55966 Collection of objects that group service instances.
55968 service-subscription:
55971 $ref: "#/patchDefinitions/service-subscription"
55974 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
55979 $ref: "#/patchDefinitions/service"
55982 ###### Related Nodes
55983 - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
55984 - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
55986 -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
55987 -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
55993 description: unique identifier of probe
55996 description: Prefix address
55999 description: Prefix address
56002 description: ip version, v4, v6
56003 destination-hostname:
56005 description: Hostname of the destination equipment to which SLAs are measured against.
56006 destination-equip-type:
56008 description: The type of destinatination equipment. Could be Router, UCPE, etc.
56011 Set of instances for probes used to measure service level agreements
56012 ###### Related Nodes
56013 - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
56014 - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
56016 -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
56022 description: Unique id of site pair set.
56025 Collection of sets of instances for probes related to generic-vnf
56030 $ref: "#/patchDefinitions/site-pair-set"
56038 $ref: "#/patchDefinitions/site-pair"
56042 ###### Related Nodes
56043 - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
56044 - FROM vserver( vserver Uses snapshot, ONE2ONE)
56051 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
56054 description: Snapshot name
56055 snapshot-architecture:
56057 description: Operating system architecture
56058 snapshot-os-distro:
56060 description: The common name of the operating system distribution in lowercase
56061 snapshot-os-version:
56063 description: The operating system version as specified by the distributor.
56066 description: The application that the image instantiates.
56067 application-vendor:
56069 description: The vendor of the application.
56070 application-version:
56072 description: The version of the application.
56075 description: URL to endpoint where AAI can get more details
56078 description: This field contains the UUID of the previous snapshot (if any).
56081 Collection of openstack snapshots
56086 $ref: "#/patchDefinitions/snapshot"
56089 SR-IOV Physical Function
56090 ###### Related Nodes
56091 - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
56092 - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
56094 -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
56100 description: Identifier for the sriov-pf
56103 Collection of SR-IOV Physical Functions.
56108 $ref: "#/patchDefinitions/sriov-pf"
56111 SR-IOV Virtual Function (not to be confused with virtual network function)
56112 ###### Related Nodes
56113 - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
56114 - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE)
56116 -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
56122 description: PCI ID used to identify the sriov-vf
56125 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
56128 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
56131 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
56132 vf-vlan-anti-spoof-check:
56134 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.
56135 vf-mac-anti-spoof-check:
56137 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.
56140 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
56141 vf-broadcast-allow:
56143 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
56144 vf-unknown-multicast-allow:
56146 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
56147 vf-unknown-unicast-allow:
56149 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
56152 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
56155 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
56158 Collection of SR-IOV Virtual Functions.
56163 $ref: "#/patchDefinitions/sriov-vf"
56172 ###### Related Nodes
56173 - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
56174 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
56175 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
56176 - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1)
56177 - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
56178 - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
56180 -(1) IF this SUBNET node is deleted, this FROM node is DELETED also
56181 -(4) IF this TO node is deleted, this SUBNET is DELETED also
56182 -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
56190 description: Subnet ID, should be UUID.
56193 description: Name associated with the subnet.
56196 description: Neutron id of this subnet
56199 description: gateway ip address
56200 network-start-address:
56202 description: network start address
56205 description: cidr mask
56208 description: ip version
56209 orchestration-status:
56211 description: Orchestration status of this VNF, mastered by MSO
56214 description: dhcp enabled
56217 description: the start address reserved for use by dhcp
56220 description: the last address reserved for use by dhcp
56223 description: role of the subnet, referenced when assigning IPs
56224 ip-assignment-direction:
56226 description: ip address assignment direction of the subnet
56232 $ref: "#/patchDefinitions/subnet"
56233 tagged-inventory-item-list:
56238 $ref: "#/patchDefinitions/inventory-item"
56242 ###### Related Nodes
56243 - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
56244 - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
56245 - TO l3-network( tenant Uses l3-network, MANY2MANY)
56246 - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
56247 - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
56248 - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
56250 -TENANT cannot be deleted if related to VSERVER
56258 description: Unique id relative to the cloud-region.
56261 description: Readable name of tenant
56264 description: This field will store the tenant context.
56267 Collection of openstack tenants.
56272 $ref: "#/patchDefinitions/tenant"
56275 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
56276 ###### Related Nodes
56277 - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
56279 -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
56285 description: Allotted Resource id UUID assigned to this instance.
56288 description: The WAN uplink bandwidth for WAN1
56289 bandwidth-down-wan1:
56291 description: The WAN downlink bandwidth for WAN1
56294 description: The WAN uplink bandwidth for WAN2
56295 bandwidth-down-wan2:
56297 description: The WAN downlink bandwidth for WAN2
56300 This object is used to store the specific tunnel cross connect aspects of an allotted resource
56305 $ref: "#/patchDefinitions/tunnel-xconnect"
56308 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
56317 $ref: "#/patchDefinitions/update-node-key"
56323 $ref: "#/patchDefinitions/action"
56332 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
56333 ###### Related Nodes
56334 - TO availability-zone( vce Uses availability-zone, MANY2MANY)
56335 - TO complex( vce LocatedIn complex, MANY2MANY)
56336 - TO vserver( vce HostedOn vserver, ONE2MANY)
56337 - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
56338 - FROM license( license BelongsTo vce, MANY2ONE)(1)
56339 - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
56340 - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
56342 -(1) IF this VCE node is deleted, this FROM node is DELETED also
56350 description: Unique id of VNF. This is unique across the graph.
56353 description: Name of VNF.
56356 description: Alternate name of VNF.
56359 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.
56362 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
56363 regional-resource-zone:
56365 description: Regional way of organizing pservers, source of truth should define values
56368 description: Trigger for operational monitoring of this resource by Service Assurance systems.
56369 operational-status:
56371 description: Indicator for whether the resource is considered operational
56374 description: OBSOLETE - do not use
56377 description: Network role being played by this VNF
56378 orchestration-status:
56380 description: Orchestration status of this VNF, mastered by MSO
56383 description: Heat stack id corresponding to this instance, managed by MSO
56386 description: Corresponds to the SDN-C catalog id used to configure this VCE
56389 description: Unique ID of VPE connected to this VCE.
56390 v6-vce-wan-address:
56392 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
56395 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
56398 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
56403 $ref: "#/patchDefinitions/vce"
56406 a deployment unit of VNFCs
56407 ###### Related Nodes
56408 - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
56409 - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
56410 - TO vnfc( vf-module Uses vnfc, ONE2MANY)
56411 - TO volume-group( vf-module Uses volume-group, ONE2ONE)
56412 - TO vserver( vf-module Uses vserver, ONE2MANY)
56413 - TO model-ver( vf-module IsA model-ver, Many2One)
56415 -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
56416 -VF-MODULE cannot be deleted if related to VNFC
56420 - is-base-vf-module
56424 description: Unique ID of vf-module.
56427 description: Name of vf-module
56430 description: Heat stack id corresponding to this instance.
56431 orchestration-status:
56433 description: orchestration status of this vf-module, mastered by MSO
56436 description: used to indicate whether or not this object is base vf module
56439 Collection of vf-modules, a deployment unit of VNFCs
56444 $ref: "#/patchDefinitions/vf-module"
56447 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
56448 ###### Related Nodes
56449 - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
56451 -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
56457 description: indicates whether the VIG is for AVPN or INTERNET
56460 description: v4 IP of the vig server
56463 description: v6 IP of the vig server
56469 $ref: "#/patchDefinitions/vig-server"
56470 vip-ipv4-address-list:
56473 ###### Related Nodes
56474 - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
56475 - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
56476 - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
56477 - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
56484 description: IP address
56485 vip-ipv4-prefix-length:
56488 description: Prefix length, 32 for single address
56492 description: Inner VLAN tag
56496 description: Outer VLAN tag
56499 description: Indicator of fixed or floating address
56500 vip-ipv6-address-list:
56503 ###### Related Nodes
56504 - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
56505 - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
56506 - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
56507 - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
56514 description: IP address
56515 vip-ipv6-prefix-length:
56518 description: Prefix length, 128 for single address
56522 description: Inner VLAN tag
56526 description: Outer VLAN tag
56529 description: Indicator of fixed or floating address
56530 virtual-data-center:
56532 Virtual organization of cloud infrastructure elements in a data center context
56533 ###### Related Nodes
56534 - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
56535 - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
56536 - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
56544 description: Unique ID of the vdc
56547 description: Name of the virtual data center
56548 virtual-data-centers:
56550 Virtual organization of cloud infrastructure elements in a data center context
56552 virtual-data-center:
56555 $ref: "#/patchDefinitions/virtual-data-center"
56559 ###### Related Nodes
56560 - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
56561 - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
56562 - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
56563 - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
56564 - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
56565 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
56566 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
56568 -(1) IF this VLAN node is deleted, this FROM node is DELETED also
56569 -(2) IF this VLAN node is deleted, this TO node is DELETED also
56570 -(4) IF this TO node is deleted, this VLAN is DELETED also
56578 description: String that identifies the interface
56582 description: Inner VLAN tag
56586 description: Outer VLAN tag
56592 $ref: "#/patchDefinitions/vlan"
56601 description: Unique id of VNF. This is unique across the graph.
56604 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
56605 ###### Related Nodes
56606 - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
56608 -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
56613 - application-vendor
56617 description: Unique ID of this asset
56620 description: The application that the image instantiates.
56621 application-vendor:
56623 description: The vendor of the application.
56624 application-version:
56626 description: The version of the application.
56629 description: URL to endpoint where AAI can get more details
56632 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
56637 $ref: "#/patchDefinitions/vnf-image"
56640 ###### Related Nodes
56641 - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
56642 - TO instance-group( vnfc MemberOf instance-group, MANY2MANY)
56643 - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY)
56644 - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY)
56645 - TO vserver( vnfc HostedOn vserver, ONE2MANY)
56646 - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
56647 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1)
56648 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1)
56650 -(1) IF this VNFC node is deleted, this FROM node is DELETED also
56651 -(4) IF this TO node is deleted, this VNFC is DELETED also
56657 - is-closed-loop-disabled
56661 description: Unique ID of vnfc.
56664 description: Short code that is used in naming instances of the item being modeled
56667 description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
56670 description: prov status of this vnfc
56671 orchestration-status:
56673 description: Orchestration status of this VNF, mastered by APP-C
56674 ipaddress-v4-oam-vip:
56676 description: Oam V4 vip address of this vnfc
56679 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
56680 is-closed-loop-disabled:
56682 description: used to indicate whether closed loop function is enabled on this node
56685 description: Group notation of VNFC
56686 model-invariant-id:
56688 description: the ASDC model id for this resource or service model.
56691 description: the ASDC model version for this resource or service model.
56694 virtual network components associated with a vserver from application controller.
56699 $ref: "#/patchDefinitions/vnfc"
56702 Ephemeral Block storage volume.
56703 ###### Related Nodes
56704 - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
56706 -(3) IF this FROM node is deleted, this VOLUME is DELETED also
56713 description: Unique ID of block storage volume relative to the vserver.
56716 description: URL to endpoint where AAI can get more details
56719 Persistent block-level storage.
56720 ###### Related Nodes
56721 - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
56722 - TO complex( volume-group LocatedIn complex, MANY2ONE)
56723 - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
56724 - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
56725 - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
56729 - volume-group-name
56734 description: Unique ID of volume-group.
56737 description: Name of the volume group.
56740 description: Heat stack id corresponding to this volume-group
56743 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.
56744 orchestration-status:
56746 description: Orchestration status of this volume-group
56747 model-customization-id:
56749 description: captures the id of all the configuration used to customize the resource for the service.
56750 vf-module-model-customization-id:
56752 description: helps relate the volume group to the vf-module whose components will require the volume group
56755 Collection of persistent block-level storage.
56760 $ref: "#/patchDefinitions/volume-group"
56763 Collection of ephemeral Block storage volumes.
56768 $ref: "#/patchDefinitions/volume"
56771 VPLS Provider Edge routers.
56772 ###### Related Nodes
56773 - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
56774 - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
56775 - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
56776 - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
56778 -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
56786 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
56789 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).
56792 description: Client should send valid enumerated value, e.g., VPLS-PE.
56796 description: Temporary location for stag to get to VCE
56799 Collection of VPLS Provider Edge routers
56804 $ref: "#/patchDefinitions/vpls-pe"
56808 ###### Related Nodes
56809 - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY)
56810 - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
56811 - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
56812 - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)
56814 -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
56815 -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
56823 description: VPN ID, globally unique within A&AI
56826 description: VPN Name
56829 description: the platform associated with the VPN example AVPN, Mobility
56832 description: Type of the vpn, should be taken from enumerated/valid values
56835 description: region of customer vpn
56838 description: id for this customer vpn
56839 route-distinguisher:
56841 description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
56847 $ref: "#/patchDefinitions/vpn-binding"
56850 Virtual Servers, aka virtual machine or VM.
56851 ###### Related Nodes
56852 - TO tenant( vserver BelongsTo tenant, MANY2ONE)
56853 - TO flavor( vserver Uses flavor, MANY2ONE)
56854 - TO image( vserver Uses image, MANY2ONE)
56855 - TO pserver( vserver HostedOn pserver, MANY2ONE)
56856 - TO snapshot( vserver Uses snapshot, ONE2ONE)
56857 - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
56858 - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
56859 - FROM vce( vce HostedOn vserver, ONE2MANY)
56860 - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
56861 - FROM vf-module( vf-module Uses vserver, ONE2MANY)
56862 - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
56864 -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
56865 -(2) IF this VSERVER node is deleted, this TO node is DELETED also
56871 - is-closed-loop-disabled
56875 description: Unique identifier for this vserver relative to its tenant
56878 description: Name of vserver
56881 description: Alternative name of vserver
56884 description: Trigger for operational monitoring of this resource by Service Assurance systems.
56887 description: URL to endpoint where AAI can get more details
56890 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.
56891 is-closed-loop-disabled:
56893 description: Used to indicate whether closed loop function is enabled on this node
56896 Collection of virtual Servers, aka virtual machines or VMs.
56901 $ref: "#/patchDefinitions/vserver"
56904 A zone is a grouping of assets in a location homing to the same connections into the CBB
56905 ###### Related Nodes
56906 - TO complex( zone LocatedIn complex, MANY2ONE)
56907 - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
56908 - FROM pnf( pnf LocatedIn zone, MANY2ONE)
56909 - FROM pserver( pserver LocatedIn zone, MANY2ONE)
56910 - FROM service-instance( service-instance LocatedIn zone, MANY2ONE)
56920 description: Code assigned by AIC to the zone
56923 description: English name associated with the zone
56926 description: Design of zone [Medium/Largeā¦]
56929 description: Context of zone [production/test]
56932 description: Status of a zone.
56935 Collection of zones
56940 $ref: "#/patchDefinitions/zone"
56949 $ref: "#/getDefinitions/action-data"
56958 APIs that are more action related than REST (e.g., notify, update).
56962 $ref: "#/getDefinitions/update"
56965 $ref: "#/getDefinitions/notify"
56968 Represents a slice or partial piece of a resource that gets separately allotted
56969 ###### Related Nodes
56970 - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
56971 - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
56972 - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
56973 - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
56974 - TO l-interface( allotted-resource Uses l-interface, ONE2MANY)
56975 - TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
56976 - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
56977 - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY)
56978 - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
56979 - TO model-ver( allotted-resource IsA model-ver, Many2One)
56980 - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
56981 - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3)
56982 - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
56983 - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
56985 -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
56986 -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also
56987 -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
56993 description: Allotted Resource id UUID assigned to this instance.
56996 description: The descriptive information assigned to this allotted resource instance
56999 description: Link back to more information in the controller
57000 model-invariant-id:
57002 description: the ASDC model id for this resource or service model.
57005 description: the ASDC model version for this resource or service model.
57006 persona-model-version:
57008 description: the ASDC model version for this resource or service model.
57011 description: Concurrency value
57012 orchestration-status:
57014 description: Orchestration status
57015 operational-status:
57017 description: Indicator for whether the resource is considered operational
57020 description: Generic description of the type of allotted resource.
57023 description: role in the network that this resource will be providing.
57027 $ref: "#/getDefinitions/tunnel-xconnect"
57031 $ref: "#/getDefinitions/relationship"
57032 allotted-resources:
57034 This object is used to store slices of services being offered
57039 $ref: "#/getDefinitions/allotted-resource"
57042 Availability zone, a collection of compute hosts/pservers
57043 ###### Related Nodes
57044 - TO complex( availability-zone LocatedIn complex, MANY2ONE)
57045 - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
57046 - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
57047 - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
57048 - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
57049 - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
57050 - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
57051 - FROM vce( vce Uses availability-zone, MANY2MANY)
57053 -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
57054 -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
57057 - availability-zone-name
57060 availability-zone-name:
57062 description: Name of the availability zone. Unique across a cloud region
57065 description: Type of hypervisor. Source of truth should define valid values.
57066 operational-status:
57068 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
57071 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57075 $ref: "#/getDefinitions/relationship"
57076 availability-zones:
57078 Collection of availability zones
57083 $ref: "#/getDefinitions/availability-zone"
57084 az-and-dvs-switches:
57088 $ref: "#/getDefinitions/dvs-switches"
57091 $ref: "#/getDefinitions/availability-zone"
57094 Namespace for business related constructs
57099 $ref: "#/getDefinitions/connector"
57103 $ref: "#/getDefinitions/customer"
57107 $ref: "#/getDefinitions/line-of-business"
57111 $ref: "#/getDefinitions/owning-entity"
57115 $ref: "#/getDefinitions/platform"
57119 $ref: "#/getDefinitions/project"
57122 ###### Related Nodes
57123 - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
57125 -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
57131 description: unique identifier of probe
57134 description: identifier of probe
57137 description: type of probe
57140 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57144 $ref: "#/getDefinitions/relationship"
57145 classes-of-service:
57147 class-of-service of probe
57152 $ref: "#/getDefinitions/class-of-service"
57153 cloud-infrastructure:
57155 Namespace for cloud infrastructure.
57160 $ref: "#/getDefinitions/complex"
57164 $ref: "#/getDefinitions/cloud-region"
57168 $ref: "#/getDefinitions/network-profile"
57172 $ref: "#/getDefinitions/pserver"
57173 virtual-data-centers:
57176 $ref: "#/getDefinitions/virtual-data-center"
57177 operational-environments:
57180 $ref: "#/getDefinitions/operational-environment"
57183 cloud-region designates an installation of a cloud cluster or region or instantiation.
57184 ###### Related Nodes
57185 - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)(2)
57186 - TO complex( cloud-region LocatedIn complex, MANY2ONE)
57187 - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
57188 - TO zone( cloud-region LocatedIn zone, MANY2ONE)
57189 - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
57190 - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
57191 - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
57192 - FROM hpa-capability( hpa-capability BelongsTo cloud-region, MANY2ONE)
57193 - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
57194 - FROM image( image BelongsTo cloud-region, MANY2ONE)
57195 - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
57196 - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
57197 - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
57198 - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
57199 - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
57200 - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
57201 - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
57202 - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
57204 -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
57205 -(2) IF this CLOUD-REGION node is deleted, this TO node is DELETED also
57206 -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
57215 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
57218 description: Identifier used by the vendor for the region. Second part of composite key
57221 description: Type of the cloud (e.g., openstack)
57222 owner-defined-type:
57224 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
57225 cloud-region-version:
57227 description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
57230 description: URL of the keystone identity service
57233 description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
57236 description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
57239 description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation.
57242 description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
57245 description: MultiVIM will discover and expose EPA capabilities.
57248 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57252 $ref: "#/getDefinitions/volume-group"
57256 $ref: "#/getDefinitions/tenant"
57260 $ref: "#/getDefinitions/flavor"
57264 $ref: "#/getDefinitions/group-assignment"
57268 $ref: "#/getDefinitions/snapshot"
57272 $ref: "#/getDefinitions/image"
57276 $ref: "#/getDefinitions/dvs-switch"
57280 $ref: "#/getDefinitions/oam-network"
57281 availability-zones:
57284 $ref: "#/getDefinitions/availability-zone"
57288 $ref: "#/getDefinitions/relationship"
57289 vip-ipv4-address-list:
57292 $ref: "#/getDefinitions/vip-ipv4-address-list"
57293 vip-ipv6-address-list:
57296 $ref: "#/getDefinitions/vip-ipv6-address-list"
57300 $ref: "#/getDefinitions/hpa-capability"
57301 description: List of cloud-region specific HPA Capabilities
57307 $ref: "#/getDefinitions/cloud-region"
57310 Collection of physical locations that can house cloud-regions.
57311 ###### Related Nodes
57312 - TO l3-network( complex Uses l3-network, MANY2MANY)
57313 - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
57314 - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
57315 - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
57316 - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY)
57317 - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
57318 - FROM pnf( pnf LocatedIn complex, MANY2ONE)
57319 - FROM pserver( pserver LocatedIn complex, MANY2ONE)
57320 - FROM vce( vce LocatedIn complex, MANY2MANY)
57321 - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
57322 - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
57323 - FROM zone( zone LocatedIn complex, MANY2ONE)
57325 -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
57326 -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
57329 - physical-location-id
57330 - physical-location-type
57337 physical-location-id:
57339 description: Unique identifier for physical location, e.g., CLLI
57342 description: Data center code which can be an alternate way to identify a complex
57345 description: Gamma complex name for LCP instance.
57348 description: URL of the keystone identity service
57351 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57352 physical-location-type:
57354 description: Type, e.g., central office, data center.
57380 $ref: "#/getDefinitions/ctag-pool"
57384 $ref: "#/getDefinitions/relationship"
57387 Collection of physical locations that can house cloud-regions.
57392 $ref: "#/getDefinitions/complex"
57395 Port Mirror Configuration.
57396 ###### Related Nodes
57397 - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
57398 - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
57399 - TO l-interface( configuration AppliesTo l-interface, ONE2MANY)
57400 - TO pnf( configuration AppliesTo pnf, ONE2MANY)
57401 - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
57402 - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
57403 - FROM service-instance( service-instance Uses configuration, ONE2MANY)
57404 - FROM forwarder( forwarder Uses configuration, ONE2ONE)(3)
57405 - FROM forwarding-path( forwarding-path Uses configuration, ONE2ONE)(3)
57406 - FROM evc( evc BelongsTo configuration, ONE2ONE)(1)
57407 - FROM forwarder-evc( forwarder-evc BelongsTo configuration, ONE2ONE)(1)
57409 -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
57410 -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
57411 -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
57414 - configuration-type
57415 - configuration-sub-type
57416 - orchestration-status
57417 - operational-status
57418 - configuration-selflink
57419 - model-customization-id
57423 description: UUID assigned to configuration.
57426 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
57427 configuration-name:
57429 description: Name of the configuration.
57430 configuration-type:
57432 description: port-mirroring-configuration.
57433 configuration-sub-type:
57435 description: vprobe, pprobe.
57436 model-invariant-id:
57438 description: the ASDC model id for this resource or service model.
57441 description: the ASDC model version for this resource or service model.
57442 orchestration-status:
57444 description: Orchestration status of the configuration.
57445 operational-status:
57447 description: Indicator for whether the resource is considered operational.
57448 configuration-selflink:
57450 description: URL to endpoint where AAI can get more details from SDN-GC.
57451 model-customization-id:
57453 description: id of the configuration used to customize the resource
57456 description: DHV Site Effective Bandwidth
57457 vendor-allowed-max-bandwidth:
57459 description: Velocloud Nominal Throughput - VNT
57462 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57466 $ref: "#/getDefinitions/relationship"
57470 $ref: "#/getDefinitions/metadatum"
57474 $ref: "#/getDefinitions/forwarder-evc"
57478 $ref: "#/getDefinitions/evc"
57481 Collection of configurations
57486 $ref: "#/getDefinitions/configuration"
57489 Collection of resource instances used to connect a variety of disparate inventory widgets
57490 ###### Related Nodes
57491 - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
57492 - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
57493 - FROM service-instance( service-instance Uses connector, MANY2MANY)
57495 -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
57497 - resource-instance-id
57499 resource-instance-id:
57501 description: Unique id of resource instance.
57504 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57505 model-invariant-id:
57507 description: the ASDC model id for this resource or service model.
57510 description: the ASDC model version for this resource or service model.
57511 persona-model-version:
57513 description: the ASDC model version for this resource or service model.
57516 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
57517 widget-model-version:
57519 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
57523 $ref: "#/getDefinitions/relationship"
57527 $ref: "#/getDefinitions/metadatum"
57530 Collection of resource instances used to connect a variety of disparate inventory widgets
57535 $ref: "#/getDefinitions/connector"
57536 constrained-element-set:
57538 This is how we would capture constraints defining allowed sets of elements.
57539 ###### Related Nodes
57540 - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
57541 - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
57542 - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
57544 -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
57545 -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
57547 - constrained-element-set-uuid
57551 constrained-element-set-uuid:
57559 element-choice-sets:
57562 $ref: "#/getDefinitions/element-choice-set"
57566 $ref: "#/getDefinitions/relationship"
57567 constrained-element-sets:
57569 constrained-element-set:
57572 $ref: "#/getDefinitions/constrained-element-set"
57575 ###### Related Nodes
57576 - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
57577 - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
57579 -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
57589 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57593 $ref: "#/getDefinitions/relationship"
57599 $ref: "#/getDefinitions/ctag-assignment"
57602 A collection of C tags (vlan tags) grouped for a specific purpose.
57603 ###### Related Nodes
57604 - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
57605 - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
57606 - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY)
57607 - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
57609 -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
57612 - availability-zone-name
57613 - ctag-pool-purpose
57617 description: The Target provider edge router
57618 availability-zone-name:
57620 description: Name of the availability zone
57623 description: Describes what the intended purpose of this pool is.
57626 description: Comma separated list of ctags
57629 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57633 $ref: "#/getDefinitions/relationship"
57639 $ref: "#/getDefinitions/ctag-pool"
57642 customer identifiers to provide linkage back to BSS information.
57643 ###### Related Nodes
57644 - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
57646 -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
57648 - global-customer-id
57652 global-customer-id:
57654 description: Global customer id used across ECOMP to uniquely identify customer.
57657 description: Subscriber name, an alternate way to retrieve a customer.
57660 description: Subscriber type, a way to provide VID with only the INFRA customers.
57663 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57664 service-subscriptions:
57667 $ref: "#/getDefinitions/service-subscription"
57671 $ref: "#/getDefinitions/relationship"
57674 Collection of customer identifiers to provide linkage back to BSS information.
57679 $ref: "#/getDefinitions/customer"
57687 description: See mis-na-virtualization-platform.yang
57690 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57694 $ref: "#/getDefinitions/relationship"
57700 $ref: "#/getDefinitions/cvlan-tag-entry"
57703 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.
57704 ###### Related Nodes
57705 - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
57706 - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
57714 description: DVS switch name
57717 description: URL used to reach the vcenter
57720 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57724 $ref: "#/getDefinitions/relationship"
57727 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
57732 $ref: "#/getDefinitions/dvs-switch"
57735 Internal map to define the properties of an edge and interpret the map EdgeRules
57753 edge-tag-query-request:
57764 $ref: "#/getDefinitions/start-node-filter"
57765 include-node-filter:
57768 $ref: "#/getDefinitions/include-node-filter"
57772 $ref: "#/getDefinitions/secondary-filter"
57773 edge-tag-query-result:
57775 tagged-inventory-item-list:
57778 $ref: "#/getDefinitions/tagged-inventory-item-list"
57779 element-choice-set:
57781 This is how we would capture constraints defining allowed sets of elements.
57782 ###### Related Nodes
57783 - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
57784 - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
57786 -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
57787 -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
57789 - element-choice-set-uuid
57790 - element-choice-set-name
57792 element-choice-set-uuid:
57794 element-choice-set-name:
57803 $ref: "#/getDefinitions/model-element"
57807 $ref: "#/getDefinitions/relationship"
57808 element-choice-sets:
57810 element-choice-set:
57813 $ref: "#/getDefinitions/element-choice-set"
57816 Metadata for entitlement group.
57817 ###### Related Nodes
57818 - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
57819 - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
57821 -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
57828 description: Unique ID for the entitlement group the resource comes from, should be uuid.
57831 description: Unique ID of an entitlement resource.
57834 description: Concurrency value
57838 $ref: "#/getDefinitions/relationship"
57841 Entitlements, keyed by group-uuid and resource-uuid, related to license management
57846 $ref: "#/getDefinitions/entitlement"
57849 Persist EMS address information used by EMS driver.
57850 ###### Related Nodes
57851 - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)(2)
57853 -(2) IF this ESR-EMS node is deleted, this TO node is DELETED also
57859 description: Unique ID of EMS.
57862 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57863 esr-system-info-list:
57865 $ref: "#/getDefinitions/esr-system-info-list"
57868 $ref: "#/getDefinitions/relationship-list"
57874 $ref: "#/getDefinitions/esr-ems"
57877 Persist common address information of external systems.
57878 ###### Related Nodes
57879 - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)(3)
57880 - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)(3)
57881 - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)(3)
57882 - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)(3)
57884 -(3) IF this FROM node is deleted, this ESR-SYSTEM-INFO is DELETED also
57886 - esr-system-info-id
57891 esr-system-info-id:
57893 description: Unique ID of esr system info.
57896 description: name of external system.
57899 description: type of external systems.
57902 description: vendor of external systems.
57905 description: version of external systems.
57908 description: url used to access external systems.
57911 description: username used to access external systems.
57914 description: password used to access external systems.
57917 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
57920 description: protocol of third party SDNC, for example netconf/snmp.
57923 description: ca file content if enabled ssl on auth-url.
57926 description: Whether to verify VIM's certificate.
57929 description: service IP of ftp server.
57932 description: service port of ftp server.
57935 description: domain info for authentication.
57938 description: default tenant of VIM.
57941 description: ftp passive mode or not.
57944 description: resource or performance data file path.
57947 description: the status of external system.
57950 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57953 $ref: "#/getDefinitions/relationship-list"
57954 esr-system-info-list:
57956 Collection of persistent block-level external system auth info.
57961 $ref: "#/getDefinitions/esr-system-info"
57962 esr-thirdparty-sdnc:
57964 Persist SDNC address information used by ONAP SDNC.
57965 ###### Related Nodes
57966 - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)(2)
57967 - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
57969 -(2) IF this ESR-THIRDPARTY-SDNC node is deleted, this TO node is DELETED also
57971 - thirdparty-sdnc-id
57973 thirdparty-sdnc-id:
57975 description: Unique ID of SDNC.
57978 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
57981 description: password used to access SDNC server.
57984 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57985 esr-system-info-list:
57987 $ref: "#/getDefinitions/esr-system-info-list"
57990 $ref: "#/getDefinitions/relationship-list"
57991 esr-thirdparty-sdnc-list:
57993 esr-thirdparty-sdnc:
57996 $ref: "#/getDefinitions/esr-thirdparty-sdnc"
57999 Persist VNFM address information used by VF-C.
58000 ###### Related Nodes
58001 - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)(2)
58003 -(2) IF this ESR-VNFM node is deleted, this TO node is DELETED also
58009 description: Unique ID of VNFM.
58012 description: indecate the VIM to deploy VNF.
58015 description: certificate url of VNFM.
58018 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58019 esr-system-info-list:
58021 $ref: "#/getDefinitions/esr-system-info-list"
58024 $ref: "#/getDefinitions/relationship-list"
58030 $ref: "#/getDefinitions/esr-vnfm"
58033 evc object is an optional child object of the Configuration object.
58034 ###### Related Nodes
58035 - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
58037 -(4) IF this TO node is deleted, this EVC is DELETED also
58043 description: Unique/key field for the evc object
58044 forwarding-path-topology:
58046 description: Point-to-Point, Multi-Point
58049 description: Commited Information Rate
58052 description: CIR units
58053 connection-diversity-group-id:
58055 description: Diversity Group ID
58058 description: formerly Performance Group
58059 esp-evc-circuit-id:
58061 description: EVC Circuit ID of ESP EVC
58064 description: Committed Information Rate (For ESP)
58067 description: CIR units (For ESP)
58070 description: Identifies ESP
58071 collector-pop-clli:
58073 description: Collector POP CLLI (from the hostname of the access pnf)
58074 inter-connect-type-ingress:
58076 description: Interconnect type on ingress side of EVC.
58077 tagmode-access-ingress:
58079 description: tagode for collector side of EVC
58080 tagmode-access-egress:
58082 description: tagMode for network side of EVC
58086 $ref: "#/getDefinitions/relationship"
58089 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58095 $ref: "#/getDefinitions/evc"
58098 Namespace for external system.
58102 $ref: "#/getDefinitions/esr-ems-list"
58105 $ref: "#/getDefinitions/esr-vnfm-list"
58106 esr-thirdparty-sdnc-list:
58108 $ref: "#/getDefinitions/esr-thirdparty-sdnc-list"
58111 Extra properties for inventory item for response list
58116 $ref: "#/getDefinitions/extra-property"
58126 ###### Related Nodes
58127 - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
58128 - FROM hpa-capability( hpa-capability BelongsTo flavor, MANY2ONE)
58129 - FROM vserver( vserver Uses flavor, MANY2ONE)
58131 -FLAVOR cannot be deleted if related to HPA-CAPABILITY,VSERVER
58140 description: Flavor id, expected to be unique across cloud-region.
58143 description: Cloud Region Flavor name
58147 description: Number of CPUs
58151 description: Amount of memory
58155 description: Disk space
58159 description: Amount of ephemeral disk space
58162 description: amount of swap space allocation
58165 description: whether flavor is available to all users or private to the tenant it was created in.
58168 description: URL to endpoint where AAI can get more details
58171 description: Boolean as to whether this flavor is no longer enabled
58175 $ref: "#/getDefinitions/hpa-capability"
58176 description: List of flavor specific HPA Capabilities
58179 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58183 $ref: "#/getDefinitions/relationship"
58186 Collection of openstack flavors.
58191 $ref: "#/getDefinitions/flavor"
58194 Entity describing a sequenced segment of forwarding path
58195 ###### Related Nodes
58196 - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
58197 - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
58198 - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
58199 - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
58200 - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
58202 -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
58203 -(4) IF this TO node is deleted, this FORWARDER is DELETED also
58210 description: Unique ID of this segmentation
58213 description: ingress, intermediate, egress
58217 $ref: "#/getDefinitions/relationship"
58220 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58223 forwarder object is an optional child object of the Configuration object.
58224 ###### Related Nodes
58225 - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
58227 -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
58233 description: Key for forwarder-evc object
58236 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
58239 description: Internal VLAN.
58242 description: SVLAN value for ingress of egress forwarder.
58245 description: CVLAN value for ingress of egress forwarder.
58249 $ref: "#/getDefinitions/relationship"
58252 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58258 $ref: "#/getDefinitions/forwarder-evc"
58264 $ref: "#/getDefinitions/forwarder"
58267 Entity that describes the sequenced forwarding path between interfaces of services or resources
58268 ###### Related Nodes
58269 - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
58270 - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
58271 - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
58273 -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
58274 -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
58275 -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
58277 - forwarding-path-id
58278 - forwarding-path-name
58280 forwarding-path-id:
58282 description: Unique ID of this FP
58283 forwarding-path-name:
58285 description: Name of the FP
58289 $ref: "#/getDefinitions/relationship"
58292 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58295 description: the self link for this FP
58299 $ref: "#/getDefinitions/forwarder"
58305 $ref: "#/getDefinitions/forwarding-path"
58308 General purpose VNF
58309 ###### Related Nodes
58310 - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
58311 - TO complex( generic-vnf LocatedIn complex, MANY2MANY)
58312 - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2)
58313 - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY)
58314 - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
58315 - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
58316 - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
58317 - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
58318 - TO pnf( generic-vnf HostedOn pnf, MANY2MANY)
58319 - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
58320 - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
58321 - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
58322 - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
58323 - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
58324 - TO model-ver( generic-vnf IsA model-ver, Many2One)
58325 - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
58326 - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
58327 - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
58328 - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
58329 - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
58330 - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
58331 - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
58332 - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
58333 - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
58334 - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
58335 - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY)
58336 - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
58337 - FROM platform( platform Uses generic-vnf, MANY2MANY)
58339 -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
58340 -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also
58346 - is-closed-loop-disabled
58350 description: Unique id of VNF. This is unique across the graph.
58353 description: vnf instance id.
58356 description: Name of VNF.
58359 description: Alternate name of VNF.
58362 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.
58365 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
58366 regional-resource-zone:
58368 description: Regional way of organizing pservers, source of truth should define values
58371 description: Trigger for operational monitoring of this resource by Service Assurance systems.
58372 operational-status:
58374 description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
58377 description: OBSOLETE - do not use
58380 description: Client should send valid enumerated value
58381 orchestration-status:
58383 description: Orchestration status of this VNF, used by MSO.
58386 vnf-discriptor-name:
58388 description: vnf discriptor name
58391 description: job id corresponding to vnf
58394 description: Heat stack id corresponding to this instance, managed by MSO
58397 description: Corresponds to the SDN-C catalog id used to configure this VCE
58400 description: identifier of managed by ATT or customer
58403 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
58404 ipv4-loopback0-address:
58406 description: v4 Loopback0 address
58409 description: v6 Loopback address
58410 management-v6-address:
58412 description: v6 management address
58416 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
58419 description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
58423 description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
58426 description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
58430 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
58433 description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
58437 description: number of associated SHD in vnf.
58441 description: number of vms in vnf.
58445 description: number of network in vnf.
58448 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.
58449 is-closed-loop-disabled:
58451 description: used to indicate whether closed loop function is enabled on this node
58454 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58457 description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
58458 encrypted-access-flag:
58460 description: indicates whether generic-vnf access uses SSH
58461 entitlement-assignment-group-uuid:
58463 description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships.
58464 entitlement-resource-uuid:
58466 description: UUID of the specific entitlement resource. OBSOLETE - See child relationships.
58467 license-assignment-group-uuid:
58469 description: UUID of the license assignment group. OBSOLETE - See child relationships.
58472 description: UUID of the actual license resource. OBSOLETE - See child relationships.
58473 model-invariant-id:
58475 description: the ASDC model id for this resource or service model.
58478 description: the ASDC model version for this resource or service model.
58479 persona-model-version:
58481 description: the ASDC model version for this resource or service model.
58482 model-customization-id:
58484 description: captures the id of all the configuration used to customize the resource for the service.
58487 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
58488 widget-model-version:
58490 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
58493 description: as-number of the VNF
58494 regional-resource-subzone:
58496 description: represents sub zone of the rr plane
58499 description: Generic description of the type of NF
58502 description: English description of Network function that the specific VNF deployment is providing
58505 description: role in the network that this model will be providing
58508 description: string assigned to this model used for naming purposes
58511 description: Path to the controller object.
58512 ipv4-oam-gateway-address:
58514 description: Gateway address
58515 ipv4-oam-gateway-address-prefix-length:
58518 description: Prefix length for oam-address
58522 description: Temporary location for S-TAG to get to VCE
58525 description: Network Management profile of this VNF
58529 $ref: "#/getDefinitions/relationship"
58533 $ref: "#/getDefinitions/l-interface"
58537 $ref: "#/getDefinitions/lag-interface"
58541 $ref: "#/getDefinitions/vf-module"
58545 $ref: "#/getDefinitions/license"
58549 $ref: "#/getDefinitions/entitlement"
58557 $ref: "#/getDefinitions/generic-vnf"
58560 Openstack group-assignment used to store exclusivity groups (EG).
58561 ###### Related Nodes
58562 - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
58563 - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
58564 - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
58573 description: Group id, expected to be unique across cloud-region.
58576 description: Group type - the type of group this instance refers to
58579 description: Group name - name assigned to the group
58582 description: Group description - description of the group
58585 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58589 $ref: "#/getDefinitions/relationship"
58592 Collection of openstack group assignments
58597 $ref: "#/getDefinitions/group-assignment"
58600 ###### Related Nodes
58601 - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
58603 -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
58611 description: host-route id
58614 description: subnet prefix
58617 description: Could be ip-address, hostname, or service-instance
58620 description: Should be ip-address, hostname, or service-instance to match next-hop
58623 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58627 $ref: "#/getDefinitions/relationship"
58633 $ref: "#/getDefinitions/host-route"
58636 Collection of HPA Capabilities
58641 $ref: "#/getDefinitions/hpa-capability"
58644 Represents a HPA capability
58645 ###### Related Nodes
58646 - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
58647 - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
58648 - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
58650 -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
58652 - hpa-capability-id
58657 description: UUID to uniquely identify a HPA capability
58660 description: Name of the HPACapability
58663 description: HPA schema version
58666 description: Hardware architecture
58669 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58673 $ref: "#/getDefinitions/relationship"
58674 hpa-feature-attributes:
58677 $ref: "#/getDefinitions/hpa-feature-attributes"
58678 hpa-feature-attributes:
58680 HPA Capability Feature attributes
58681 ###### Related Nodes
58682 - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
58684 -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
58686 - hpa-attribute-key
58690 description: name of the specific HPA attribute
58691 hpa-attribute-value:
58693 description: JSON string specifying the value, unit and type of the specific HPA attribute
58696 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58700 $ref: "#/getDefinitions/relationship"
58704 ###### Related Nodes
58705 - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
58706 - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
58707 - FROM vserver( vserver Uses image, MANY2ONE)
58709 -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
58710 -IMAGE cannot be deleted if related to VSERVER
58721 description: Image id, expected to be unique across cloud region
58724 description: Image name
58725 image-architecture:
58727 description: Operating system architecture.
58730 description: The common name of the operating system distribution in lowercase
58733 description: The operating system version as specified by the distributor.
58736 description: The application that the image instantiates.
58737 application-vendor:
58739 description: The vendor of the application.
58740 application-version:
58742 description: The version of the application.
58745 description: URL to endpoint where AAI can get more details
58748 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58752 $ref: "#/getDefinitions/relationship"
58756 $ref: "#/getDefinitions/metadatum"
58759 Collectio of Openstack images.
58764 $ref: "#/getDefinitions/image"
58765 include-node-filter:
58771 InstanceFilter for performing a named-query or model query
58774 InstanceFilters for performing a named-query or model query
58779 $ref: "#/getDefinitions/instance-filter"
58782 General mechanism for grouping instances
58783 ###### Related Nodes
58784 - TO model( instance-group Targets model, MANY2MANY)
58785 - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
58786 - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
58787 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
58788 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
58789 - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY)
58790 - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
58791 - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
58792 - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
58793 - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
58794 - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
58795 - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY)
58802 instance-group-role:
58804 description: role of the instance group.
58805 model-invariant-id:
58807 description: ASDC model id for this resource or service model.
58810 description: ASDC model version uid for this resource model.
58813 description: Instance Group ID, UUID assigned to this instance.
58816 description: Descriptive text to help identify the usage of this instance-group
58819 description: Only valid value today is lower case ha for high availability
58822 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
58825 description: Concurrency value
58829 $ref: "#/getDefinitions/relationship"
58832 Collection of openstack route table references
58837 $ref: "#/getDefinitions/instance-group"
58842 $ref: "#/getDefinitions/search"
58845 $ref: "#/getDefinitions/actions"
58846 cloud-infrastructure:
58848 $ref: "#/getDefinitions/cloud-infrastructure"
58851 $ref: "#/getDefinitions/external-system"
58854 $ref: "#/getDefinitions/business"
58855 service-design-and-creation:
58857 $ref: "#/getDefinitions/service-design-and-creation"
58860 $ref: "#/getDefinitions/network"
58863 $ref: "#/getDefinitions/nodes"
58866 inventory-item-type:
58868 inventory-item-link:
58870 inventory-item-data:
58873 $ref: "#/getDefinitions/inventory-item-data"
58874 tagged-inventory-item-list:
58877 $ref: "#/getDefinitions/tagged-inventory-item-list"
58878 inventory-item-data:
58884 inventory-response-item:
58886 Inventory item for response list
58892 $ref: "#/getDefinitions/extra-properties"
58893 inventory-response-items:
58895 $ref: "#/getDefinitions/inventory-response-items"
58896 inventory-response-items:
58898 Container for inventory items in response list
58900 inventory-response-item:
58903 $ref: "#/getDefinitions/inventory-response-item"
58904 ipsec-configuration:
58906 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
58907 ###### Related Nodes
58908 - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
58909 - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
58911 -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
58913 - ipsec-configuration-id
58915 ipsec-configuration-id:
58917 description: UUID of this configuration
58918 requested-vig-address-type:
58920 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
58921 requested-encryption-strength:
58923 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
58924 requested-dmz-type:
58926 description: ATT can offer a shared DMZ or a DMZ specific to a customer
58927 shared-dmz-network-address:
58929 description: Network address of shared DMZ
58930 requested-customer-name:
58932 description: If the DMZ is a custom DMZ, this field will indicate the customer information
58935 description: can be 1 or 2
58936 ikev1-authentication:
58938 description: Contains values like md5, sha1, sha256, sha384
58941 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,ĆĀ aes-192-cbc, aes-265-cbc
58944 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
58947 description: Group name defined in VIG for clients using aggressive mode
58950 description: pre-shared key for the above group name
58953 description: Lifetime for IKEv1 SA
58954 ipsec-authentication:
58956 description: md5, sha1, sha256, sha384
58959 description: 3des-cbc, des-cbc, aes-128-cbc,ĆĀ aes-192-cbc, aes-265-cbc
58962 description: Life time for IPSec SA
58965 description: enable PFS or not
58968 description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
58969 xauth-user-password:
58971 description: Encrypted using the Juniper $9$ algorithm
58974 description: The time between DPD probe
58977 description: Maximum number of DPD before claiming the tunnel is down
58980 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58984 $ref: "#/getDefinitions/relationship"
58988 $ref: "#/getDefinitions/vig-server"
58989 ipsec-configurations:
58991 ipsec-configuration:
58994 $ref: "#/getDefinitions/ipsec-configuration"
59003 Logical interfaces, e.g., a vnic.
59004 ###### Related Nodes
59005 - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
59006 - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
59007 - TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
59008 - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
59009 - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
59010 - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
59011 - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
59012 - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
59013 - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY)
59014 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
59015 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
59016 - FROM logical-link( logical-link Source l-interface, ONE2MANY)(1)
59017 - FROM logical-link( logical-link Destination l-interface, ONE2MANY)(1)
59018 - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
59019 - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
59020 - FROM configuration( configuration AppliesTo l-interface, ONE2MANY)
59021 - FROM forwarder( forwarder ForwardsTo l-interface, MANY2ONE)
59022 - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
59024 -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
59025 -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
59026 -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
59035 description: Name given to the interface
59038 description: E.g., CUSTOMER, UPLINK, etc.
59041 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
59044 description: URL to endpoint where AAI can get more details
59047 description: ID of interface
59050 description: MAC address for the interface
59053 description: Name of the network
59056 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
59057 interface-description:
59059 description: Human friendly text regarding this interface.
59062 description: boolean indicatating whether or not port is a mirrored.
59065 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59068 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
59071 description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
59074 description: Flag indicating the interface uses the IP Unnumbered configuration.
59075 allowed-address-pairs:
59077 description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
59081 $ref: "#/getDefinitions/vlan"
59085 $ref: "#/getDefinitions/sriov-vf"
59089 $ref: "#/getDefinitions/l-interface"
59093 $ref: "#/getDefinitions/relationship"
59094 l3-interface-ipv4-address-list:
59097 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
59098 l3-interface-ipv6-address-list:
59101 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
59104 Collection of logical interfaces.
59109 $ref: "#/getDefinitions/l-interface"
59110 l3-interface-ipv4-address-list:
59113 ###### Related Nodes
59114 - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
59115 - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
59116 - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
59117 - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
59118 - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
59119 - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4)
59121 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
59123 - l3-interface-ipv4-address
59125 l3-interface-ipv4-address:
59127 description: IP address
59128 l3-interface-ipv4-prefix-length:
59131 description: Prefix length, 32 for single address
59135 description: Inner VLAN tag
59139 description: Outer VLAN tag
59142 description: Indicator of fixed or floating address
59145 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59146 neutron-network-id:
59148 description: Neutron network id of the interface that address belongs to
59151 description: Neutron id of subnet that address belongs to
59155 $ref: "#/getDefinitions/relationship"
59156 l3-interface-ipv6-address-list:
59159 ###### Related Nodes
59160 - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
59161 - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
59162 - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
59163 - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
59164 - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
59165 - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4)
59167 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
59169 - l3-interface-ipv6-address
59171 l3-interface-ipv6-address:
59173 description: IP address
59174 l3-interface-ipv6-prefix-length:
59177 description: Prefix length, 128 for single address
59181 description: Inner VLAN tag
59185 description: Outer VLAN tag
59188 description: Indicator of fixed or floating address
59191 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59192 neutron-network-id:
59194 description: Neutron network id of the interface that address belongs to
59197 description: Neutron id of subnet that address belongs to
59201 $ref: "#/getDefinitions/relationship"
59204 Generic network definition
59205 ###### Related Nodes
59206 - TO instance-group( l3-network MemberOf instance-group, MANY2MANY)
59207 - TO network-policy( l3-network Uses network-policy, MANY2MANY)
59208 - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
59209 - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
59210 - TO model-ver( l3-network IsA model-ver, Many2One)
59211 - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
59212 - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
59213 - FROM complex( complex Uses l3-network, MANY2MANY)
59214 - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
59215 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
59216 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
59217 - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
59218 - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
59219 - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
59220 - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
59221 - FROM tenant( tenant Uses l3-network, MANY2MANY)
59222 - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
59224 -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
59229 - is-provider-network
59230 - is-shared-network
59231 - is-external-network
59235 description: Network ID, should be uuid. Unique across A&AI.
59238 description: Name of the network, governed by some naming convention..
59241 description: Type of the network - who defines these values?
59244 description: Role the network plans - who defines these values?
59245 network-technology:
59247 description: Network technology - who defines these values?
59248 neutron-network-id:
59250 description: Neutron network id of this Interface
59253 description: Set to true if bound to VPN
59256 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
59257 network-role-instance:
59260 description: network role instance
59263 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59264 orchestration-status:
59266 description: Orchestration status of this VNF, mastered by MSO
59269 description: Heat stack id corresponding to this instance, managed by MSO
59272 description: Corresponds to the SDN-C catalog id used to configure this VCE
59273 contrail-network-fqdn:
59275 description: Contrail FQDN for the network
59276 model-invariant-id:
59278 description: the ASDC model id for this resource or service model.
59281 description: the ASDC model version for this resource or service model.
59282 persona-model-version:
59284 description: the ASDC model version for this resource or service model.
59285 model-customization-id:
59287 description: captures the id of all the configuration used to customize the resource for the service.
59290 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
59291 widget-model-version:
59293 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
59294 physical-network-name:
59296 description: Name associated with the physical network.
59297 is-provider-network:
59299 description: boolean indicatating whether or not network is a provider network.
59302 description: boolean indicatating whether or not network is a shared network.
59303 is-external-network:
59305 description: boolean indicatating whether or not network is an external network.
59308 description: Path to the controller object.
59309 operational-status:
59311 description: Indicator for whether the resource is considered operational.
59315 $ref: "#/getDefinitions/subnet"
59319 $ref: "#/getDefinitions/ctag-assignment"
59320 segmentation-assignments:
59323 $ref: "#/getDefinitions/segmentation-assignment"
59327 $ref: "#/getDefinitions/relationship"
59328 description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
59334 $ref: "#/getDefinitions/l3-network"
59337 Link aggregate interface
59338 ###### Related Nodes
59339 - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
59340 - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
59341 - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
59342 - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
59343 - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
59344 - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
59345 - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
59346 - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
59347 - FROM forwarder( forwarder ForwardsTo lag-interface, MANY2ONE)
59349 -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
59350 -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
59351 -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
59358 description: Name that identifies the link aggregate interface
59359 interface-description:
59361 description: Human friendly text regarding this interface.
59364 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59367 description: Captures the numeric part of the speed
59370 description: Captures the units corresponding to the speed
59373 description: ID of interface
59376 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
59379 description: Trigger for operational monitoring of this resource by Service Assurance systems.
59382 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
59386 $ref: "#/getDefinitions/relationship"
59390 $ref: "#/getDefinitions/l-interface"
59393 Collection of link aggregate interfaces.
59398 $ref: "#/getDefinitions/lag-interface"
59401 LAG links can connect lag-interfaces
59402 ###### Related Nodes
59403 - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
59404 - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
59406 -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
59412 description: Alphabetical concatenation of lag-interface names
59415 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59419 $ref: "#/getDefinitions/relationship"
59422 Collection of link aggregation connections
59427 $ref: "#/getDefinitions/lag-link"
59430 Metadata for license group.
59431 ###### Related Nodes
59432 - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
59433 - TO vce( license BelongsTo vce, MANY2ONE)(4)
59435 -(4) IF this TO node is deleted, this LICENSE is DELETED also
59442 description: Unique ID for the license group the resource belongs to, should be uuid.
59445 description: Unique ID of a license resource.
59448 description: Concurrency value
59452 $ref: "#/getDefinitions/relationship"
59455 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
59460 $ref: "#/getDefinitions/license"
59463 describes a line-of-business
59464 ###### Related Nodes
59465 - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
59468 - line-of-business-name
59470 line-of-business-name:
59472 description: Name of the line-of-business (product)
59475 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59479 $ref: "#/getDefinitions/relationship"
59482 Collection of lines-of-business
59487 $ref: "#/getDefinitions/line-of-business"
59490 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
59491 ###### Related Nodes
59492 - TO l-interface( logical-link Source l-interface, ONE2MANY)(4)
59493 - TO l-interface( logical-link Destination l-interface, ONE2MANY)(4)
59494 - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
59495 - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
59496 - TO lag-link( logical-link Uses lag-link, MANY2MANY)
59497 - TO logical-link( logical-link Uses logical-link, MANY2MANY)
59498 - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
59499 - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
59500 - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
59501 - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
59502 - TO model-ver( logical-link IsA model-ver, Many2One)
59503 - FROM configuration( configuration Uses logical-link, ONE2MANY)(3)
59504 - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)
59505 - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
59506 - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
59507 - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
59508 - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
59509 - FROM logical-link( logical-link Uses logical-link, MANY2MANY)
59511 -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
59512 -(4) IF this TO node is deleted, this LOGICAL-LINK is DELETED also
59520 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
59523 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.
59526 description: Type of logical link, e.g., evc
59529 description: Captures the numeric part of the speed
59532 description: Captures the units corresponding to the speed
59535 description: v4, v6, or ds for dual stack
59538 description: For example, static or BGP
59541 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59542 model-invariant-id:
59544 description: the ASDC model id for this resource or service model.
59547 description: the ASDC model version for this resource or service model.
59548 persona-model-version:
59550 description: the ASDC model version for this resource or service model.
59553 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
59554 widget-model-version:
59556 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
59557 operational-status:
59559 description: Indication of operational status of the logical link.
59562 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
59565 description: Indication of the network use of the logical link.
59568 description: Alias or alternate name (CLCI or D1 name).
59571 description: UUID of the logical-link, SDNC generates this.
59574 description: Circuit id
59577 description: Reason for this entity, role it is playing
59581 $ref: "#/getDefinitions/relationship"
59584 Collection of logical connections
59589 $ref: "#/getDefinitions/logical-link"
59592 Collection of metadatum (key/value pairs)
59597 $ref: "#/getDefinitions/metadatum"
59601 ###### Related Nodes
59602 - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4)
59603 - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
59604 - TO image( metadatum BelongsTo image, MANY2ONE)(4)
59605 - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
59606 - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
59608 -(4) IF this TO node is deleted, this METADATUM is DELETED also
59619 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59622 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
59623 ###### Related Nodes
59624 - TO model( model-ver BelongsTo model, MANY2ONE)(1)
59625 - FROM instance-group( instance-group Targets model, MANY2MANY)
59626 - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
59627 - FROM named-query( named-query AppliesTo model, ONE2MANY)
59628 - FROM named-query-element( named-query-element IsA model, MANY2ONE)
59630 -(1) IF this MODEL node is deleted, this FROM node is DELETED also
59631 -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
59634 - model-invariant-id
59637 model-invariant-id:
59639 description: Unique identifier corresponding to the main definition of a model in ASDC
59642 description: Type of the model, e.g., service, resource, widget, etc.
59645 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59649 $ref: "#/getDefinitions/model-ver"
59653 $ref: "#/getDefinitions/relationship"
59654 model-and-named-query-search:
59656 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
59660 $ref: "#/getDefinitions/query-parameters"
59663 $ref: "#/getDefinitions/instance-filters"
59666 $ref: "#/getDefinitions/secondary-filts"
59669 secondary-filter-cut-point:
59673 This is how we would capture constraints defining allowed sets of elements.
59674 ###### Related Nodes
59675 - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
59676 - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
59678 -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
59679 -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
59681 - model-constraint-uuid
59682 - constrained-element-set-uuid-to-replace
59684 model-constraint-uuid:
59686 constrained-element-set-uuid-to-replace:
59688 constrained-element-sets:
59691 $ref: "#/getDefinitions/constrained-element-set"
59694 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59700 $ref: "#/getDefinitions/model-constraint"
59703 Defines how other models combine to make up a higher-level model.
59704 ###### Related Nodes
59705 - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
59706 - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
59707 - TO model-ver( model-element IsA model-ver, MANY2ONE)
59708 - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
59709 - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
59710 - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
59711 - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
59713 -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
59714 -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
59716 - model-element-uuid
59717 - new-data-del-flag
59720 model-element-uuid:
59724 description: Indicates whether this element was created as part of instantiation from this model
59727 description: How many of this type of element are required/allowed
59732 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59736 $ref: "#/getDefinitions/model-element"
59737 description: Defines how other models combine to make up a higher-level model
59741 $ref: "#/getDefinitions/model-constraint"
59742 description: Describes new constraints on this model element that are not part of that model's definition
59746 $ref: "#/getDefinitions/relationship"
59752 $ref: "#/getDefinitions/model-element"
59755 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
59756 ###### Related Nodes
59757 - TO model( model-ver BelongsTo model, MANY2ONE)(4)
59758 - FROM model-element( model-element IsA model-ver, MANY2ONE)
59759 - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
59760 - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
59761 - FROM allotted-resource( allotted-resource IsA model-ver, Many2One)
59762 - FROM generic-vnf( generic-vnf IsA model-ver, Many2One)
59763 - FROM l3-network( l3-network IsA model-ver, Many2One)
59764 - FROM logical-link( logical-link IsA model-ver, Many2One)
59765 - FROM service-instance( service-instance IsA model-ver, Many2One)
59766 - FROM vf-module( vf-module IsA model-ver, Many2One)
59768 -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
59769 -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
59770 -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
59779 description: Unique identifier corresponding to one version of a model in ASDC
59782 description: Name of the model, which can change from version to version.
59785 description: Version
59786 distribution-status:
59788 description: Distribution Status
59791 description: Description
59794 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59798 $ref: "#/getDefinitions/model-element"
59802 $ref: "#/getDefinitions/metadatum"
59806 $ref: "#/getDefinitions/relationship"
59812 $ref: "#/getDefinitions/model-ver"
59815 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
59820 $ref: "#/getDefinitions/model"
59821 multicast-configuration:
59823 ###### Related Nodes
59824 - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
59827 - multicast-configuration-id
59828 - multicast-protocol
59831 multicast-configuration-id:
59833 description: Unique id of multicast configuration.
59834 multicast-protocol:
59836 description: protocol of multicast configuration
59839 description: rp type of multicast configuration
59842 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59846 $ref: "#/getDefinitions/relationship"
59847 multicast-configurations:
59849 multicast configuration of generic-vnf ip-address
59851 multicast-configuration:
59854 $ref: "#/getDefinitions/multicast-configuration"
59860 $ref: "#/getDefinitions/named-query"
59864 ###### Related Nodes
59865 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
59866 - TO model( named-query AppliesTo model, ONE2MANY)
59867 - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
59869 -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
59873 - named-query-version
59879 named-query-version:
59881 required-input-param:
59887 named-query-elements:
59890 $ref: "#/getDefinitions/named-query-element"
59894 $ref: "#/getDefinitions/relationship"
59895 named-query-element:
59898 ###### Related Nodes
59899 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
59900 - TO model( named-query-element IsA model, MANY2ONE)
59901 - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
59902 - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
59903 - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
59904 - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
59906 -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
59907 -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
59909 - named-query-element-uuid
59911 named-query-element-uuid:
59913 property-collect-list:
59917 property-limit-desc:
59921 named-query-elements:
59924 $ref: "#/getDefinitions/named-query-element"
59928 $ref: "#/getDefinitions/related-lookup"
59929 property-constraints:
59932 $ref: "#/getDefinitions/property-constraint"
59936 $ref: "#/getDefinitions/relationship"
59937 named-query-elements:
59939 named-query-element:
59942 $ref: "#/getDefinitions/named-query-element"
59945 Namespace for network inventory resources.
59950 $ref: "#/getDefinitions/logical-link"
59954 $ref: "#/getDefinitions/site-pair-set"
59958 $ref: "#/getDefinitions/vpn-binding"
59962 $ref: "#/getDefinitions/vpls-pe"
59963 multicast-configurations:
59966 $ref: "#/getDefinitions/multicast-configuration"
59970 $ref: "#/getDefinitions/vce"
59974 $ref: "#/getDefinitions/vnfc"
59978 $ref: "#/getDefinitions/l3-network"
59982 $ref: "#/getDefinitions/network-policy"
59986 $ref: "#/getDefinitions/generic-vnf"
59990 $ref: "#/getDefinitions/lag-link"
59994 $ref: "#/getDefinitions/newvce"
59998 $ref: "#/getDefinitions/pnf"
60002 $ref: "#/getDefinitions/physical-link"
60003 ipsec-configurations:
60006 $ref: "#/getDefinitions/ipsec-configuration"
60007 route-table-references:
60010 $ref: "#/getDefinitions/route-table-reference"
60014 $ref: "#/getDefinitions/instance-group"
60018 $ref: "#/getDefinitions/zone"
60022 $ref: "#/getDefinitions/configuration"
60026 $ref: "#/getDefinitions/forwarding-path"
60032 $ref: "#/getDefinitions/network-policy"
60035 ###### Related Nodes
60036 - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
60037 - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
60040 - network-policy-id
60044 description: UUID representing unique key to this instance
60045 network-policy-fqdn:
60047 description: Contrail FQDN for the policy
60050 description: ID for the openStack Heat instance
60053 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60057 $ref: "#/getDefinitions/relationship"
60060 Network profile populated by SDN-GP for SNMP
60061 ###### Related Nodes
60062 - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
60069 description: Unique name of network profile.
60072 description: Encrypted SNMP community string
60075 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60079 $ref: "#/getDefinitions/relationship"
60082 Collection of network profiles
60087 $ref: "#/getDefinitions/network-profile"
60090 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
60091 ###### Related Nodes
60092 - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
60094 -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
60102 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
60105 description: Name of VNF.
60108 description: Alternate name of VNF.
60111 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.
60114 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
60115 operational-status:
60117 description: Indicator for whether the resource is considered operational
60120 description: OBSOLETE - do not use
60123 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).
60126 description: Client should send valid enumerated value.
60129 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60130 ipv4-loopback0-address:
60132 description: v4 Loopback0 address
60133 orchestration-status:
60135 description: Orchestration status of this VNF, mastered by MSO.
60138 description: Heat stack id corresponding to this instance, managed by MSO
60141 description: Corresponds to the SDN-C catalog id used to configure this VCE
60145 $ref: "#/getDefinitions/relationship"
60149 $ref: "#/getDefinitions/l-interface"
60152 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
60157 $ref: "#/getDefinitions/newvce"
60160 inventory-item-data:
60163 $ref: "#/getDefinitions/inventory-item-data"
60164 notification-event:
60168 notification-event-header:
60170 $ref: "#/getDefinitions/notification-event-header"
60171 notification-event-header:
60212 $ref: "#/getDefinitions/key-data"
60217 OAM network, to be deprecated shortly. Do not use for new purposes.
60218 ###### Related Nodes
60219 - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
60220 - TO complex( oam-network AppliesTo complex, MANY2MANY)
60221 - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
60230 description: UUID of the network. Unique across a cloud-region
60233 description: Name of the network.
60237 description: cvlan-id
60238 ipv4-oam-gateway-address:
60240 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
60241 ipv4-oam-gateway-address-prefix-length:
60244 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
60247 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60251 $ref: "#/getDefinitions/relationship"
60254 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
60259 $ref: "#/getDefinitions/oam-network"
60260 operational-environment:
60262 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
60263 ###### Related Nodes
60264 - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
60265 - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
60268 - operational-environment-id
60269 - operational-environment-name
60270 - operational-environment-type
60271 - operational-environment-status
60275 operational-environment-id:
60277 description: UUID of an operational environment
60278 operational-environment-name:
60280 description: Operational Environment name
60281 operational-environment-type:
60283 description: Operational Environment Type.
60284 operational-environment-status:
60286 description: Status
60289 description: Tenant Context.
60292 description: Workload Context.
60295 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60299 $ref: "#/getDefinitions/relationship"
60300 operational-environments:
60302 a logical partition of the cloud which allows to have multiple environments in the production AIC.
60304 operational-environment:
60307 $ref: "#/getDefinitions/operational-environment"
60310 Allows for legacy POST of old-style and new-style models
60312 - model-invariant-id
60313 - model-name-version-id
60319 model-invariant-id:
60321 description: Unique identifier corresponding to the main definition of a model in ASDC
60322 model-name-version-id:
60324 description: Unique identifier corresponding to one version of a model in ASDC
60327 description: Type of the model, e.g., service, resource, widget, etc.
60330 description: Name of the model, which can change from version to version.
60333 description: Invariant unique ID which does not change from version to version
60336 description: Version
60339 description: Description
60342 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60345 $ref: "#/getDefinitions/model-vers"
60348 $ref: "#/getDefinitions/relationship-list"
60351 Collection of owning-entities
60356 $ref: "#/getDefinitions/owning-entity"
60359 describes an owning-entity
60360 ###### Related Nodes
60361 - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
60365 - owning-entity-name
60369 description: UUID of an owning entity
60370 owning-entity-name:
60372 description: Owning entity name
60375 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60379 $ref: "#/getDefinitions/relationship"
60382 Physical interface (e.g., nic)
60383 ###### Related Nodes
60384 - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
60385 - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
60386 - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
60387 - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
60388 - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
60389 - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
60390 - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
60391 - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1)
60392 - FROM forwarder( forwarder ForwardsTo p-interface, MANY2ONE)
60394 -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
60395 -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
60396 -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
60403 description: Name that identifies the physical interface
60406 description: URL to endpoint where AAI can get more details.
60409 description: Captures the numeric part of the speed
60412 description: Captures the units corresponding to the speed
60415 description: Nature of the services and connectivity on this port.
60416 equipment-identifier:
60418 description: CLEI or other specification for p-interface hardware.
60421 description: Role specification for p-interface hardware.
60424 description: Indicates the physical properties of the interface.
60427 description: Trigger for operational monitoring of this resource by Service Assurance systems.
60430 description: MAC Address of the p-interface.
60433 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60436 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
60439 description: inventory status
60443 $ref: "#/getDefinitions/relationship"
60447 $ref: "#/getDefinitions/sriov-pf"
60451 $ref: "#/getDefinitions/l-interface"
60454 Collection of physical interfaces.
60459 $ref: "#/getDefinitions/p-interface"
60462 Collection of physical connections, typically between p-interfaces
60463 ###### Related Nodes
60464 - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
60466 -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
60472 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
60475 description: Captures the numeric part of the speed
60478 description: Captures the units corresponding to the speed
60481 description: Circuit it
60484 description: Dual access mode (e.g., primary, secondary
60487 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
60488 service-provider-name:
60490 description: Name of the service Provider on this link.
60491 service-provider-bandwidth-up-value:
60494 description: Upstream Bandwidth value agreed with the service provider
60495 service-provider-bandwidth-up-units:
60497 description: Units for the upstream BW value
60498 service-provider-bandwidth-down-value:
60501 description: Downstream Bandwidth value agreed with the service provider
60502 service-provider-bandwidth-down-units:
60504 description: Units for downstream BW value
60507 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60511 $ref: "#/getDefinitions/relationship"
60514 Collection of physical connections, typically between p-interfaces
60519 $ref: "#/getDefinitions/physical-link"
60522 describes a platform
60523 ###### Related Nodes
60524 - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
60531 description: Name of the platform
60534 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60538 $ref: "#/getDefinitions/relationship"
60541 Collection of platforms
60546 $ref: "#/getDefinitions/platform"
60549 PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
60550 ###### Related Nodes
60551 - TO complex( pnf LocatedIn complex, MANY2ONE)
60552 - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
60553 - TO zone( pnf LocatedIn zone, MANY2ONE)
60554 - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many)
60555 - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY)
60556 - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
60557 - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
60558 - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
60559 - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
60560 - FROM configuration( configuration AppliesTo pnf, ONE2MANY)
60562 -(1) IF this PNF node is deleted, this FROM node is DELETED also
60569 description: unique name of Physical Network Function.
60572 description: name of Physical Network Function.
60575 description: URL to endpoint where AAI can get more details.
60578 description: source of name2
60581 description: id of pnf
60584 description: Equipment type. Source of truth should define valid values.
60587 description: Equipment vendor. Source of truth should define valid values.
60590 description: Equipment model. Source of truth should define valid values.
60593 description: identifier of managed by ATT or customer
60596 description: ipv4-oam-address with new naming convention for IP addresses
60599 description: sw-version is the version of SW for the hosted application on the PNF.
60602 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.
60605 description: ID of the physical frame (relay rack) where pnf is installed.
60608 description: Serial number of the device
60609 ipaddress-v4-loopback-0:
60611 description: IPV4 Loopback 0 address
60612 ipaddress-v6-loopback-0:
60614 description: IPV6 Loopback 0 address
60617 description: IPV4 AIM address
60620 description: IPV6 AIM address
60623 description: IPV6 OAM address
60626 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
60629 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60632 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
60635 description: Nf Role is the role performed by this instance in the network.
60639 $ref: "#/getDefinitions/relationship"
60643 $ref: "#/getDefinitions/p-interface"
60647 $ref: "#/getDefinitions/lag-interface"
60650 Collection of Physical Network Functions.
60655 $ref: "#/getDefinitions/pnf"
60658 Used to capture the network interfaces of this VCE
60659 ###### Related Nodes
60660 - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
60661 - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
60663 -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
60664 -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
60667 - orchestration-status
60671 description: Unique ID of the interface
60672 neutron-network-id:
60674 description: Neutron network id of this Interface
60675 neutron-network-name:
60677 description: Neutron network name of this Interface
60680 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
60683 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60686 description: Unique ID for port group in vmware
60689 description: Likely to duplicate value of neutron network name
60692 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
60693 orchestration-status:
60695 description: Orchestration status of this VNF, mastered by MSO
60698 description: Heat stack id corresponding to this instance, managed by MSO
60701 description: Corresponds to the SDN-C catalog id used to configure this VCE
60705 $ref: "#/getDefinitions/cvlan-tag-entry"
60709 $ref: "#/getDefinitions/relationship"
60715 $ref: "#/getDefinitions/port-group"
60718 describes the project
60719 ###### Related Nodes
60720 - TO service-instance( project Uses service-instance, ONE2MANY)
60727 description: Name of the project deploying a service
60730 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60734 $ref: "#/getDefinitions/relationship"
60737 Collection of projects
60742 $ref: "#/getDefinitions/project"
60745 Property holder for query properties or instance properties
60751 property-constraint:
60754 ###### Related Nodes
60755 - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
60757 -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
60759 - property-constraint-uuid
60764 property-constraint-uuid:
60774 property-constraints:
60776 property-constraint:
60779 $ref: "#/getDefinitions/property-constraint"
60782 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
60783 ###### Related Nodes
60784 - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
60785 - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
60786 - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
60787 - TO complex( pserver LocatedIn complex, MANY2ONE)
60788 - TO zone( pserver LocatedIn zone, MANY2ONE)
60789 - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
60790 - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
60791 - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
60792 - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
60793 - FROM vserver( vserver HostedOn pserver, MANY2ONE)
60795 -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
60796 -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
60804 description: Value from executing hostname on the compute node.
60807 description: PTNII name
60811 description: Number of cpus
60815 description: Disk size, in GBs
60819 description: RAM size, in MBs
60822 description: Equipment type. Source of truth should define valid values.
60825 description: Equipment vendor. Source of truth should define valid values.
60828 description: Equipment model. Source of truth should define valid values.
60831 description: Fully-qualified domain name
60834 description: URL to endpoint where AAI can get more details
60837 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
60840 description: Serial number, may be queried
60841 ipaddress-v4-loopback-0:
60843 description: IPV4 Loopback 0 address
60844 ipaddress-v6-loopback-0:
60846 description: IPV6 Loopback 0 address
60849 description: IPV4 AIM address
60852 description: IPV6 AIM address
60855 description: IPV6 OAM address
60858 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
60861 description: ID of Pserver
60864 description: internet topology of Pserver
60867 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.
60870 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60873 description: alternative pserver name
60876 description: purpose of pserver
60879 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
60882 description: Indicates who owns and or manages the device.
60885 description: The host profile that defines the configuration of the pserver.
60889 $ref: "#/getDefinitions/relationship"
60893 $ref: "#/getDefinitions/p-interface"
60897 $ref: "#/getDefinitions/lag-interface"
60900 Collection of compute hosts.
60905 $ref: "#/getDefinitions/pserver"
60908 QueryParameters for performing a named-query or model query
60912 $ref: "#/getDefinitions/named-query"
60915 $ref: "#/getDefinitions/overloaded-model"
60919 ###### Related Nodes
60920 - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
60922 -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
60924 - related-lookup-uuid
60926 - source-node-property
60928 - target-node-property
60930 related-lookup-uuid:
60934 source-node-property:
60938 target-node-property:
60940 property-collect-list:
60947 $ref: "#/getDefinitions/relationship"
60953 $ref: "#/getDefinitions/related-lookup"
60954 related-to-property:
60958 description: Key part of a key/value pair
60961 description: Value part of a key/value pair
60966 description: A keyword provided by A&AI to indicate type of node.
60967 relationship-label:
60969 description: The edge label for this relationship.
60972 description: URL to the object in A&AI.
60976 $ref: "#/getDefinitions/relationship-data"
60977 related-to-property:
60980 $ref: "#/getDefinitions/related-to-property"
60984 - relationship-value
60988 description: A keyword provided by A&AI to indicate an attribute.
60989 relationship-value:
60991 description: Value of the attribute.
60997 $ref: "#/getDefinitions/relationship"
60998 reserved-prop-names:
61000 Internal map to define some reserved properties of a vertex
61002 last-mod-source-of-truth:
61020 Response container for the results of a named-query or model query
61022 inventory-response-items:
61024 $ref: "#/getDefinitions/inventory-response-items"
61029 description: The specific type of node in the A&AI graph
61032 description: The URL to the specific resource
61033 route-table-reference:
61035 Openstack route table reference.
61036 ###### Related Nodes
61037 - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
61040 - route-table-reference-id
61041 - route-table-reference-fqdn
61043 route-table-reference-id:
61045 description: Route Table Reference id, UUID assigned to this instance.
61046 route-table-reference-fqdn:
61048 description: FQDN entry in the route table.
61051 description: Concurrency value
61055 $ref: "#/getDefinitions/relationship"
61056 route-table-references:
61058 Collection of openstack route table references
61060 route-table-reference:
61063 $ref: "#/getDefinitions/route-table-reference"
61066 Route target information
61067 ###### Related Nodes
61068 - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
61070 -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
61072 - global-route-target
61073 - route-target-role
61075 global-route-target:
61077 description: Number used to identify an RT, globally unique in the network
61080 description: Role assigned to this route target
61083 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61087 $ref: "#/getDefinitions/relationship"
61090 Collection of route target information
61095 $ref: "#/getDefinitions/route-target"
61098 ###### Related Nodes
61099 - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
61100 - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
61102 -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
61103 -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
61105 - routing-instance-id
61107 routing-instance-id:
61109 description: Unique id of routing instance
61112 description: rpm owner
61115 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61119 $ref: "#/getDefinitions/site-pair"
61123 $ref: "#/getDefinitions/relationship"
61126 set of probes related to generic-vnf routing instance
61131 $ref: "#/getDefinitions/routing-instance"
61136 $ref: "#/getDefinitions/oam-networks"
61137 az-and-dvs-switches:
61140 $ref: "#/getDefinitions/az-and-dvs-switches"
61143 edge-tag-query-result:
61145 $ref: "#/getDefinitions/edge-tag-query-result"
61146 edge-tag-query-request:
61148 $ref: "#/getDefinitions/edge-tag-query-request"
61151 $ref: "#/getDefinitions/search-results"
61154 $ref: "#/getDefinitions/sdn-zone-response"
61160 $ref: "#/getDefinitions/result-data"
61163 SecondaryFilt for performing a named-query or model query
61174 SecondaryFilts for performing a named-query or model query
61179 $ref: "#/getDefinitions/secondary-filt"
61180 segmentation-assignment:
61182 Openstack segmentation assignment.
61183 ###### Related Nodes
61184 - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
61186 -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
61192 description: Route Table Reference id, UUID assigned to this instance.
61195 description: Concurrency value
61199 $ref: "#/getDefinitions/relationship"
61200 segmentation-assignments:
61202 Collection of openstack segmentation assignments
61204 segmentation-assignment:
61207 $ref: "#/getDefinitions/segmentation-assignment"
61210 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
61213 - service-description
61217 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
61218 service-description:
61220 description: Description of the service
61223 description: URL to endpoint where AAI can get more details
61226 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61229 description: service version
61233 $ref: "#/getDefinitions/relationship"
61234 service-capabilities:
61236 Collection of service capabilities.
61238 service-capability:
61241 $ref: "#/getDefinitions/service-capability"
61242 service-capability:
61244 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
61245 ###### Related Nodes
61246 - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
61247 - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
61249 -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
61257 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
61260 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.
61263 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61267 $ref: "#/getDefinitions/relationship"
61268 service-design-and-creation:
61270 Namespace for objects managed by ASDC
61275 $ref: "#/getDefinitions/vnf-image"
61279 $ref: "#/getDefinitions/service"
61280 service-capabilities:
61283 $ref: "#/getDefinitions/service-capability"
61287 $ref: "#/getDefinitions/model"
61291 $ref: "#/getDefinitions/named-query"
61294 Instance of a service
61295 ###### Related Nodes
61296 - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
61297 - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
61298 - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE)
61299 - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
61300 - TO configuration( service-instance Uses configuration, ONE2MANY)
61301 - TO connector( service-instance Uses connector, MANY2MANY)
61302 - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
61303 - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
61304 - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
61305 - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
61306 - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
61307 - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
61308 - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
61309 - TO zone( service-instance LocatedIn zone, MANY2ONE)
61310 - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
61311 - TO vce( service-instance ComposedOf vce, ONE2MANY)
61312 - TO model-ver( service-instance IsA model-ver, Many2One)
61313 - FROM project( project Uses service-instance, ONE2MANY)
61314 - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
61315 - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
61316 - FROM forwarding-path( forwarding-path AppliesTo service-instance, MANY2ONE)(1)
61317 - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
61319 -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
61320 -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
61321 -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
61323 - service-instance-id
61325 service-instance-id:
61327 description: Uniquely identifies this instance of a service
61328 service-instance-name:
61330 description: This field will store a name assigned to the service-instance.
61333 description: String capturing type of service.
61336 description: String capturing the service role.
61337 environment-context:
61339 description: This field will store the environment context assigned to the service-instance.
61342 description: This field will store the workload context assigned to the service-instance.
61345 description: create time of Network Service.
61348 description: last update of Network Service.
61351 description: short description for service-instance.
61352 model-invariant-id:
61354 description: the ASDC model id for this resource or service model.
61357 description: the ASDC model version for this resource or service model.
61358 persona-model-version:
61360 description: the ASDC model version for this resource or service model.
61363 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
61364 widget-model-version:
61366 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
61369 description: Indicates the total bandwidth to be used for this service.
61372 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
61373 bandwidth-down-wan1:
61375 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
61378 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
61379 bandwidth-down-wan2:
61381 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
61384 description: URL customers will use to access the vHN Portal.
61385 service-instance-location-id:
61387 description: An identifier that customers assign to the location where this service is being used.
61390 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61393 description: Path to the controller object.
61394 orchestration-status:
61396 description: Orchestration status of this service.
61400 $ref: "#/getDefinitions/relationship"
61404 $ref: "#/getDefinitions/metadatum"
61405 allotted-resources:
61408 $ref: "#/getDefinitions/allotted-resource"
61411 Collection of service instances
61416 $ref: "#/getDefinitions/service-instance"
61417 service-subscription:
61419 Object that group service instances.
61420 ###### Related Nodes
61421 - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
61422 - TO tenant( service-subscription Uses tenant, MANY2MANY)
61423 - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
61425 -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
61426 -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
61432 description: Value defined by orchestration to identify this service across ECOMP.
61433 temp-ub-sub-account-id:
61435 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
61438 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61442 $ref: "#/getDefinitions/service-instance"
61446 $ref: "#/getDefinitions/relationship"
61447 service-subscriptions:
61449 Collection of objects that group service instances.
61451 service-subscription:
61454 $ref: "#/getDefinitions/service-subscription"
61457 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
61462 $ref: "#/getDefinitions/service"
61465 ###### Related Nodes
61466 - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
61467 - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
61469 -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
61470 -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
61476 description: unique identifier of probe
61479 description: Prefix address
61482 description: Prefix address
61485 description: ip version, v4, v6
61486 destination-hostname:
61488 description: Hostname of the destination equipment to which SLAs are measured against.
61489 destination-equip-type:
61491 description: The type of destinatination equipment. Could be Router, UCPE, etc.
61494 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61495 classes-of-service:
61498 $ref: "#/getDefinitions/class-of-service"
61502 $ref: "#/getDefinitions/relationship"
61505 Set of instances for probes used to measure service level agreements
61506 ###### Related Nodes
61507 - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
61508 - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
61510 -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
61516 description: Unique id of site pair set.
61519 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61523 $ref: "#/getDefinitions/routing-instance"
61527 $ref: "#/getDefinitions/relationship"
61530 Collection of sets of instances for probes related to generic-vnf
61535 $ref: "#/getDefinitions/site-pair-set"
61543 $ref: "#/getDefinitions/site-pair"
61547 ###### Related Nodes
61548 - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
61549 - FROM vserver( vserver Uses snapshot, ONE2ONE)
61556 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
61559 description: Snapshot name
61560 snapshot-architecture:
61562 description: Operating system architecture
61563 snapshot-os-distro:
61565 description: The common name of the operating system distribution in lowercase
61566 snapshot-os-version:
61568 description: The operating system version as specified by the distributor.
61571 description: The application that the image instantiates.
61572 application-vendor:
61574 description: The vendor of the application.
61575 application-version:
61577 description: The version of the application.
61580 description: URL to endpoint where AAI can get more details
61583 description: This field contains the UUID of the previous snapshot (if any).
61586 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61590 $ref: "#/getDefinitions/relationship"
61593 Collection of openstack snapshots
61598 $ref: "#/getDefinitions/snapshot"
61601 SR-IOV Physical Function
61602 ###### Related Nodes
61603 - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
61604 - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
61606 -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
61612 description: Identifier for the sriov-pf
61615 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61619 $ref: "#/getDefinitions/relationship"
61622 Collection of SR-IOV Physical Functions.
61627 $ref: "#/getDefinitions/sriov-pf"
61630 SR-IOV Virtual Function (not to be confused with virtual network function)
61631 ###### Related Nodes
61632 - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
61633 - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE)
61635 -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
61641 description: PCI ID used to identify the sriov-vf
61644 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
61647 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
61650 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
61651 vf-vlan-anti-spoof-check:
61653 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.
61654 vf-mac-anti-spoof-check:
61656 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.
61659 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
61660 vf-broadcast-allow:
61662 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
61663 vf-unknown-multicast-allow:
61665 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
61666 vf-unknown-unicast-allow:
61668 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
61671 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
61674 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
61677 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61678 neutron-network-id:
61680 description: Neutron network id of the interface
61684 $ref: "#/getDefinitions/relationship"
61687 Collection of SR-IOV Virtual Functions.
61692 $ref: "#/getDefinitions/sriov-vf"
61701 ###### Related Nodes
61702 - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
61703 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
61704 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
61705 - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1)
61706 - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
61707 - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
61709 -(1) IF this SUBNET node is deleted, this FROM node is DELETED also
61710 -(4) IF this TO node is deleted, this SUBNET is DELETED also
61711 -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
61719 description: Subnet ID, should be UUID.
61722 description: Name associated with the subnet.
61725 description: Neutron id of this subnet
61728 description: gateway ip address
61729 network-start-address:
61731 description: network start address
61734 description: cidr mask
61737 description: ip version
61738 orchestration-status:
61740 description: Orchestration status of this VNF, mastered by MSO
61743 description: dhcp enabled
61746 description: the start address reserved for use by dhcp
61749 description: the last address reserved for use by dhcp
61752 description: role of the subnet, referenced when assigning IPs
61753 ip-assignment-direction:
61755 description: ip address assignment direction of the subnet
61758 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61762 description: sequence of the subnet
61766 $ref: "#/getDefinitions/host-route"
61770 $ref: "#/getDefinitions/relationship"
61776 $ref: "#/getDefinitions/subnet"
61777 tagged-inventory-item-list:
61782 $ref: "#/getDefinitions/inventory-item"
61786 ###### Related Nodes
61787 - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
61788 - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
61789 - TO l3-network( tenant Uses l3-network, MANY2MANY)
61790 - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
61791 - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
61792 - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
61794 -TENANT cannot be deleted if related to VSERVER
61802 description: Unique id relative to the cloud-region.
61805 description: Readable name of tenant
61808 description: This field will store the tenant context.
61811 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61815 $ref: "#/getDefinitions/vserver"
61819 $ref: "#/getDefinitions/relationship"
61822 Collection of openstack tenants.
61827 $ref: "#/getDefinitions/tenant"
61830 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
61831 ###### Related Nodes
61832 - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
61834 -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
61840 description: Allotted Resource id UUID assigned to this instance.
61843 description: The WAN uplink bandwidth for WAN1
61844 bandwidth-down-wan1:
61846 description: The WAN downlink bandwidth for WAN1
61849 description: The WAN uplink bandwidth for WAN2
61850 bandwidth-down-wan2:
61852 description: The WAN downlink bandwidth for WAN2
61855 description: Concurrency value
61859 $ref: "#/getDefinitions/relationship"
61862 This object is used to store the specific tunnel cross connect aspects of an allotted resource
61867 $ref: "#/getDefinitions/tunnel-xconnect"
61870 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
61879 $ref: "#/getDefinitions/update-node-key"
61885 $ref: "#/getDefinitions/action"
61894 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
61895 ###### Related Nodes
61896 - TO availability-zone( vce Uses availability-zone, MANY2MANY)
61897 - TO complex( vce LocatedIn complex, MANY2MANY)
61898 - TO vserver( vce HostedOn vserver, ONE2MANY)
61899 - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
61900 - FROM license( license BelongsTo vce, MANY2ONE)(1)
61901 - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
61902 - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
61904 -(1) IF this VCE node is deleted, this FROM node is DELETED also
61912 description: Unique id of VNF. This is unique across the graph.
61915 description: Name of VNF.
61918 description: Alternate name of VNF.
61921 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.
61924 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
61925 regional-resource-zone:
61927 description: Regional way of organizing pservers, source of truth should define values
61930 description: Trigger for operational monitoring of this resource by Service Assurance systems.
61931 operational-status:
61933 description: Indicator for whether the resource is considered operational
61936 description: OBSOLETE - do not use
61939 description: Network role being played by this VNF
61940 orchestration-status:
61942 description: Orchestration status of this VNF, mastered by MSO
61945 description: Heat stack id corresponding to this instance, managed by MSO
61948 description: Corresponds to the SDN-C catalog id used to configure this VCE
61951 description: Unique ID of VPE connected to this VCE.
61952 v6-vce-wan-address:
61954 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
61957 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
61960 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61961 ipv4-loopback0-address:
61963 description: Loopback0 address
61964 entitlement-resource-uuid:
61966 description: OBSOLETE - see child relationships
61970 $ref: "#/getDefinitions/port-group"
61974 $ref: "#/getDefinitions/license"
61978 $ref: "#/getDefinitions/entitlement"
61982 $ref: "#/getDefinitions/relationship"
61985 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
61990 $ref: "#/getDefinitions/vce"
61993 a deployment unit of VNFCs
61994 ###### Related Nodes
61995 - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
61996 - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
61997 - TO vnfc( vf-module Uses vnfc, ONE2MANY)
61998 - TO volume-group( vf-module Uses volume-group, ONE2ONE)
61999 - TO vserver( vf-module Uses vserver, ONE2MANY)
62000 - TO model-ver( vf-module IsA model-ver, Many2One)
62002 -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
62003 -VF-MODULE cannot be deleted if related to VNFC
62007 - is-base-vf-module
62011 description: Unique ID of vf-module.
62014 description: Name of vf-module
62017 description: Heat stack id corresponding to this instance.
62018 orchestration-status:
62020 description: orchestration status of this vf-module, mastered by MSO
62023 description: used to indicate whether or not this object is base vf module
62026 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62027 model-invariant-id:
62029 description: the ASDC model id for this resource or service model.
62032 description: the ASDC model version for this resource or service model.
62033 persona-model-version:
62035 description: the ASDC model version for this resource or service model.
62036 model-customization-id:
62038 description: captures the id of all the configuration used to customize the resource for the service.
62041 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
62042 widget-model-version:
62044 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
62045 contrail-service-instance-fqdn:
62047 description: the Contrail unique ID for a service-instance
62051 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
62054 description: Path to the controller object.
62058 $ref: "#/getDefinitions/relationship"
62061 Collection of vf-modules, a deployment unit of VNFCs
62066 $ref: "#/getDefinitions/vf-module"
62069 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
62070 ###### Related Nodes
62071 - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
62073 -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
62079 description: indicates whether the VIG is for AVPN or INTERNET
62082 description: v4 IP of the vig server
62085 description: v6 IP of the vig server
62088 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62092 $ref: "#/getDefinitions/relationship"
62098 $ref: "#/getDefinitions/vig-server"
62099 vip-ipv4-address-list:
62102 ###### Related Nodes
62103 - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
62104 - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
62105 - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
62106 - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
62113 description: IP address
62114 vip-ipv4-prefix-length:
62117 description: Prefix length, 32 for single address
62121 description: Inner VLAN tag
62125 description: Outer VLAN tag
62128 description: Indicator of fixed or floating address
62131 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62132 neutron-network-id:
62134 description: Neutron network id of the interface that address belongs to
62137 description: Neutron id of subnet that address belongs to
62141 $ref: "#/getDefinitions/relationship"
62142 vip-ipv6-address-list:
62145 ###### Related Nodes
62146 - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
62147 - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
62148 - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
62149 - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
62156 description: IP address
62157 vip-ipv6-prefix-length:
62160 description: Prefix length, 128 for single address
62164 description: Inner VLAN tag
62168 description: Outer VLAN tag
62171 description: Indicator of fixed or floating address
62174 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62175 neutron-network-id:
62177 description: Neutron network id of the interface that address belongs to
62180 description: Neutron id of subnet that address belongs to
62184 $ref: "#/getDefinitions/relationship"
62185 virtual-data-center:
62187 Virtual organization of cloud infrastructure elements in a data center context
62188 ###### Related Nodes
62189 - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
62190 - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
62191 - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
62199 description: Unique ID of the vdc
62202 description: Name of the virtual data center
62205 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62209 $ref: "#/getDefinitions/relationship"
62210 virtual-data-centers:
62212 Virtual organization of cloud infrastructure elements in a data center context
62214 virtual-data-center:
62217 $ref: "#/getDefinitions/virtual-data-center"
62221 ###### Related Nodes
62222 - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
62223 - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
62224 - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
62225 - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
62226 - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
62227 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
62228 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
62230 -(1) IF this VLAN node is deleted, this FROM node is DELETED also
62231 -(2) IF this VLAN node is deleted, this TO node is DELETED also
62232 -(4) IF this TO node is deleted, this VLAN is DELETED also
62240 description: String that identifies the interface
62244 description: Inner VLAN tag
62248 description: Outer VLAN tag
62251 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62254 description: Captures the numeric part of the speed
62257 description: Captures the units corresponding to the speed
62260 description: Used to describe (the service associated with) the vlan
62261 backdoor-connection:
62263 description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
62266 description: This indicates the customers VPN ID associated with this vlan
62267 orchestration-status:
62269 description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
62272 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
62275 description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
62278 description: Flag indicating the interface uses the IP Unnumbered configuration.
62282 $ref: "#/getDefinitions/relationship"
62283 l3-interface-ipv4-address-list:
62286 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
62287 l3-interface-ipv6-address-list:
62290 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
62296 $ref: "#/getDefinitions/vlan"
62305 description: Unique id of VNF. This is unique across the graph.
62308 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
62309 ###### Related Nodes
62310 - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
62312 -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
62317 - application-vendor
62321 description: Unique ID of this asset
62324 description: The application that the image instantiates.
62325 application-vendor:
62327 description: The vendor of the application.
62328 application-version:
62330 description: The version of the application.
62333 description: URL to endpoint where AAI can get more details
62336 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62340 $ref: "#/getDefinitions/relationship"
62343 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
62348 $ref: "#/getDefinitions/vnf-image"
62351 ###### Related Nodes
62352 - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
62353 - TO instance-group( vnfc MemberOf instance-group, MANY2MANY)
62354 - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY)
62355 - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY)
62356 - TO vserver( vnfc HostedOn vserver, ONE2MANY)
62357 - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
62358 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1)
62359 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1)
62361 -(1) IF this VNFC node is deleted, this FROM node is DELETED also
62362 -(4) IF this TO node is deleted, this VNFC is DELETED also
62368 - is-closed-loop-disabled
62372 description: Unique ID of vnfc.
62375 description: Short code that is used in naming instances of the item being modeled
62378 description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
62381 description: prov status of this vnfc
62382 orchestration-status:
62384 description: Orchestration status of this VNF, mastered by APP-C
62385 ipaddress-v4-oam-vip:
62387 description: Oam V4 vip address of this vnfc
62390 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
62391 is-closed-loop-disabled:
62393 description: used to indicate whether closed loop function is enabled on this node
62396 description: Group notation of VNFC
62397 model-invariant-id:
62399 description: the ASDC model id for this resource or service model.
62402 description: the ASDC model version for this resource or service model.
62405 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62409 $ref: "#/getDefinitions/relationship"
62410 l3-interface-ipv4-address-list:
62413 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
62414 l3-interface-ipv6-address-list:
62417 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
62420 virtual network components associated with a vserver from application controller.
62425 $ref: "#/getDefinitions/vnfc"
62428 Ephemeral Block storage volume.
62429 ###### Related Nodes
62430 - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
62432 -(3) IF this FROM node is deleted, this VOLUME is DELETED also
62439 description: Unique ID of block storage volume relative to the vserver.
62442 description: URL to endpoint where AAI can get more details
62445 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62449 $ref: "#/getDefinitions/relationship"
62452 Persistent block-level storage.
62453 ###### Related Nodes
62454 - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
62455 - TO complex( volume-group LocatedIn complex, MANY2ONE)
62456 - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
62457 - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
62458 - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
62462 - volume-group-name
62467 description: Unique ID of volume-group.
62470 description: Name of the volume group.
62473 description: Heat stack id corresponding to this volume-group
62476 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.
62477 orchestration-status:
62479 description: Orchestration status of this volume-group
62480 model-customization-id:
62482 description: captures the id of all the configuration used to customize the resource for the service.
62483 vf-module-model-customization-id:
62485 description: helps relate the volume group to the vf-module whose components will require the volume group
62488 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62492 $ref: "#/getDefinitions/relationship"
62495 Collection of persistent block-level storage.
62500 $ref: "#/getDefinitions/volume-group"
62503 Collection of ephemeral Block storage volumes.
62508 $ref: "#/getDefinitions/volume"
62511 VPLS Provider Edge routers.
62512 ###### Related Nodes
62513 - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
62514 - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
62515 - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
62516 - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
62518 -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
62526 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
62529 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).
62532 description: Client should send valid enumerated value, e.g., VPLS-PE.
62536 description: Temporary location for stag to get to VCE
62539 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62543 $ref: "#/getDefinitions/relationship"
62547 $ref: "#/getDefinitions/p-interface"
62551 $ref: "#/getDefinitions/lag-interface"
62554 Collection of VPLS Provider Edge routers
62559 $ref: "#/getDefinitions/vpls-pe"
62563 ###### Related Nodes
62564 - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY)
62565 - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
62566 - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
62567 - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)
62569 -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
62570 -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
62578 description: VPN ID, globally unique within A&AI
62581 description: VPN Name
62584 description: the platform associated with the VPN example AVPN, Mobility
62587 description: Type of the vpn, should be taken from enumerated/valid values
62590 description: region of customer vpn
62593 description: id for this customer vpn
62594 route-distinguisher:
62596 description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
62599 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62603 $ref: "#/getDefinitions/route-target"
62607 $ref: "#/getDefinitions/relationship"
62608 description: l3-networks relate to vpn-bindings
62614 $ref: "#/getDefinitions/vpn-binding"
62617 Virtual Servers, aka virtual machine or VM.
62618 ###### Related Nodes
62619 - TO tenant( vserver BelongsTo tenant, MANY2ONE)
62620 - TO flavor( vserver Uses flavor, MANY2ONE)
62621 - TO image( vserver Uses image, MANY2ONE)
62622 - TO pserver( vserver HostedOn pserver, MANY2ONE)
62623 - TO snapshot( vserver Uses snapshot, ONE2ONE)
62624 - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
62625 - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
62626 - FROM vce( vce HostedOn vserver, ONE2MANY)
62627 - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
62628 - FROM vf-module( vf-module Uses vserver, ONE2MANY)
62629 - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
62631 -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
62632 -(2) IF this VSERVER node is deleted, this TO node is DELETED also
62638 - is-closed-loop-disabled
62642 description: Unique identifier for this vserver relative to its tenant
62645 description: Name of vserver
62648 description: Alternative name of vserver
62651 description: Trigger for operational monitoring of this resource by Service Assurance systems.
62654 description: URL to endpoint where AAI can get more details
62657 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.
62658 is-closed-loop-disabled:
62660 description: Used to indicate whether closed loop function is enabled on this node
62663 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62667 $ref: "#/getDefinitions/volume"
62671 $ref: "#/getDefinitions/relationship"
62675 $ref: "#/getDefinitions/l-interface"
62678 Collection of virtual Servers, aka virtual machines or VMs.
62683 $ref: "#/getDefinitions/vserver"
62686 A zone is a grouping of assets in a location homing to the same connections into the CBB
62687 ###### Related Nodes
62688 - TO complex( zone LocatedIn complex, MANY2ONE)
62689 - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
62690 - FROM pnf( pnf LocatedIn zone, MANY2ONE)
62691 - FROM pserver( pserver LocatedIn zone, MANY2ONE)
62692 - FROM service-instance( service-instance LocatedIn zone, MANY2ONE)
62702 description: Code assigned by AIC to the zone
62705 description: English name associated with the zone
62708 description: Design of zone [Medium/Largeā¦]
62711 description: Context of zone [production/test]
62714 description: Status of a zone.
62717 description: Concurrency value
62721 $ref: "#/getDefinitions/relationship"
62724 Collection of zones
62729 $ref: "#/getDefinitions/zone"