5 [Differences versus the previous schema version](apidocs/aai_swagger_v9.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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)
4359 $ref: "#/definitions/tenant"
4362 - CloudInfrastructure
4363 summary: update an existing tenant
4365 Update an existing tenant
4367 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4368 The PUT operation will entirely replace an existing object.
4369 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
4371 Other differences between PUT and PATCH are:
4373 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
4374 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4375 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4376 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
4385 description: Response codes found in [response codes](https://wiki.onap.org/).
4389 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4392 example: __CLOUD-OWNER__
4393 - name: cloud-region-id
4395 description: Identifier used by the vendor for the region. Second part of composite key
4398 example: __CLOUD-REGION-ID__
4401 description: Unique id relative to the cloud-region.
4404 example: __TENANT-ID__
4407 description: tenant object that needs to be updated.
4410 $ref: "#/patchDefinitions/tenant"
4413 - CloudInfrastructure
4414 summary: delete an existing tenant
4415 description: delete an existing tenant
4416 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
4425 description: Response codes found in [response codes](https://wiki.onap.org/).
4429 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4432 example: __CLOUD-OWNER__
4433 - name: cloud-region-id
4435 description: Identifier used by the vendor for the region. Second part of composite key
4438 example: __CLOUD-REGION-ID__
4441 description: Unique id relative to the cloud-region.
4444 example: __TENANT-ID__
4445 - name: resource-version
4447 description: resource-version for concurrency
4450 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants:
4453 - CloudInfrastructure
4454 summary: returns tenants
4455 description: returns tenants
4456 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenants
4462 description: successful operation
4464 $ref: "#/getDefinitions/tenants"
4466 description: Response codes found in [response codes](https://wiki.onap.org/).
4470 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4473 example: __CLOUD-OWNER__
4474 - name: cloud-region-id
4476 description: Identifier used by the vendor for the region. Second part of composite key
4479 example: __CLOUD-REGION-ID__
4490 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship:
4493 - CloudInfrastructure
4494 summary: see node definition for valid relationships
4495 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
4504 description: Response codes found in [response codes](https://wiki.onap.org/).
4508 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4511 example: __CLOUD-OWNER__
4512 - name: cloud-region-id
4514 description: Identifier used by the vendor for the region. Second part of composite key
4517 example: __CLOUD-REGION-ID__
4520 description: Flavor id, expected to be unique across cloud-region.
4523 example: __FLAVOR-ID__
4526 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
4529 $ref: "#/definitions/relationship"
4532 - CloudInfrastructure
4533 summary: delete an existing relationship
4534 description: delete an existing relationship
4535 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
4544 description: Response codes found in [response codes](https://wiki.onap.org/).
4548 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4551 example: __CLOUD-OWNER__
4552 - name: cloud-region-id
4554 description: Identifier used by the vendor for the region. Second part of composite key
4557 example: __CLOUD-REGION-ID__
4560 description: Flavor id, expected to be unique across cloud-region.
4563 example: __FLAVOR-ID__
4564 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}:
4567 - CloudInfrastructure
4568 summary: returns flavor
4569 description: returns flavor
4570 operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
4576 description: successful operation
4578 $ref: "#/getDefinitions/flavor"
4580 description: Response codes found in [response codes](https://wiki.onap.org/).
4584 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4587 example: __CLOUD-OWNER__
4588 - name: cloud-region-id
4590 description: Identifier used by the vendor for the region. Second part of composite key
4593 example: __CLOUD-REGION-ID__
4596 description: Flavor id, expected to be unique across cloud-region.
4599 example: __FLAVOR-ID__
4602 - CloudInfrastructure
4603 summary: create or update an existing flavor
4605 Create or update an existing flavor.
4607 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
4608 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
4617 description: Response codes found in [response codes](https://wiki.onap.org/).
4621 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4624 example: __CLOUD-OWNER__
4625 - name: cloud-region-id
4627 description: Identifier used by the vendor for the region. Second part of composite key
4630 example: __CLOUD-REGION-ID__
4633 description: Flavor id, expected to be unique across cloud-region.
4636 example: __FLAVOR-ID__
4639 description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
4642 $ref: "#/definitions/flavor"
4645 - CloudInfrastructure
4646 summary: update an existing flavor
4648 Update an existing flavor
4650 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4651 The PUT operation will entirely replace an existing object.
4652 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
4654 Other differences between PUT and PATCH are:
4656 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
4657 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4658 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4659 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
4668 description: Response codes found in [response codes](https://wiki.onap.org/).
4672 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4675 example: __CLOUD-OWNER__
4676 - name: cloud-region-id
4678 description: Identifier used by the vendor for the region. Second part of composite key
4681 example: __CLOUD-REGION-ID__
4684 description: Flavor id, expected to be unique across cloud-region.
4687 example: __FLAVOR-ID__
4690 description: flavor object that needs to be updated.
4693 $ref: "#/patchDefinitions/flavor"
4696 - CloudInfrastructure
4697 summary: delete an existing flavor
4698 description: delete an existing flavor
4699 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
4708 description: Response codes found in [response codes](https://wiki.onap.org/).
4712 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4715 example: __CLOUD-OWNER__
4716 - name: cloud-region-id
4718 description: Identifier used by the vendor for the region. Second part of composite key
4721 example: __CLOUD-REGION-ID__
4724 description: Flavor id, expected to be unique across cloud-region.
4727 example: __FLAVOR-ID__
4728 - name: resource-version
4730 description: resource-version for concurrency
4733 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors:
4736 - CloudInfrastructure
4737 summary: returns flavors
4738 description: returns flavors
4739 operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavors
4745 description: successful operation
4747 $ref: "#/getDefinitions/flavors"
4749 description: Response codes found in [response codes](https://wiki.onap.org/).
4753 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4756 example: __CLOUD-OWNER__
4757 - name: cloud-region-id
4759 description: Identifier used by the vendor for the region. Second part of composite key
4762 example: __CLOUD-REGION-ID__
4773 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship:
4776 - CloudInfrastructure
4777 summary: see node definition for valid relationships
4778 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
4787 description: Response codes found in [response codes](https://wiki.onap.org/).
4791 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4794 example: __CLOUD-OWNER__
4795 - name: cloud-region-id
4797 description: Identifier used by the vendor for the region. Second part of composite key
4800 example: __CLOUD-REGION-ID__
4803 description: Group id, expected to be unique across cloud-region.
4806 example: __GROUP-ID__
4809 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
4812 $ref: "#/definitions/relationship"
4815 - CloudInfrastructure
4816 summary: delete an existing relationship
4817 description: delete an existing relationship
4818 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
4827 description: Response codes found in [response codes](https://wiki.onap.org/).
4831 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4834 example: __CLOUD-OWNER__
4835 - name: cloud-region-id
4837 description: Identifier used by the vendor for the region. Second part of composite key
4840 example: __CLOUD-REGION-ID__
4843 description: Group id, expected to be unique across cloud-region.
4846 example: __GROUP-ID__
4847 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}:
4850 - CloudInfrastructure
4851 summary: returns group-assignment
4852 description: returns group-assignment
4853 operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
4859 description: successful operation
4861 $ref: "#/getDefinitions/group-assignment"
4863 description: Response codes found in [response codes](https://wiki.onap.org/).
4867 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4870 example: __CLOUD-OWNER__
4871 - name: cloud-region-id
4873 description: Identifier used by the vendor for the region. Second part of composite key
4876 example: __CLOUD-REGION-ID__
4879 description: Group id, expected to be unique across cloud-region.
4882 example: __GROUP-ID__
4885 - CloudInfrastructure
4886 summary: create or update an existing group-assignment
4888 Create or update an existing group-assignment.
4890 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
4891 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
4900 description: Response codes found in [response codes](https://wiki.onap.org/).
4904 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4907 example: __CLOUD-OWNER__
4908 - name: cloud-region-id
4910 description: Identifier used by the vendor for the region. Second part of composite key
4913 example: __CLOUD-REGION-ID__
4916 description: Group id, expected to be unique across cloud-region.
4919 example: __GROUP-ID__
4922 description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
4925 $ref: "#/definitions/group-assignment"
4928 - CloudInfrastructure
4929 summary: update an existing group-assignment
4931 Update an existing group-assignment
4933 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4934 The PUT operation will entirely replace an existing object.
4935 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
4937 Other differences between PUT and PATCH are:
4939 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
4940 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4941 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4942 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
4951 description: Response codes found in [response codes](https://wiki.onap.org/).
4955 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4958 example: __CLOUD-OWNER__
4959 - name: cloud-region-id
4961 description: Identifier used by the vendor for the region. Second part of composite key
4964 example: __CLOUD-REGION-ID__
4967 description: Group id, expected to be unique across cloud-region.
4970 example: __GROUP-ID__
4973 description: group-assignment object that needs to be updated.
4976 $ref: "#/patchDefinitions/group-assignment"
4979 - CloudInfrastructure
4980 summary: delete an existing group-assignment
4981 description: delete an existing group-assignment
4982 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
4991 description: Response codes found in [response codes](https://wiki.onap.org/).
4995 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4998 example: __CLOUD-OWNER__
4999 - name: cloud-region-id
5001 description: Identifier used by the vendor for the region. Second part of composite key
5004 example: __CLOUD-REGION-ID__
5007 description: Group id, expected to be unique across cloud-region.
5010 example: __GROUP-ID__
5011 - name: resource-version
5013 description: resource-version for concurrency
5016 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments:
5019 - CloudInfrastructure
5020 summary: returns group-assignments
5021 description: returns group-assignments
5022 operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments
5028 description: successful operation
5030 $ref: "#/getDefinitions/group-assignments"
5032 description: Response codes found in [response codes](https://wiki.onap.org/).
5036 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5039 example: __CLOUD-OWNER__
5040 - name: cloud-region-id
5042 description: Identifier used by the vendor for the region. Second part of composite key
5045 example: __CLOUD-REGION-ID__
5061 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship:
5064 - CloudInfrastructure
5065 summary: see node definition for valid relationships
5066 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5075 description: Response codes found in [response codes](https://wiki.onap.org/).
5079 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5082 example: __CLOUD-OWNER__
5083 - name: cloud-region-id
5085 description: Identifier used by the vendor for the region. Second part of composite key
5088 example: __CLOUD-REGION-ID__
5091 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5094 example: __SNAPSHOT-ID__
5097 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
5100 $ref: "#/definitions/relationship"
5103 - CloudInfrastructure
5104 summary: delete an existing relationship
5105 description: delete an existing relationship
5106 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5115 description: Response codes found in [response codes](https://wiki.onap.org/).
5119 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5122 example: __CLOUD-OWNER__
5123 - name: cloud-region-id
5125 description: Identifier used by the vendor for the region. Second part of composite key
5128 example: __CLOUD-REGION-ID__
5131 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5134 example: __SNAPSHOT-ID__
5135 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}:
5138 - CloudInfrastructure
5139 summary: returns snapshot
5140 description: returns snapshot
5141 operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5147 description: successful operation
5149 $ref: "#/getDefinitions/snapshot"
5151 description: Response codes found in [response codes](https://wiki.onap.org/).
5155 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5158 example: __CLOUD-OWNER__
5159 - name: cloud-region-id
5161 description: Identifier used by the vendor for the region. Second part of composite key
5164 example: __CLOUD-REGION-ID__
5167 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5170 example: __SNAPSHOT-ID__
5173 - CloudInfrastructure
5174 summary: create or update an existing snapshot
5176 Create or update an existing snapshot.
5178 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
5179 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5188 description: Response codes found in [response codes](https://wiki.onap.org/).
5192 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5195 example: __CLOUD-OWNER__
5196 - name: cloud-region-id
5198 description: Identifier used by the vendor for the region. Second part of composite key
5201 example: __CLOUD-REGION-ID__
5204 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5207 example: __SNAPSHOT-ID__
5210 description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
5213 $ref: "#/definitions/snapshot"
5216 - CloudInfrastructure
5217 summary: update an existing snapshot
5219 Update an existing snapshot
5221 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5222 The PUT operation will entirely replace an existing object.
5223 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
5225 Other differences between PUT and PATCH are:
5227 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
5228 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5229 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5230 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5239 description: Response codes found in [response codes](https://wiki.onap.org/).
5243 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5246 example: __CLOUD-OWNER__
5247 - name: cloud-region-id
5249 description: Identifier used by the vendor for the region. Second part of composite key
5252 example: __CLOUD-REGION-ID__
5255 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5258 example: __SNAPSHOT-ID__
5261 description: snapshot object that needs to be updated.
5264 $ref: "#/patchDefinitions/snapshot"
5267 - CloudInfrastructure
5268 summary: delete an existing snapshot
5269 description: delete an existing snapshot
5270 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5279 description: Response codes found in [response codes](https://wiki.onap.org/).
5283 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5286 example: __CLOUD-OWNER__
5287 - name: cloud-region-id
5289 description: Identifier used by the vendor for the region. Second part of composite key
5292 example: __CLOUD-REGION-ID__
5295 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5298 example: __SNAPSHOT-ID__
5299 - name: resource-version
5301 description: resource-version for concurrency
5304 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots:
5307 - CloudInfrastructure
5308 summary: returns snapshots
5309 description: returns snapshots
5310 operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots
5316 description: successful operation
5318 $ref: "#/getDefinitions/snapshots"
5320 description: Response codes found in [response codes](https://wiki.onap.org/).
5324 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5327 example: __CLOUD-OWNER__
5328 - name: cloud-region-id
5330 description: Identifier used by the vendor for the region. Second part of composite key
5333 example: __CLOUD-REGION-ID__
5339 - name: snapshot-name
5349 - name: application-vendor
5354 - name: application-version
5359 - name: prev-snapshot-id
5364 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship:
5367 - CloudInfrastructure
5368 summary: see node definition for valid relationships
5369 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
5378 description: Response codes found in [response codes](https://wiki.onap.org/).
5382 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5385 example: __CLOUD-OWNER__
5386 - name: cloud-region-id
5388 description: Identifier used by the vendor for the region. Second part of composite key
5391 example: __CLOUD-REGION-ID__
5394 description: Image id, expected to be unique across cloud region
5397 example: __IMAGE-ID__
5400 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
5403 $ref: "#/definitions/relationship"
5406 - CloudInfrastructure
5407 summary: delete an existing relationship
5408 description: delete an existing relationship
5409 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
5418 description: Response codes found in [response codes](https://wiki.onap.org/).
5422 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5425 example: __CLOUD-OWNER__
5426 - name: cloud-region-id
5428 description: Identifier used by the vendor for the region. Second part of composite key
5431 example: __CLOUD-REGION-ID__
5434 description: Image id, expected to be unique across cloud region
5437 example: __IMAGE-ID__
5438 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}:
5441 - CloudInfrastructure
5442 summary: returns metadatum
5443 description: returns metadatum
5444 operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
5450 description: successful operation
5452 $ref: "#/getDefinitions/metadatum"
5454 description: Response codes found in [response codes](https://wiki.onap.org/).
5458 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5461 example: __CLOUD-OWNER__
5462 - name: cloud-region-id
5464 description: Identifier used by the vendor for the region. Second part of composite key
5467 example: __CLOUD-REGION-ID__
5470 description: Image id, expected to be unique across cloud region
5473 example: __IMAGE-ID__
5478 example: __METANAME__
5481 - CloudInfrastructure
5482 summary: create or update an existing metadatum
5484 Create or update an existing metadatum.
5486 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
5487 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
5496 description: Response codes found in [response codes](https://wiki.onap.org/).
5500 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5503 example: __CLOUD-OWNER__
5504 - name: cloud-region-id
5506 description: Identifier used by the vendor for the region. Second part of composite key
5509 example: __CLOUD-REGION-ID__
5512 description: Image id, expected to be unique across cloud region
5515 example: __IMAGE-ID__
5520 example: __METANAME__
5523 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)
5526 $ref: "#/definitions/metadatum"
5529 - CloudInfrastructure
5530 summary: update an existing metadatum
5532 Update an existing metadatum
5534 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5535 The PUT operation will entirely replace an existing object.
5536 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
5538 Other differences between PUT and PATCH are:
5540 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
5541 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5542 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5543 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
5552 description: Response codes found in [response codes](https://wiki.onap.org/).
5556 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5559 example: __CLOUD-OWNER__
5560 - name: cloud-region-id
5562 description: Identifier used by the vendor for the region. Second part of composite key
5565 example: __CLOUD-REGION-ID__
5568 description: Image id, expected to be unique across cloud region
5571 example: __IMAGE-ID__
5576 example: __METANAME__
5579 description: metadatum object that needs to be updated.
5582 $ref: "#/patchDefinitions/metadatum"
5585 - CloudInfrastructure
5586 summary: delete an existing metadatum
5587 description: delete an existing metadatum
5588 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
5597 description: Response codes found in [response codes](https://wiki.onap.org/).
5601 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5604 example: __CLOUD-OWNER__
5605 - name: cloud-region-id
5607 description: Identifier used by the vendor for the region. Second part of composite key
5610 example: __CLOUD-REGION-ID__
5613 description: Image id, expected to be unique across cloud region
5616 example: __IMAGE-ID__
5621 example: __METANAME__
5622 - name: resource-version
5624 description: resource-version for concurrency
5627 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata:
5630 - CloudInfrastructure
5631 summary: returns metadata
5632 description: returns metadata
5633 operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata
5639 description: successful operation
5641 $ref: "#/getDefinitions/metadata"
5643 description: Response codes found in [response codes](https://wiki.onap.org/).
5647 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5650 example: __CLOUD-OWNER__
5651 - name: cloud-region-id
5653 description: Identifier used by the vendor for the region. Second part of composite key
5656 example: __CLOUD-REGION-ID__
5659 description: Image id, expected to be unique across cloud region
5662 example: __IMAGE-ID__
5668 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}:
5671 - CloudInfrastructure
5672 summary: returns image
5673 description: returns image
5674 operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImage
5680 description: successful operation
5682 $ref: "#/getDefinitions/image"
5684 description: Response codes found in [response codes](https://wiki.onap.org/).
5688 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5691 example: __CLOUD-OWNER__
5692 - name: cloud-region-id
5694 description: Identifier used by the vendor for the region. Second part of composite key
5697 example: __CLOUD-REGION-ID__
5700 description: Image id, expected to be unique across cloud region
5703 example: __IMAGE-ID__
5706 - CloudInfrastructure
5707 summary: create or update an existing image
5709 Create or update an existing image.
5711 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
5712 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
5721 description: Response codes found in [response codes](https://wiki.onap.org/).
5725 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5728 example: __CLOUD-OWNER__
5729 - name: cloud-region-id
5731 description: Identifier used by the vendor for the region. Second part of composite key
5734 example: __CLOUD-REGION-ID__
5737 description: Image id, expected to be unique across cloud region
5740 example: __IMAGE-ID__
5743 description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
5746 $ref: "#/definitions/image"
5749 - CloudInfrastructure
5750 summary: update an existing image
5752 Update an existing image
5754 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5755 The PUT operation will entirely replace an existing object.
5756 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
5758 Other differences between PUT and PATCH are:
5760 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
5761 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5762 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5763 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
5772 description: Response codes found in [response codes](https://wiki.onap.org/).
5776 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5779 example: __CLOUD-OWNER__
5780 - name: cloud-region-id
5782 description: Identifier used by the vendor for the region. Second part of composite key
5785 example: __CLOUD-REGION-ID__
5788 description: Image id, expected to be unique across cloud region
5791 example: __IMAGE-ID__
5794 description: image object that needs to be updated.
5797 $ref: "#/patchDefinitions/image"
5800 - CloudInfrastructure
5801 summary: delete an existing image
5802 description: delete an existing image
5803 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage
5812 description: Response codes found in [response codes](https://wiki.onap.org/).
5816 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5819 example: __CLOUD-OWNER__
5820 - name: cloud-region-id
5822 description: Identifier used by the vendor for the region. Second part of composite key
5825 example: __CLOUD-REGION-ID__
5828 description: Image id, expected to be unique across cloud region
5831 example: __IMAGE-ID__
5832 - name: resource-version
5834 description: resource-version for concurrency
5837 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images:
5840 - CloudInfrastructure
5841 summary: returns images
5842 description: returns images
5843 operationId: getCloudInfrastructureCloudRegionsCloudRegionImages
5849 description: successful operation
5851 $ref: "#/getDefinitions/images"
5853 description: Response codes found in [response codes](https://wiki.onap.org/).
5857 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5860 example: __CLOUD-OWNER__
5861 - name: cloud-region-id
5863 description: Identifier used by the vendor for the region. Second part of composite key
5866 example: __CLOUD-REGION-ID__
5882 - name: application-vendor
5887 - name: application-version
5892 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship:
5895 - CloudInfrastructure
5896 summary: see node definition for valid relationships
5897 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
5906 description: Response codes found in [response codes](https://wiki.onap.org/).
5910 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5913 example: __CLOUD-OWNER__
5914 - name: cloud-region-id
5916 description: Identifier used by the vendor for the region. Second part of composite key
5919 example: __CLOUD-REGION-ID__
5922 description: DVS switch name
5925 example: __SWITCH-NAME__
5928 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
5931 $ref: "#/definitions/relationship"
5934 - CloudInfrastructure
5935 summary: delete an existing relationship
5936 description: delete an existing relationship
5937 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
5946 description: Response codes found in [response codes](https://wiki.onap.org/).
5950 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5953 example: __CLOUD-OWNER__
5954 - name: cloud-region-id
5956 description: Identifier used by the vendor for the region. Second part of composite key
5959 example: __CLOUD-REGION-ID__
5962 description: DVS switch name
5965 example: __SWITCH-NAME__
5966 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}:
5969 - CloudInfrastructure
5970 summary: returns dvs-switch
5971 description: returns dvs-switch
5972 operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
5978 description: successful operation
5980 $ref: "#/getDefinitions/dvs-switch"
5982 description: Response codes found in [response codes](https://wiki.onap.org/).
5986 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5989 example: __CLOUD-OWNER__
5990 - name: cloud-region-id
5992 description: Identifier used by the vendor for the region. Second part of composite key
5995 example: __CLOUD-REGION-ID__
5998 description: DVS switch name
6001 example: __SWITCH-NAME__
6004 - CloudInfrastructure
6005 summary: create or update an existing dvs-switch
6007 Create or update an existing dvs-switch.
6009 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6010 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6019 description: Response codes found in [response codes](https://wiki.onap.org/).
6023 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6026 example: __CLOUD-OWNER__
6027 - name: cloud-region-id
6029 description: Identifier used by the vendor for the region. Second part of composite key
6032 example: __CLOUD-REGION-ID__
6035 description: DVS switch name
6038 example: __SWITCH-NAME__
6041 description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
6044 $ref: "#/definitions/dvs-switch"
6047 - CloudInfrastructure
6048 summary: update an existing dvs-switch
6050 Update an existing dvs-switch
6052 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6053 The PUT operation will entirely replace an existing object.
6054 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6056 Other differences between PUT and PATCH are:
6058 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6059 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6060 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6061 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6070 description: Response codes found in [response codes](https://wiki.onap.org/).
6074 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6077 example: __CLOUD-OWNER__
6078 - name: cloud-region-id
6080 description: Identifier used by the vendor for the region. Second part of composite key
6083 example: __CLOUD-REGION-ID__
6086 description: DVS switch name
6089 example: __SWITCH-NAME__
6092 description: dvs-switch object that needs to be updated.
6095 $ref: "#/patchDefinitions/dvs-switch"
6098 - CloudInfrastructure
6099 summary: delete an existing dvs-switch
6100 description: delete an existing dvs-switch
6101 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6110 description: Response codes found in [response codes](https://wiki.onap.org/).
6114 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6117 example: __CLOUD-OWNER__
6118 - name: cloud-region-id
6120 description: Identifier used by the vendor for the region. Second part of composite key
6123 example: __CLOUD-REGION-ID__
6126 description: DVS switch name
6129 example: __SWITCH-NAME__
6130 - name: resource-version
6132 description: resource-version for concurrency
6135 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches:
6138 - CloudInfrastructure
6139 summary: returns dvs-switches
6140 description: returns dvs-switches
6141 operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches
6147 description: successful operation
6149 $ref: "#/getDefinitions/dvs-switches"
6151 description: Response codes found in [response codes](https://wiki.onap.org/).
6155 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6158 example: __CLOUD-OWNER__
6159 - name: cloud-region-id
6161 description: Identifier used by the vendor for the region. Second part of composite key
6164 example: __CLOUD-REGION-ID__
6175 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship:
6178 - CloudInfrastructure
6179 summary: see node definition for valid relationships
6180 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
6189 description: Response codes found in [response codes](https://wiki.onap.org/).
6193 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6196 example: __CLOUD-OWNER__
6197 - name: cloud-region-id
6199 description: Identifier used by the vendor for the region. Second part of composite key
6202 example: __CLOUD-REGION-ID__
6203 - name: network-uuid
6205 description: UUID of the network. Unique across a cloud-region
6208 example: __NETWORK-UUID__
6211 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
6214 $ref: "#/definitions/relationship"
6217 - CloudInfrastructure
6218 summary: delete an existing relationship
6219 description: delete an existing relationship
6220 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
6229 description: Response codes found in [response codes](https://wiki.onap.org/).
6233 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6236 example: __CLOUD-OWNER__
6237 - name: cloud-region-id
6239 description: Identifier used by the vendor for the region. Second part of composite key
6242 example: __CLOUD-REGION-ID__
6243 - name: network-uuid
6245 description: UUID of the network. Unique across a cloud-region
6248 example: __NETWORK-UUID__
6249 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}:
6252 - CloudInfrastructure
6253 summary: returns oam-network
6254 description: returns oam-network
6255 operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6261 description: successful operation
6263 $ref: "#/getDefinitions/oam-network"
6265 description: Response codes found in [response codes](https://wiki.onap.org/).
6269 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6272 example: __CLOUD-OWNER__
6273 - name: cloud-region-id
6275 description: Identifier used by the vendor for the region. Second part of composite key
6278 example: __CLOUD-REGION-ID__
6279 - name: network-uuid
6281 description: UUID of the network. Unique across a cloud-region
6284 example: __NETWORK-UUID__
6287 - CloudInfrastructure
6288 summary: create or update an existing oam-network
6290 Create or update an existing oam-network.
6292 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6293 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6302 description: Response codes found in [response codes](https://wiki.onap.org/).
6306 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6309 example: __CLOUD-OWNER__
6310 - name: cloud-region-id
6312 description: Identifier used by the vendor for the region. Second part of composite key
6315 example: __CLOUD-REGION-ID__
6316 - name: network-uuid
6318 description: UUID of the network. Unique across a cloud-region
6321 example: __NETWORK-UUID__
6324 description: oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
6327 $ref: "#/definitions/oam-network"
6330 - CloudInfrastructure
6331 summary: update an existing oam-network
6333 Update an existing oam-network
6335 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6336 The PUT operation will entirely replace an existing object.
6337 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6339 Other differences between PUT and PATCH are:
6341 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6342 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6343 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6344 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6353 description: Response codes found in [response codes](https://wiki.onap.org/).
6357 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6360 example: __CLOUD-OWNER__
6361 - name: cloud-region-id
6363 description: Identifier used by the vendor for the region. Second part of composite key
6366 example: __CLOUD-REGION-ID__
6367 - name: network-uuid
6369 description: UUID of the network. Unique across a cloud-region
6372 example: __NETWORK-UUID__
6375 description: oam-network object that needs to be updated.
6378 $ref: "#/patchDefinitions/oam-network"
6381 - CloudInfrastructure
6382 summary: delete an existing oam-network
6383 description: delete an existing oam-network
6384 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6393 description: Response codes found in [response codes](https://wiki.onap.org/).
6397 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6400 example: __CLOUD-OWNER__
6401 - name: cloud-region-id
6403 description: Identifier used by the vendor for the region. Second part of composite key
6406 example: __CLOUD-REGION-ID__
6407 - name: network-uuid
6409 description: UUID of the network. Unique across a cloud-region
6412 example: __NETWORK-UUID__
6413 - name: resource-version
6415 description: resource-version for concurrency
6418 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks:
6421 - CloudInfrastructure
6422 summary: returns oam-networks
6423 description: returns oam-networks
6424 operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworks
6430 description: successful operation
6432 $ref: "#/getDefinitions/oam-networks"
6434 description: Response codes found in [response codes](https://wiki.onap.org/).
6438 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6441 example: __CLOUD-OWNER__
6442 - name: cloud-region-id
6444 description: Identifier used by the vendor for the region. Second part of composite key
6447 example: __CLOUD-REGION-ID__
6448 - name: network-uuid
6453 - name: network-name
6464 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship:
6467 - CloudInfrastructure
6468 summary: see node definition for valid relationships
6469 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
6478 description: Response codes found in [response codes](https://wiki.onap.org/).
6482 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6485 example: __CLOUD-OWNER__
6486 - name: cloud-region-id
6488 description: Identifier used by the vendor for the region. Second part of composite key
6491 example: __CLOUD-REGION-ID__
6492 - name: availability-zone-name
6494 description: Name of the availability zone. Unique across a cloud region
6497 example: __AVAILABILITY-ZONE-NAME__
6500 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
6503 $ref: "#/definitions/relationship"
6506 - CloudInfrastructure
6507 summary: delete an existing relationship
6508 description: delete an existing relationship
6509 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
6518 description: Response codes found in [response codes](https://wiki.onap.org/).
6522 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6525 example: __CLOUD-OWNER__
6526 - name: cloud-region-id
6528 description: Identifier used by the vendor for the region. Second part of composite key
6531 example: __CLOUD-REGION-ID__
6532 - name: availability-zone-name
6534 description: Name of the availability zone. Unique across a cloud region
6537 example: __AVAILABILITY-ZONE-NAME__
6538 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}:
6541 - CloudInfrastructure
6542 summary: returns availability-zone
6543 description: returns availability-zone
6544 operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
6550 description: successful operation
6552 $ref: "#/getDefinitions/availability-zone"
6554 description: Response codes found in [response codes](https://wiki.onap.org/).
6558 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6561 example: __CLOUD-OWNER__
6562 - name: cloud-region-id
6564 description: Identifier used by the vendor for the region. Second part of composite key
6567 example: __CLOUD-REGION-ID__
6568 - name: availability-zone-name
6570 description: Name of the availability zone. Unique across a cloud region
6573 example: __AVAILABILITY-ZONE-NAME__
6576 - CloudInfrastructure
6577 summary: create or update an existing availability-zone
6579 Create or update an existing availability-zone.
6581 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6582 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
6591 description: Response codes found in [response codes](https://wiki.onap.org/).
6595 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6598 example: __CLOUD-OWNER__
6599 - name: cloud-region-id
6601 description: Identifier used by the vendor for the region. Second part of composite key
6604 example: __CLOUD-REGION-ID__
6605 - name: availability-zone-name
6607 description: Name of the availability zone. Unique across a cloud region
6610 example: __AVAILABILITY-ZONE-NAME__
6613 description: availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
6616 $ref: "#/definitions/availability-zone"
6619 - CloudInfrastructure
6620 summary: update an existing availability-zone
6622 Update an existing availability-zone
6624 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6625 The PUT operation will entirely replace an existing object.
6626 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6628 Other differences between PUT and PATCH are:
6630 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6631 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6632 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6633 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
6642 description: Response codes found in [response codes](https://wiki.onap.org/).
6646 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6649 example: __CLOUD-OWNER__
6650 - name: cloud-region-id
6652 description: Identifier used by the vendor for the region. Second part of composite key
6655 example: __CLOUD-REGION-ID__
6656 - name: availability-zone-name
6658 description: Name of the availability zone. Unique across a cloud region
6661 example: __AVAILABILITY-ZONE-NAME__
6664 description: availability-zone object that needs to be updated.
6667 $ref: "#/patchDefinitions/availability-zone"
6670 - CloudInfrastructure
6671 summary: delete an existing availability-zone
6672 description: delete an existing availability-zone
6673 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
6682 description: Response codes found in [response codes](https://wiki.onap.org/).
6686 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6689 example: __CLOUD-OWNER__
6690 - name: cloud-region-id
6692 description: Identifier used by the vendor for the region. Second part of composite key
6695 example: __CLOUD-REGION-ID__
6696 - name: availability-zone-name
6698 description: Name of the availability zone. Unique across a cloud region
6701 example: __AVAILABILITY-ZONE-NAME__
6702 - name: resource-version
6704 description: resource-version for concurrency
6707 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones:
6710 - CloudInfrastructure
6711 summary: returns availability-zones
6712 description: returns availability-zones
6713 operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZones
6719 description: successful operation
6721 $ref: "#/getDefinitions/availability-zones"
6723 description: Response codes found in [response codes](https://wiki.onap.org/).
6727 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6730 example: __CLOUD-OWNER__
6731 - name: cloud-region-id
6733 description: Identifier used by the vendor for the region. Second part of composite key
6736 example: __CLOUD-REGION-ID__
6737 - name: availability-zone-name
6742 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship:
6745 - CloudInfrastructure
6746 summary: see node definition for valid relationships
6747 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
6756 description: Response codes found in [response codes](https://wiki.onap.org/).
6760 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6763 example: __CLOUD-OWNER__
6764 - name: cloud-region-id
6766 description: Identifier used by the vendor for the region. Second part of composite key
6769 example: __CLOUD-REGION-ID__
6772 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegion.json)
6775 $ref: "#/definitions/relationship"
6778 - CloudInfrastructure
6779 summary: delete an existing relationship
6780 description: delete an existing relationship
6781 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
6790 description: Response codes found in [response codes](https://wiki.onap.org/).
6794 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6797 example: __CLOUD-OWNER__
6798 - name: cloud-region-id
6800 description: Identifier used by the vendor for the region. Second part of composite key
6803 example: __CLOUD-REGION-ID__
6804 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}:
6807 - CloudInfrastructure
6808 summary: returns cloud-region
6809 description: returns cloud-region
6810 operationId: getCloudInfrastructureCloudRegionsCloudRegion
6816 description: successful operation
6818 $ref: "#/getDefinitions/cloud-region"
6820 description: Response codes found in [response codes](https://wiki.onap.org/).
6824 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6827 example: __CLOUD-OWNER__
6828 - name: cloud-region-id
6830 description: Identifier used by the vendor for the region. Second part of composite key
6833 example: __CLOUD-REGION-ID__
6836 - CloudInfrastructure
6837 summary: create or update an existing cloud-region
6839 Create or update an existing cloud-region.
6841 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6842 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegion
6851 description: Response codes found in [response codes](https://wiki.onap.org/).
6855 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6858 example: __CLOUD-OWNER__
6859 - name: cloud-region-id
6861 description: Identifier used by the vendor for the region. Second part of composite key
6864 example: __CLOUD-REGION-ID__
6867 description: cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureCloudRegionsCloudRegion.json)
6870 $ref: "#/definitions/cloud-region"
6873 - CloudInfrastructure
6874 summary: update an existing cloud-region
6876 Update an existing cloud-region
6878 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6879 The PUT operation will entirely replace an existing object.
6880 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6882 Other differences between PUT and PATCH are:
6884 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6885 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6886 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6887 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegion
6896 description: Response codes found in [response codes](https://wiki.onap.org/).
6900 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6903 example: __CLOUD-OWNER__
6904 - name: cloud-region-id
6906 description: Identifier used by the vendor for the region. Second part of composite key
6909 example: __CLOUD-REGION-ID__
6912 description: cloud-region object that needs to be updated.
6915 $ref: "#/patchDefinitions/cloud-region"
6918 - CloudInfrastructure
6919 summary: delete an existing cloud-region
6920 description: delete an existing cloud-region
6921 operationId: deleteCloudInfrastructureCloudRegionsCloudRegion
6930 description: Response codes found in [response codes](https://wiki.onap.org/).
6934 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6937 example: __CLOUD-OWNER__
6938 - name: cloud-region-id
6940 description: Identifier used by the vendor for the region. Second part of composite key
6943 example: __CLOUD-REGION-ID__
6944 - name: resource-version
6946 description: resource-version for concurrency
6949 /cloud-infrastructure/cloud-regions:
6952 - CloudInfrastructure
6953 summary: returns cloud-regions
6954 description: returns cloud-regions
6955 operationId: getCloudInfrastructureCloudRegions
6961 description: successful operation
6963 $ref: "#/getDefinitions/cloud-regions"
6965 description: Response codes found in [response codes](https://wiki.onap.org/).
6972 - name: cloud-region-id
6982 - name: owner-defined-type
6987 /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship:
6990 - CloudInfrastructure
6991 summary: see node definition for valid relationships
6992 operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
7001 description: Response codes found in [response codes](https://wiki.onap.org/).
7003 - name: nm-profile-name
7005 description: Unique name of network profile.
7008 example: __NM-PROFILE-NAME__
7011 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureNetworkProfilesNetworkProfile.json)
7014 $ref: "#/definitions/relationship"
7017 - CloudInfrastructure
7018 summary: delete an existing relationship
7019 description: delete an existing relationship
7020 operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
7029 description: Response codes found in [response codes](https://wiki.onap.org/).
7031 - name: nm-profile-name
7033 description: Unique name of network profile.
7036 example: __NM-PROFILE-NAME__
7037 /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}:
7040 - CloudInfrastructure
7041 summary: returns network-profile
7042 description: returns network-profile
7043 operationId: getCloudInfrastructureNetworkProfilesNetworkProfile
7049 description: successful operation
7051 $ref: "#/getDefinitions/network-profile"
7053 description: Response codes found in [response codes](https://wiki.onap.org/).
7055 - name: nm-profile-name
7057 description: Unique name of network profile.
7060 example: __NM-PROFILE-NAME__
7063 - CloudInfrastructure
7064 summary: create or update an existing network-profile
7066 Create or update an existing network-profile.
7068 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
7069 operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile
7078 description: Response codes found in [response codes](https://wiki.onap.org/).
7080 - name: nm-profile-name
7082 description: Unique name of network profile.
7085 example: __NM-PROFILE-NAME__
7088 description: network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureNetworkProfilesNetworkProfile.json)
7091 $ref: "#/definitions/network-profile"
7094 - CloudInfrastructure
7095 summary: update an existing network-profile
7097 Update an existing network-profile
7099 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7100 The PUT operation will entirely replace an existing object.
7101 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
7103 Other differences between PUT and PATCH are:
7105 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
7106 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7107 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7108 operationId: UpdateCloudInfrastructureNetworkProfilesNetworkProfile
7117 description: Response codes found in [response codes](https://wiki.onap.org/).
7119 - name: nm-profile-name
7121 description: Unique name of network profile.
7124 example: __NM-PROFILE-NAME__
7127 description: network-profile object that needs to be updated.
7130 $ref: "#/patchDefinitions/network-profile"
7133 - CloudInfrastructure
7134 summary: delete an existing network-profile
7135 description: delete an existing network-profile
7136 operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfile
7145 description: Response codes found in [response codes](https://wiki.onap.org/).
7147 - name: nm-profile-name
7149 description: Unique name of network profile.
7152 example: __NM-PROFILE-NAME__
7153 - name: resource-version
7155 description: resource-version for concurrency
7158 /cloud-infrastructure/network-profiles:
7161 - CloudInfrastructure
7162 summary: returns network-profiles
7163 description: returns network-profiles
7164 operationId: getCloudInfrastructureNetworkProfiles
7170 description: successful operation
7172 $ref: "#/getDefinitions/network-profiles"
7174 description: Response codes found in [response codes](https://wiki.onap.org/).
7176 - name: nm-profile-name
7181 /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship:
7184 - CloudInfrastructure
7185 summary: see node definition for valid relationships
7186 operationId: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship
7195 description: Response codes found in [response codes](https://wiki.onap.org/).
7199 description: Value from executing hostname on the compute node.
7202 example: __HOSTNAME__
7205 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserver.json)
7208 $ref: "#/definitions/relationship"
7211 - CloudInfrastructure
7212 summary: delete an existing relationship
7213 description: delete an existing relationship
7214 operationId: deleteCloudInfrastructurePserversPserverRelationshipListRelationship
7223 description: Response codes found in [response codes](https://wiki.onap.org/).
7227 description: Value from executing hostname on the compute node.
7230 example: __HOSTNAME__
7231 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
7234 - CloudInfrastructure
7235 summary: see node definition for valid relationships
7236 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
7245 description: Response codes found in [response codes](https://wiki.onap.org/).
7249 description: Value from executing hostname on the compute node.
7252 example: __HOSTNAME__
7253 - name: interface-name
7255 description: Name that identifies the physical interface
7258 example: __INTERFACE-NAME__
7261 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
7264 $ref: "#/definitions/relationship"
7267 - CloudInfrastructure
7268 summary: delete an existing relationship
7269 description: delete an existing relationship
7270 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
7279 description: Response codes found in [response codes](https://wiki.onap.org/).
7283 description: Value from executing hostname on the compute node.
7286 example: __HOSTNAME__
7287 - name: interface-name
7289 description: Name that identifies the physical interface
7292 example: __INTERFACE-NAME__
7293 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
7296 - CloudInfrastructure
7297 summary: see node definition for valid relationships
7298 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
7307 description: Response codes found in [response codes](https://wiki.onap.org/).
7311 description: Value from executing hostname on the compute node.
7314 example: __HOSTNAME__
7315 - name: interface-name
7317 description: Name that identifies the physical interface
7320 example: __INTERFACE-NAME__
7321 - name: interface-name
7323 description: Name given to the interface
7326 example: __INTERFACE-NAME__
7327 - name: vlan-interface
7329 description: String that identifies the interface
7332 example: __VLAN-INTERFACE__
7335 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
7338 $ref: "#/definitions/relationship"
7341 - CloudInfrastructure
7342 summary: delete an existing relationship
7343 description: delete an existing relationship
7344 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
7353 description: Response codes found in [response codes](https://wiki.onap.org/).
7357 description: Value from executing hostname on the compute node.
7360 example: __HOSTNAME__
7361 - name: interface-name
7363 description: Name that identifies the physical interface
7366 example: __INTERFACE-NAME__
7367 - name: interface-name
7369 description: Name given to the interface
7372 example: __INTERFACE-NAME__
7373 - name: vlan-interface
7375 description: String that identifies the interface
7378 example: __VLAN-INTERFACE__
7379 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
7382 - CloudInfrastructure
7383 summary: see node definition for valid relationships
7384 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
7393 description: Response codes found in [response codes](https://wiki.onap.org/).
7397 description: Value from executing hostname on the compute node.
7400 example: __HOSTNAME__
7401 - name: interface-name
7403 description: Name that identifies the physical interface
7406 example: __INTERFACE-NAME__
7407 - name: interface-name
7409 description: Name given to the interface
7412 example: __INTERFACE-NAME__
7413 - name: vlan-interface
7415 description: String that identifies the interface
7418 example: __VLAN-INTERFACE__
7419 - name: l3-interface-ipv4-address
7421 description: IP address
7424 example: __L3-INTERFACE-IPV4-ADDRESS__
7427 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
7430 $ref: "#/definitions/relationship"
7433 - CloudInfrastructure
7434 summary: delete an existing relationship
7435 description: delete an existing relationship
7436 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
7445 description: Response codes found in [response codes](https://wiki.onap.org/).
7449 description: Value from executing hostname on the compute node.
7452 example: __HOSTNAME__
7453 - name: interface-name
7455 description: Name that identifies the physical interface
7458 example: __INTERFACE-NAME__
7459 - name: interface-name
7461 description: Name given to the interface
7464 example: __INTERFACE-NAME__
7465 - name: vlan-interface
7467 description: String that identifies the interface
7470 example: __VLAN-INTERFACE__
7471 - name: l3-interface-ipv4-address
7473 description: IP address
7476 example: __L3-INTERFACE-IPV4-ADDRESS__
7477 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
7480 - CloudInfrastructure
7481 summary: returns l3-interface-ipv4-address-list
7482 description: returns l3-interface-ipv4-address-list
7483 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
7489 description: successful operation
7491 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
7493 description: Response codes found in [response codes](https://wiki.onap.org/).
7497 description: Value from executing hostname on the compute node.
7500 example: __HOSTNAME__
7501 - name: interface-name
7503 description: Name that identifies the physical interface
7506 example: __INTERFACE-NAME__
7507 - name: interface-name
7509 description: Name given to the interface
7512 example: __INTERFACE-NAME__
7513 - name: vlan-interface
7515 description: String that identifies the interface
7518 example: __VLAN-INTERFACE__
7519 - name: l3-interface-ipv4-address
7521 description: IP address
7524 example: __L3-INTERFACE-IPV4-ADDRESS__
7527 - CloudInfrastructure
7528 summary: create or update an existing l3-interface-ipv4-address-list
7530 Create or update an existing l3-interface-ipv4-address-list.
7532 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
7533 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
7542 description: Response codes found in [response codes](https://wiki.onap.org/).
7546 description: Value from executing hostname on the compute node.
7549 example: __HOSTNAME__
7550 - name: interface-name
7552 description: Name that identifies the physical interface
7555 example: __INTERFACE-NAME__
7556 - name: interface-name
7558 description: Name given to the interface
7561 example: __INTERFACE-NAME__
7562 - name: vlan-interface
7564 description: String that identifies the interface
7567 example: __VLAN-INTERFACE__
7568 - name: l3-interface-ipv4-address
7570 description: IP address
7573 example: __L3-INTERFACE-IPV4-ADDRESS__
7576 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
7579 $ref: "#/definitions/l3-interface-ipv4-address-list"
7582 - CloudInfrastructure
7583 summary: update an existing l3-interface-ipv4-address-list
7585 Update an existing l3-interface-ipv4-address-list
7587 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7588 The PUT operation will entirely replace an existing object.
7589 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
7591 Other differences between PUT and PATCH are:
7593 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
7594 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7595 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7596 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
7605 description: Response codes found in [response codes](https://wiki.onap.org/).
7609 description: Value from executing hostname on the compute node.
7612 example: __HOSTNAME__
7613 - name: interface-name
7615 description: Name that identifies the physical interface
7618 example: __INTERFACE-NAME__
7619 - name: interface-name
7621 description: Name given to the interface
7624 example: __INTERFACE-NAME__
7625 - name: vlan-interface
7627 description: String that identifies the interface
7630 example: __VLAN-INTERFACE__
7631 - name: l3-interface-ipv4-address
7633 description: IP address
7636 example: __L3-INTERFACE-IPV4-ADDRESS__
7639 description: l3-interface-ipv4-address-list object that needs to be updated.
7642 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
7645 - CloudInfrastructure
7646 summary: delete an existing l3-interface-ipv4-address-list
7647 description: delete an existing l3-interface-ipv4-address-list
7648 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
7657 description: Response codes found in [response codes](https://wiki.onap.org/).
7661 description: Value from executing hostname on the compute node.
7664 example: __HOSTNAME__
7665 - name: interface-name
7667 description: Name that identifies the physical interface
7670 example: __INTERFACE-NAME__
7671 - name: interface-name
7673 description: Name given to the interface
7676 example: __INTERFACE-NAME__
7677 - name: vlan-interface
7679 description: String that identifies the interface
7682 example: __VLAN-INTERFACE__
7683 - name: l3-interface-ipv4-address
7685 description: IP address
7688 example: __L3-INTERFACE-IPV4-ADDRESS__
7689 - name: resource-version
7691 description: resource-version for concurrency
7694 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
7697 - CloudInfrastructure
7698 summary: see node definition for valid relationships
7699 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
7708 description: Response codes found in [response codes](https://wiki.onap.org/).
7712 description: Value from executing hostname on the compute node.
7715 example: __HOSTNAME__
7716 - name: interface-name
7718 description: Name that identifies the physical interface
7721 example: __INTERFACE-NAME__
7722 - name: interface-name
7724 description: Name given to the interface
7727 example: __INTERFACE-NAME__
7728 - name: vlan-interface
7730 description: String that identifies the interface
7733 example: __VLAN-INTERFACE__
7734 - name: l3-interface-ipv6-address
7736 description: IP address
7739 example: __L3-INTERFACE-IPV6-ADDRESS__
7742 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
7745 $ref: "#/definitions/relationship"
7748 - CloudInfrastructure
7749 summary: delete an existing relationship
7750 description: delete an existing relationship
7751 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
7760 description: Response codes found in [response codes](https://wiki.onap.org/).
7764 description: Value from executing hostname on the compute node.
7767 example: __HOSTNAME__
7768 - name: interface-name
7770 description: Name that identifies the physical interface
7773 example: __INTERFACE-NAME__
7774 - name: interface-name
7776 description: Name given to the interface
7779 example: __INTERFACE-NAME__
7780 - name: vlan-interface
7782 description: String that identifies the interface
7785 example: __VLAN-INTERFACE__
7786 - name: l3-interface-ipv6-address
7788 description: IP address
7791 example: __L3-INTERFACE-IPV6-ADDRESS__
7792 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
7795 - CloudInfrastructure
7796 summary: returns l3-interface-ipv6-address-list
7797 description: returns l3-interface-ipv6-address-list
7798 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
7804 description: successful operation
7806 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
7808 description: Response codes found in [response codes](https://wiki.onap.org/).
7812 description: Value from executing hostname on the compute node.
7815 example: __HOSTNAME__
7816 - name: interface-name
7818 description: Name that identifies the physical interface
7821 example: __INTERFACE-NAME__
7822 - name: interface-name
7824 description: Name given to the interface
7827 example: __INTERFACE-NAME__
7828 - name: vlan-interface
7830 description: String that identifies the interface
7833 example: __VLAN-INTERFACE__
7834 - name: l3-interface-ipv6-address
7836 description: IP address
7839 example: __L3-INTERFACE-IPV6-ADDRESS__
7842 - CloudInfrastructure
7843 summary: create or update an existing l3-interface-ipv6-address-list
7845 Create or update an existing l3-interface-ipv6-address-list.
7847 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
7848 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
7857 description: Response codes found in [response codes](https://wiki.onap.org/).
7861 description: Value from executing hostname on the compute node.
7864 example: __HOSTNAME__
7865 - name: interface-name
7867 description: Name that identifies the physical interface
7870 example: __INTERFACE-NAME__
7871 - name: interface-name
7873 description: Name given to the interface
7876 example: __INTERFACE-NAME__
7877 - name: vlan-interface
7879 description: String that identifies the interface
7882 example: __VLAN-INTERFACE__
7883 - name: l3-interface-ipv6-address
7885 description: IP address
7888 example: __L3-INTERFACE-IPV6-ADDRESS__
7891 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
7894 $ref: "#/definitions/l3-interface-ipv6-address-list"
7897 - CloudInfrastructure
7898 summary: update an existing l3-interface-ipv6-address-list
7900 Update an existing l3-interface-ipv6-address-list
7902 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7903 The PUT operation will entirely replace an existing object.
7904 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
7906 Other differences between PUT and PATCH are:
7908 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
7909 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7910 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7911 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
7920 description: Response codes found in [response codes](https://wiki.onap.org/).
7924 description: Value from executing hostname on the compute node.
7927 example: __HOSTNAME__
7928 - name: interface-name
7930 description: Name that identifies the physical interface
7933 example: __INTERFACE-NAME__
7934 - name: interface-name
7936 description: Name given to the interface
7939 example: __INTERFACE-NAME__
7940 - name: vlan-interface
7942 description: String that identifies the interface
7945 example: __VLAN-INTERFACE__
7946 - name: l3-interface-ipv6-address
7948 description: IP address
7951 example: __L3-INTERFACE-IPV6-ADDRESS__
7954 description: l3-interface-ipv6-address-list object that needs to be updated.
7957 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
7960 - CloudInfrastructure
7961 summary: delete an existing l3-interface-ipv6-address-list
7962 description: delete an existing l3-interface-ipv6-address-list
7963 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
7972 description: Response codes found in [response codes](https://wiki.onap.org/).
7976 description: Value from executing hostname on the compute node.
7979 example: __HOSTNAME__
7980 - name: interface-name
7982 description: Name that identifies the physical interface
7985 example: __INTERFACE-NAME__
7986 - name: interface-name
7988 description: Name given to the interface
7991 example: __INTERFACE-NAME__
7992 - name: vlan-interface
7994 description: String that identifies the interface
7997 example: __VLAN-INTERFACE__
7998 - name: l3-interface-ipv6-address
8000 description: IP address
8003 example: __L3-INTERFACE-IPV6-ADDRESS__
8004 - name: resource-version
8006 description: resource-version for concurrency
8009 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
8012 - CloudInfrastructure
8013 summary: returns vlan
8014 description: returns vlan
8015 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
8021 description: successful operation
8023 $ref: "#/getDefinitions/vlan"
8025 description: Response codes found in [response codes](https://wiki.onap.org/).
8029 description: Value from executing hostname on the compute node.
8032 example: __HOSTNAME__
8033 - name: interface-name
8035 description: Name that identifies the physical interface
8038 example: __INTERFACE-NAME__
8039 - name: interface-name
8041 description: Name given to the interface
8044 example: __INTERFACE-NAME__
8045 - name: vlan-interface
8047 description: String that identifies the interface
8050 example: __VLAN-INTERFACE__
8053 - CloudInfrastructure
8054 summary: create or update an existing vlan
8056 Create or update an existing vlan.
8058 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8059 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
8068 description: Response codes found in [response codes](https://wiki.onap.org/).
8072 description: Value from executing hostname on the compute node.
8075 example: __HOSTNAME__
8076 - name: interface-name
8078 description: Name that identifies the physical interface
8081 example: __INTERFACE-NAME__
8082 - name: interface-name
8084 description: Name given to the interface
8087 example: __INTERFACE-NAME__
8088 - name: vlan-interface
8090 description: String that identifies the interface
8093 example: __VLAN-INTERFACE__
8096 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
8099 $ref: "#/definitions/vlan"
8102 - CloudInfrastructure
8103 summary: update an existing vlan
8105 Update an existing vlan
8107 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8108 The PUT operation will entirely replace an existing object.
8109 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8111 Other differences between PUT and PATCH are:
8113 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8114 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8115 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8116 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
8125 description: Response codes found in [response codes](https://wiki.onap.org/).
8129 description: Value from executing hostname on the compute node.
8132 example: __HOSTNAME__
8133 - name: interface-name
8135 description: Name that identifies the physical interface
8138 example: __INTERFACE-NAME__
8139 - name: interface-name
8141 description: Name given to the interface
8144 example: __INTERFACE-NAME__
8145 - name: vlan-interface
8147 description: String that identifies the interface
8150 example: __VLAN-INTERFACE__
8153 description: vlan object that needs to be updated.
8156 $ref: "#/patchDefinitions/vlan"
8159 - CloudInfrastructure
8160 summary: delete an existing vlan
8161 description: delete an existing vlan
8162 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
8171 description: Response codes found in [response codes](https://wiki.onap.org/).
8175 description: Value from executing hostname on the compute node.
8178 example: __HOSTNAME__
8179 - name: interface-name
8181 description: Name that identifies the physical interface
8184 example: __INTERFACE-NAME__
8185 - name: interface-name
8187 description: Name given to the interface
8190 example: __INTERFACE-NAME__
8191 - name: vlan-interface
8193 description: String that identifies the interface
8196 example: __VLAN-INTERFACE__
8197 - name: resource-version
8199 description: resource-version for concurrency
8202 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
8205 - CloudInfrastructure
8206 summary: returns vlans
8207 description: returns vlans
8208 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans
8214 description: successful operation
8216 $ref: "#/getDefinitions/vlans"
8218 description: Response codes found in [response codes](https://wiki.onap.org/).
8222 description: Value from executing hostname on the compute node.
8225 example: __HOSTNAME__
8226 - name: interface-name
8228 description: Name that identifies the physical interface
8231 example: __INTERFACE-NAME__
8232 - name: interface-name
8234 description: Name given to the interface
8237 example: __INTERFACE-NAME__
8238 - name: vlan-interface
8243 - name: vlan-id-inner
8254 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
8257 - CloudInfrastructure
8258 summary: see node definition for valid relationships
8259 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
8268 description: Response codes found in [response codes](https://wiki.onap.org/).
8272 description: Value from executing hostname on the compute node.
8275 example: __HOSTNAME__
8276 - name: interface-name
8278 description: Name that identifies the physical interface
8281 example: __INTERFACE-NAME__
8282 - name: interface-name
8284 description: Name given to the interface
8287 example: __INTERFACE-NAME__
8290 description: PCI ID used to identify the sriov-vf
8296 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
8299 $ref: "#/definitions/relationship"
8302 - CloudInfrastructure
8303 summary: delete an existing relationship
8304 description: delete an existing relationship
8305 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
8314 description: Response codes found in [response codes](https://wiki.onap.org/).
8318 description: Value from executing hostname on the compute node.
8321 example: __HOSTNAME__
8322 - name: interface-name
8324 description: Name that identifies the physical interface
8327 example: __INTERFACE-NAME__
8328 - name: interface-name
8330 description: Name given to the interface
8333 example: __INTERFACE-NAME__
8336 description: PCI ID used to identify the sriov-vf
8340 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
8343 - CloudInfrastructure
8344 summary: returns sriov-vf
8345 description: returns sriov-vf
8346 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
8352 description: successful operation
8354 $ref: "#/getDefinitions/sriov-vf"
8356 description: Response codes found in [response codes](https://wiki.onap.org/).
8360 description: Value from executing hostname on the compute node.
8363 example: __HOSTNAME__
8364 - name: interface-name
8366 description: Name that identifies the physical interface
8369 example: __INTERFACE-NAME__
8370 - name: interface-name
8372 description: Name given to the interface
8375 example: __INTERFACE-NAME__
8378 description: PCI ID used to identify the sriov-vf
8384 - CloudInfrastructure
8385 summary: create or update an existing sriov-vf
8387 Create or update an existing sriov-vf.
8389 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8390 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
8399 description: Response codes found in [response codes](https://wiki.onap.org/).
8403 description: Value from executing hostname on the compute node.
8406 example: __HOSTNAME__
8407 - name: interface-name
8409 description: Name that identifies the physical interface
8412 example: __INTERFACE-NAME__
8413 - name: interface-name
8415 description: Name given to the interface
8418 example: __INTERFACE-NAME__
8421 description: PCI ID used to identify the sriov-vf
8427 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
8430 $ref: "#/definitions/sriov-vf"
8433 - CloudInfrastructure
8434 summary: update an existing sriov-vf
8436 Update an existing sriov-vf
8438 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8439 The PUT operation will entirely replace an existing object.
8440 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8442 Other differences between PUT and PATCH are:
8444 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8445 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8446 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8447 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
8456 description: Response codes found in [response codes](https://wiki.onap.org/).
8460 description: Value from executing hostname on the compute node.
8463 example: __HOSTNAME__
8464 - name: interface-name
8466 description: Name that identifies the physical interface
8469 example: __INTERFACE-NAME__
8470 - name: interface-name
8472 description: Name given to the interface
8475 example: __INTERFACE-NAME__
8478 description: PCI ID used to identify the sriov-vf
8484 description: sriov-vf object that needs to be updated.
8487 $ref: "#/patchDefinitions/sriov-vf"
8490 - CloudInfrastructure
8491 summary: delete an existing sriov-vf
8492 description: delete an existing sriov-vf
8493 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
8502 description: Response codes found in [response codes](https://wiki.onap.org/).
8506 description: Value from executing hostname on the compute node.
8509 example: __HOSTNAME__
8510 - name: interface-name
8512 description: Name that identifies the physical interface
8515 example: __INTERFACE-NAME__
8516 - name: interface-name
8518 description: Name given to the interface
8521 example: __INTERFACE-NAME__
8524 description: PCI ID used to identify the sriov-vf
8528 - name: resource-version
8530 description: resource-version for concurrency
8533 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
8536 - CloudInfrastructure
8537 summary: returns sriov-vfs
8538 description: returns sriov-vfs
8539 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
8545 description: successful operation
8547 $ref: "#/getDefinitions/sriov-vfs"
8549 description: Response codes found in [response codes](https://wiki.onap.org/).
8553 description: Value from executing hostname on the compute node.
8556 example: __HOSTNAME__
8557 - name: interface-name
8559 description: Name that identifies the physical interface
8562 example: __INTERFACE-NAME__
8563 - name: interface-name
8565 description: Name given to the interface
8568 example: __INTERFACE-NAME__
8574 - name: vf-vlan-filter
8579 - name: vf-mac-filter
8584 - name: vf-vlan-strip
8589 - name: neutron-network-id
8594 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
8597 - CloudInfrastructure
8598 summary: see node definition for valid relationships
8599 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
8608 description: Response codes found in [response codes](https://wiki.onap.org/).
8612 description: Value from executing hostname on the compute node.
8615 example: __HOSTNAME__
8616 - name: interface-name
8618 description: Name that identifies the physical interface
8621 example: __INTERFACE-NAME__
8622 - name: interface-name
8624 description: Name given to the interface
8627 example: __INTERFACE-NAME__
8630 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
8633 $ref: "#/definitions/relationship"
8636 - CloudInfrastructure
8637 summary: delete an existing relationship
8638 description: delete an existing relationship
8639 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
8648 description: Response codes found in [response codes](https://wiki.onap.org/).
8652 description: Value from executing hostname on the compute node.
8655 example: __HOSTNAME__
8656 - name: interface-name
8658 description: Name that identifies the physical interface
8661 example: __INTERFACE-NAME__
8662 - name: interface-name
8664 description: Name given to the interface
8667 example: __INTERFACE-NAME__
8668 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
8671 - CloudInfrastructure
8672 summary: see node definition for valid relationships
8673 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
8682 description: Response codes found in [response codes](https://wiki.onap.org/).
8686 description: Value from executing hostname on the compute node.
8689 example: __HOSTNAME__
8690 - name: interface-name
8692 description: Name that identifies the physical interface
8695 example: __INTERFACE-NAME__
8696 - name: interface-name
8698 description: Name given to the interface
8701 example: __INTERFACE-NAME__
8702 - name: l3-interface-ipv4-address
8704 description: IP address
8707 example: __L3-INTERFACE-IPV4-ADDRESS__
8710 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
8713 $ref: "#/definitions/relationship"
8716 - CloudInfrastructure
8717 summary: delete an existing relationship
8718 description: delete an existing relationship
8719 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
8728 description: Response codes found in [response codes](https://wiki.onap.org/).
8732 description: Value from executing hostname on the compute node.
8735 example: __HOSTNAME__
8736 - name: interface-name
8738 description: Name that identifies the physical interface
8741 example: __INTERFACE-NAME__
8742 - name: interface-name
8744 description: Name given to the interface
8747 example: __INTERFACE-NAME__
8748 - name: l3-interface-ipv4-address
8750 description: IP address
8753 example: __L3-INTERFACE-IPV4-ADDRESS__
8754 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
8757 - CloudInfrastructure
8758 summary: returns l3-interface-ipv4-address-list
8759 description: returns l3-interface-ipv4-address-list
8760 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
8766 description: successful operation
8768 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
8770 description: Response codes found in [response codes](https://wiki.onap.org/).
8774 description: Value from executing hostname on the compute node.
8777 example: __HOSTNAME__
8778 - name: interface-name
8780 description: Name that identifies the physical interface
8783 example: __INTERFACE-NAME__
8784 - name: interface-name
8786 description: Name given to the interface
8789 example: __INTERFACE-NAME__
8790 - name: l3-interface-ipv4-address
8792 description: IP address
8795 example: __L3-INTERFACE-IPV4-ADDRESS__
8798 - CloudInfrastructure
8799 summary: create or update an existing l3-interface-ipv4-address-list
8801 Create or update an existing l3-interface-ipv4-address-list.
8803 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8804 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
8813 description: Response codes found in [response codes](https://wiki.onap.org/).
8817 description: Value from executing hostname on the compute node.
8820 example: __HOSTNAME__
8821 - name: interface-name
8823 description: Name that identifies the physical interface
8826 example: __INTERFACE-NAME__
8827 - name: interface-name
8829 description: Name given to the interface
8832 example: __INTERFACE-NAME__
8833 - name: l3-interface-ipv4-address
8835 description: IP address
8838 example: __L3-INTERFACE-IPV4-ADDRESS__
8841 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
8844 $ref: "#/definitions/l3-interface-ipv4-address-list"
8847 - CloudInfrastructure
8848 summary: update an existing l3-interface-ipv4-address-list
8850 Update an existing l3-interface-ipv4-address-list
8852 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8853 The PUT operation will entirely replace an existing object.
8854 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8856 Other differences between PUT and PATCH are:
8858 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8859 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8860 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8861 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
8870 description: Response codes found in [response codes](https://wiki.onap.org/).
8874 description: Value from executing hostname on the compute node.
8877 example: __HOSTNAME__
8878 - name: interface-name
8880 description: Name that identifies the physical interface
8883 example: __INTERFACE-NAME__
8884 - name: interface-name
8886 description: Name given to the interface
8889 example: __INTERFACE-NAME__
8890 - name: l3-interface-ipv4-address
8892 description: IP address
8895 example: __L3-INTERFACE-IPV4-ADDRESS__
8898 description: l3-interface-ipv4-address-list object that needs to be updated.
8901 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
8904 - CloudInfrastructure
8905 summary: delete an existing l3-interface-ipv4-address-list
8906 description: delete an existing l3-interface-ipv4-address-list
8907 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
8916 description: Response codes found in [response codes](https://wiki.onap.org/).
8920 description: Value from executing hostname on the compute node.
8923 example: __HOSTNAME__
8924 - name: interface-name
8926 description: Name that identifies the physical interface
8929 example: __INTERFACE-NAME__
8930 - name: interface-name
8932 description: Name given to the interface
8935 example: __INTERFACE-NAME__
8936 - name: l3-interface-ipv4-address
8938 description: IP address
8941 example: __L3-INTERFACE-IPV4-ADDRESS__
8942 - name: resource-version
8944 description: resource-version for concurrency
8947 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
8950 - CloudInfrastructure
8951 summary: see node definition for valid relationships
8952 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
8961 description: Response codes found in [response codes](https://wiki.onap.org/).
8965 description: Value from executing hostname on the compute node.
8968 example: __HOSTNAME__
8969 - name: interface-name
8971 description: Name that identifies the physical interface
8974 example: __INTERFACE-NAME__
8975 - name: interface-name
8977 description: Name given to the interface
8980 example: __INTERFACE-NAME__
8981 - name: l3-interface-ipv6-address
8983 description: IP address
8986 example: __L3-INTERFACE-IPV6-ADDRESS__
8989 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
8992 $ref: "#/definitions/relationship"
8995 - CloudInfrastructure
8996 summary: delete an existing relationship
8997 description: delete an existing relationship
8998 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
9007 description: Response codes found in [response codes](https://wiki.onap.org/).
9011 description: Value from executing hostname on the compute node.
9014 example: __HOSTNAME__
9015 - name: interface-name
9017 description: Name that identifies the physical interface
9020 example: __INTERFACE-NAME__
9021 - name: interface-name
9023 description: Name given to the interface
9026 example: __INTERFACE-NAME__
9027 - name: l3-interface-ipv6-address
9029 description: IP address
9032 example: __L3-INTERFACE-IPV6-ADDRESS__
9033 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
9036 - CloudInfrastructure
9037 summary: returns l3-interface-ipv6-address-list
9038 description: returns l3-interface-ipv6-address-list
9039 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
9045 description: successful operation
9047 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
9049 description: Response codes found in [response codes](https://wiki.onap.org/).
9053 description: Value from executing hostname on the compute node.
9056 example: __HOSTNAME__
9057 - name: interface-name
9059 description: Name that identifies the physical interface
9062 example: __INTERFACE-NAME__
9063 - name: interface-name
9065 description: Name given to the interface
9068 example: __INTERFACE-NAME__
9069 - name: l3-interface-ipv6-address
9071 description: IP address
9074 example: __L3-INTERFACE-IPV6-ADDRESS__
9077 - CloudInfrastructure
9078 summary: create or update an existing l3-interface-ipv6-address-list
9080 Create or update an existing l3-interface-ipv6-address-list.
9082 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9083 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
9092 description: Response codes found in [response codes](https://wiki.onap.org/).
9096 description: Value from executing hostname on the compute node.
9099 example: __HOSTNAME__
9100 - name: interface-name
9102 description: Name that identifies the physical interface
9105 example: __INTERFACE-NAME__
9106 - name: interface-name
9108 description: Name given to the interface
9111 example: __INTERFACE-NAME__
9112 - name: l3-interface-ipv6-address
9114 description: IP address
9117 example: __L3-INTERFACE-IPV6-ADDRESS__
9120 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
9123 $ref: "#/definitions/l3-interface-ipv6-address-list"
9126 - CloudInfrastructure
9127 summary: update an existing l3-interface-ipv6-address-list
9129 Update an existing l3-interface-ipv6-address-list
9131 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9132 The PUT operation will entirely replace an existing object.
9133 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9135 Other differences between PUT and PATCH are:
9137 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9138 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9139 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9140 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
9149 description: Response codes found in [response codes](https://wiki.onap.org/).
9153 description: Value from executing hostname on the compute node.
9156 example: __HOSTNAME__
9157 - name: interface-name
9159 description: Name that identifies the physical interface
9162 example: __INTERFACE-NAME__
9163 - name: interface-name
9165 description: Name given to the interface
9168 example: __INTERFACE-NAME__
9169 - name: l3-interface-ipv6-address
9171 description: IP address
9174 example: __L3-INTERFACE-IPV6-ADDRESS__
9177 description: l3-interface-ipv6-address-list object that needs to be updated.
9180 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
9183 - CloudInfrastructure
9184 summary: delete an existing l3-interface-ipv6-address-list
9185 description: delete an existing l3-interface-ipv6-address-list
9186 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
9195 description: Response codes found in [response codes](https://wiki.onap.org/).
9199 description: Value from executing hostname on the compute node.
9202 example: __HOSTNAME__
9203 - name: interface-name
9205 description: Name that identifies the physical interface
9208 example: __INTERFACE-NAME__
9209 - name: interface-name
9211 description: Name given to the interface
9214 example: __INTERFACE-NAME__
9215 - name: l3-interface-ipv6-address
9217 description: IP address
9220 example: __L3-INTERFACE-IPV6-ADDRESS__
9221 - name: resource-version
9223 description: resource-version for concurrency
9226 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
9229 - CloudInfrastructure
9230 summary: returns l-interface
9231 description: returns l-interface
9232 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
9238 description: successful operation
9240 $ref: "#/getDefinitions/l-interface"
9242 description: Response codes found in [response codes](https://wiki.onap.org/).
9246 description: Value from executing hostname on the compute node.
9249 example: __HOSTNAME__
9250 - name: interface-name
9252 description: Name that identifies the physical interface
9255 example: __INTERFACE-NAME__
9256 - name: interface-name
9258 description: Name given to the interface
9261 example: __INTERFACE-NAME__
9264 - CloudInfrastructure
9265 summary: create or update an existing l-interface
9267 Create or update an existing l-interface.
9269 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9270 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
9279 description: Response codes found in [response codes](https://wiki.onap.org/).
9283 description: Value from executing hostname on the compute node.
9286 example: __HOSTNAME__
9287 - name: interface-name
9289 description: Name that identifies the physical interface
9292 example: __INTERFACE-NAME__
9293 - name: interface-name
9295 description: Name given to the interface
9298 example: __INTERFACE-NAME__
9301 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
9304 $ref: "#/definitions/l-interface"
9307 - CloudInfrastructure
9308 summary: update an existing l-interface
9310 Update an existing l-interface
9312 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9313 The PUT operation will entirely replace an existing object.
9314 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9316 Other differences between PUT and PATCH are:
9318 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9319 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9320 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9321 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
9330 description: Response codes found in [response codes](https://wiki.onap.org/).
9334 description: Value from executing hostname on the compute node.
9337 example: __HOSTNAME__
9338 - name: interface-name
9340 description: Name that identifies the physical interface
9343 example: __INTERFACE-NAME__
9344 - name: interface-name
9346 description: Name given to the interface
9349 example: __INTERFACE-NAME__
9352 description: l-interface object that needs to be updated.
9355 $ref: "#/patchDefinitions/l-interface"
9358 - CloudInfrastructure
9359 summary: delete an existing l-interface
9360 description: delete an existing l-interface
9361 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
9370 description: Response codes found in [response codes](https://wiki.onap.org/).
9374 description: Value from executing hostname on the compute node.
9377 example: __HOSTNAME__
9378 - name: interface-name
9380 description: Name that identifies the physical interface
9383 example: __INTERFACE-NAME__
9384 - name: interface-name
9386 description: Name given to the interface
9389 example: __INTERFACE-NAME__
9390 - name: resource-version
9392 description: resource-version for concurrency
9395 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces:
9398 - CloudInfrastructure
9399 summary: returns l-interfaces
9400 description: returns l-interfaces
9401 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces
9407 description: successful operation
9409 $ref: "#/getDefinitions/l-interfaces"
9411 description: Response codes found in [response codes](https://wiki.onap.org/).
9415 description: Value from executing hostname on the compute node.
9418 example: __HOSTNAME__
9419 - name: interface-name
9421 description: Name that identifies the physical interface
9424 example: __INTERFACE-NAME__
9425 - name: interface-name
9430 - name: interface-id
9440 - name: network-name
9445 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}:
9448 - CloudInfrastructure
9449 summary: returns p-interface
9450 description: returns p-interface
9451 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface
9457 description: successful operation
9459 $ref: "#/getDefinitions/p-interface"
9461 description: Response codes found in [response codes](https://wiki.onap.org/).
9465 description: Value from executing hostname on the compute node.
9468 example: __HOSTNAME__
9469 - name: interface-name
9471 description: Name that identifies the physical interface
9474 example: __INTERFACE-NAME__
9477 - CloudInfrastructure
9478 summary: create or update an existing p-interface
9480 Create or update an existing p-interface.
9482 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9483 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface
9492 description: Response codes found in [response codes](https://wiki.onap.org/).
9496 description: Value from executing hostname on the compute node.
9499 example: __HOSTNAME__
9500 - name: interface-name
9502 description: Name that identifies the physical interface
9505 example: __INTERFACE-NAME__
9508 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
9511 $ref: "#/definitions/p-interface"
9514 - CloudInfrastructure
9515 summary: update an existing p-interface
9517 Update an existing p-interface
9519 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9520 The PUT operation will entirely replace an existing object.
9521 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9523 Other differences between PUT and PATCH are:
9525 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9526 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9527 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9528 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterface
9537 description: Response codes found in [response codes](https://wiki.onap.org/).
9541 description: Value from executing hostname on the compute node.
9544 example: __HOSTNAME__
9545 - name: interface-name
9547 description: Name that identifies the physical interface
9550 example: __INTERFACE-NAME__
9553 description: p-interface object that needs to be updated.
9556 $ref: "#/patchDefinitions/p-interface"
9559 - CloudInfrastructure
9560 summary: delete an existing p-interface
9561 description: delete an existing p-interface
9562 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface
9571 description: Response codes found in [response codes](https://wiki.onap.org/).
9575 description: Value from executing hostname on the compute node.
9578 example: __HOSTNAME__
9579 - name: interface-name
9581 description: Name that identifies the physical interface
9584 example: __INTERFACE-NAME__
9585 - name: resource-version
9587 description: resource-version for concurrency
9590 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces:
9593 - CloudInfrastructure
9594 summary: returns p-interfaces
9595 description: returns p-interfaces
9596 operationId: getCloudInfrastructurePserversPserverPInterfaces
9602 description: successful operation
9604 $ref: "#/getDefinitions/p-interfaces"
9606 description: Response codes found in [response codes](https://wiki.onap.org/).
9610 description: Value from executing hostname on the compute node.
9613 example: __HOSTNAME__
9614 - name: interface-name
9624 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
9627 - CloudInfrastructure
9628 summary: see node definition for valid relationships
9629 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
9638 description: Response codes found in [response codes](https://wiki.onap.org/).
9642 description: Value from executing hostname on the compute node.
9645 example: __HOSTNAME__
9646 - name: interface-name
9648 description: Name that identifies the link aggregate interface
9651 example: __INTERFACE-NAME__
9654 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
9657 $ref: "#/definitions/relationship"
9660 - CloudInfrastructure
9661 summary: delete an existing relationship
9662 description: delete an existing relationship
9663 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
9672 description: Response codes found in [response codes](https://wiki.onap.org/).
9676 description: Value from executing hostname on the compute node.
9679 example: __HOSTNAME__
9680 - name: interface-name
9682 description: Name that identifies the link aggregate interface
9685 example: __INTERFACE-NAME__
9686 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
9689 - CloudInfrastructure
9690 summary: see node definition for valid relationships
9691 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
9700 description: Response codes found in [response codes](https://wiki.onap.org/).
9704 description: Value from executing hostname on the compute node.
9707 example: __HOSTNAME__
9708 - name: interface-name
9710 description: Name that identifies the link aggregate interface
9713 example: __INTERFACE-NAME__
9714 - name: interface-name
9716 description: Name given to the interface
9719 example: __INTERFACE-NAME__
9720 - name: vlan-interface
9722 description: String that identifies the interface
9725 example: __VLAN-INTERFACE__
9728 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
9731 $ref: "#/definitions/relationship"
9734 - CloudInfrastructure
9735 summary: delete an existing relationship
9736 description: delete an existing relationship
9737 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
9746 description: Response codes found in [response codes](https://wiki.onap.org/).
9750 description: Value from executing hostname on the compute node.
9753 example: __HOSTNAME__
9754 - name: interface-name
9756 description: Name that identifies the link aggregate interface
9759 example: __INTERFACE-NAME__
9760 - name: interface-name
9762 description: Name given to the interface
9765 example: __INTERFACE-NAME__
9766 - name: vlan-interface
9768 description: String that identifies the interface
9771 example: __VLAN-INTERFACE__
9772 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
9775 - CloudInfrastructure
9776 summary: see node definition for valid relationships
9777 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
9786 description: Response codes found in [response codes](https://wiki.onap.org/).
9790 description: Value from executing hostname on the compute node.
9793 example: __HOSTNAME__
9794 - name: interface-name
9796 description: Name that identifies the link aggregate interface
9799 example: __INTERFACE-NAME__
9800 - name: interface-name
9802 description: Name given to the interface
9805 example: __INTERFACE-NAME__
9806 - name: vlan-interface
9808 description: String that identifies the interface
9811 example: __VLAN-INTERFACE__
9812 - name: l3-interface-ipv4-address
9814 description: IP address
9817 example: __L3-INTERFACE-IPV4-ADDRESS__
9820 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
9823 $ref: "#/definitions/relationship"
9826 - CloudInfrastructure
9827 summary: delete an existing relationship
9828 description: delete an existing relationship
9829 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
9838 description: Response codes found in [response codes](https://wiki.onap.org/).
9842 description: Value from executing hostname on the compute node.
9845 example: __HOSTNAME__
9846 - name: interface-name
9848 description: Name that identifies the link aggregate interface
9851 example: __INTERFACE-NAME__
9852 - name: interface-name
9854 description: Name given to the interface
9857 example: __INTERFACE-NAME__
9858 - name: vlan-interface
9860 description: String that identifies the interface
9863 example: __VLAN-INTERFACE__
9864 - name: l3-interface-ipv4-address
9866 description: IP address
9869 example: __L3-INTERFACE-IPV4-ADDRESS__
9870 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
9873 - CloudInfrastructure
9874 summary: returns l3-interface-ipv4-address-list
9875 description: returns l3-interface-ipv4-address-list
9876 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9882 description: successful operation
9884 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
9886 description: Response codes found in [response codes](https://wiki.onap.org/).
9890 description: Value from executing hostname on the compute node.
9893 example: __HOSTNAME__
9894 - name: interface-name
9896 description: Name that identifies the link aggregate interface
9899 example: __INTERFACE-NAME__
9900 - name: interface-name
9902 description: Name given to the interface
9905 example: __INTERFACE-NAME__
9906 - name: vlan-interface
9908 description: String that identifies the interface
9911 example: __VLAN-INTERFACE__
9912 - name: l3-interface-ipv4-address
9914 description: IP address
9917 example: __L3-INTERFACE-IPV4-ADDRESS__
9920 - CloudInfrastructure
9921 summary: create or update an existing l3-interface-ipv4-address-list
9923 Create or update an existing l3-interface-ipv4-address-list.
9925 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9926 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9935 description: Response codes found in [response codes](https://wiki.onap.org/).
9939 description: Value from executing hostname on the compute node.
9942 example: __HOSTNAME__
9943 - name: interface-name
9945 description: Name that identifies the link aggregate interface
9948 example: __INTERFACE-NAME__
9949 - name: interface-name
9951 description: Name given to the interface
9954 example: __INTERFACE-NAME__
9955 - name: vlan-interface
9957 description: String that identifies the interface
9960 example: __VLAN-INTERFACE__
9961 - name: l3-interface-ipv4-address
9963 description: IP address
9966 example: __L3-INTERFACE-IPV4-ADDRESS__
9969 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
9972 $ref: "#/definitions/l3-interface-ipv4-address-list"
9975 - CloudInfrastructure
9976 summary: update an existing l3-interface-ipv4-address-list
9978 Update an existing l3-interface-ipv4-address-list
9980 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9981 The PUT operation will entirely replace an existing object.
9982 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9984 Other differences between PUT and PATCH are:
9986 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9987 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9988 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9989 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9998 description: Response codes found in [response codes](https://wiki.onap.org/).
10002 description: Value from executing hostname on the compute node.
10005 example: __HOSTNAME__
10006 - name: interface-name
10008 description: Name that identifies the link aggregate interface
10011 example: __INTERFACE-NAME__
10012 - name: interface-name
10014 description: Name given to the interface
10017 example: __INTERFACE-NAME__
10018 - name: vlan-interface
10020 description: String that identifies the interface
10023 example: __VLAN-INTERFACE__
10024 - name: l3-interface-ipv4-address
10026 description: IP address
10029 example: __L3-INTERFACE-IPV4-ADDRESS__
10032 description: l3-interface-ipv4-address-list object that needs to be updated.
10035 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
10038 - CloudInfrastructure
10039 summary: delete an existing l3-interface-ipv4-address-list
10040 description: delete an existing l3-interface-ipv4-address-list
10041 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
10050 description: Response codes found in [response codes](https://wiki.onap.org/).
10054 description: Value from executing hostname on the compute node.
10057 example: __HOSTNAME__
10058 - name: interface-name
10060 description: Name that identifies the link aggregate interface
10063 example: __INTERFACE-NAME__
10064 - name: interface-name
10066 description: Name given to the interface
10069 example: __INTERFACE-NAME__
10070 - name: vlan-interface
10072 description: String that identifies the interface
10075 example: __VLAN-INTERFACE__
10076 - name: l3-interface-ipv4-address
10078 description: IP address
10081 example: __L3-INTERFACE-IPV4-ADDRESS__
10082 - name: resource-version
10084 description: resource-version for concurrency
10087 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
10090 - CloudInfrastructure
10091 summary: see node definition for valid relationships
10092 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
10101 description: Response codes found in [response codes](https://wiki.onap.org/).
10105 description: Value from executing hostname on the compute node.
10108 example: __HOSTNAME__
10109 - name: interface-name
10111 description: Name that identifies the link aggregate interface
10114 example: __INTERFACE-NAME__
10115 - name: interface-name
10117 description: Name given to the interface
10120 example: __INTERFACE-NAME__
10121 - name: vlan-interface
10123 description: String that identifies the interface
10126 example: __VLAN-INTERFACE__
10127 - name: l3-interface-ipv6-address
10129 description: IP address
10132 example: __L3-INTERFACE-IPV6-ADDRESS__
10135 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
10138 $ref: "#/definitions/relationship"
10141 - CloudInfrastructure
10142 summary: delete an existing relationship
10143 description: delete an existing relationship
10144 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
10153 description: Response codes found in [response codes](https://wiki.onap.org/).
10157 description: Value from executing hostname on the compute node.
10160 example: __HOSTNAME__
10161 - name: interface-name
10163 description: Name that identifies the link aggregate interface
10166 example: __INTERFACE-NAME__
10167 - name: interface-name
10169 description: Name given to the interface
10172 example: __INTERFACE-NAME__
10173 - name: vlan-interface
10175 description: String that identifies the interface
10178 example: __VLAN-INTERFACE__
10179 - name: l3-interface-ipv6-address
10181 description: IP address
10184 example: __L3-INTERFACE-IPV6-ADDRESS__
10185 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
10188 - CloudInfrastructure
10189 summary: returns l3-interface-ipv6-address-list
10190 description: returns l3-interface-ipv6-address-list
10191 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10197 description: successful operation
10199 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
10201 description: Response codes found in [response codes](https://wiki.onap.org/).
10205 description: Value from executing hostname on the compute node.
10208 example: __HOSTNAME__
10209 - name: interface-name
10211 description: Name that identifies the link aggregate interface
10214 example: __INTERFACE-NAME__
10215 - name: interface-name
10217 description: Name given to the interface
10220 example: __INTERFACE-NAME__
10221 - name: vlan-interface
10223 description: String that identifies the interface
10226 example: __VLAN-INTERFACE__
10227 - name: l3-interface-ipv6-address
10229 description: IP address
10232 example: __L3-INTERFACE-IPV6-ADDRESS__
10235 - CloudInfrastructure
10236 summary: create or update an existing l3-interface-ipv6-address-list
10238 Create or update an existing l3-interface-ipv6-address-list.
10240 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10241 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10250 description: Response codes found in [response codes](https://wiki.onap.org/).
10254 description: Value from executing hostname on the compute node.
10257 example: __HOSTNAME__
10258 - name: interface-name
10260 description: Name that identifies the link aggregate interface
10263 example: __INTERFACE-NAME__
10264 - name: interface-name
10266 description: Name given to the interface
10269 example: __INTERFACE-NAME__
10270 - name: vlan-interface
10272 description: String that identifies the interface
10275 example: __VLAN-INTERFACE__
10276 - name: l3-interface-ipv6-address
10278 description: IP address
10281 example: __L3-INTERFACE-IPV6-ADDRESS__
10284 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
10287 $ref: "#/definitions/l3-interface-ipv6-address-list"
10290 - CloudInfrastructure
10291 summary: update an existing l3-interface-ipv6-address-list
10293 Update an existing l3-interface-ipv6-address-list
10295 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10296 The PUT operation will entirely replace an existing object.
10297 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10299 Other differences between PUT and PATCH are:
10301 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10302 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10303 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10304 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10313 description: Response codes found in [response codes](https://wiki.onap.org/).
10317 description: Value from executing hostname on the compute node.
10320 example: __HOSTNAME__
10321 - name: interface-name
10323 description: Name that identifies the link aggregate interface
10326 example: __INTERFACE-NAME__
10327 - name: interface-name
10329 description: Name given to the interface
10332 example: __INTERFACE-NAME__
10333 - name: vlan-interface
10335 description: String that identifies the interface
10338 example: __VLAN-INTERFACE__
10339 - name: l3-interface-ipv6-address
10341 description: IP address
10344 example: __L3-INTERFACE-IPV6-ADDRESS__
10347 description: l3-interface-ipv6-address-list object that needs to be updated.
10350 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
10353 - CloudInfrastructure
10354 summary: delete an existing l3-interface-ipv6-address-list
10355 description: delete an existing l3-interface-ipv6-address-list
10356 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10365 description: Response codes found in [response codes](https://wiki.onap.org/).
10369 description: Value from executing hostname on the compute node.
10372 example: __HOSTNAME__
10373 - name: interface-name
10375 description: Name that identifies the link aggregate interface
10378 example: __INTERFACE-NAME__
10379 - name: interface-name
10381 description: Name given to the interface
10384 example: __INTERFACE-NAME__
10385 - name: vlan-interface
10387 description: String that identifies the interface
10390 example: __VLAN-INTERFACE__
10391 - name: l3-interface-ipv6-address
10393 description: IP address
10396 example: __L3-INTERFACE-IPV6-ADDRESS__
10397 - name: resource-version
10399 description: resource-version for concurrency
10402 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
10405 - CloudInfrastructure
10406 summary: returns vlan
10407 description: returns vlan
10408 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
10414 description: successful operation
10416 $ref: "#/getDefinitions/vlan"
10418 description: Response codes found in [response codes](https://wiki.onap.org/).
10422 description: Value from executing hostname on the compute node.
10425 example: __HOSTNAME__
10426 - name: interface-name
10428 description: Name that identifies the link aggregate interface
10431 example: __INTERFACE-NAME__
10432 - name: interface-name
10434 description: Name given to the interface
10437 example: __INTERFACE-NAME__
10438 - name: vlan-interface
10440 description: String that identifies the interface
10443 example: __VLAN-INTERFACE__
10446 - CloudInfrastructure
10447 summary: create or update an existing vlan
10449 Create or update an existing vlan.
10451 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10452 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
10461 description: Response codes found in [response codes](https://wiki.onap.org/).
10465 description: Value from executing hostname on the compute node.
10468 example: __HOSTNAME__
10469 - name: interface-name
10471 description: Name that identifies the link aggregate interface
10474 example: __INTERFACE-NAME__
10475 - name: interface-name
10477 description: Name given to the interface
10480 example: __INTERFACE-NAME__
10481 - name: vlan-interface
10483 description: String that identifies the interface
10486 example: __VLAN-INTERFACE__
10489 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
10492 $ref: "#/definitions/vlan"
10495 - CloudInfrastructure
10496 summary: update an existing vlan
10498 Update an existing vlan
10500 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10501 The PUT operation will entirely replace an existing object.
10502 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10504 Other differences between PUT and PATCH are:
10506 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10507 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10508 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10509 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
10518 description: Response codes found in [response codes](https://wiki.onap.org/).
10522 description: Value from executing hostname on the compute node.
10525 example: __HOSTNAME__
10526 - name: interface-name
10528 description: Name that identifies the link aggregate interface
10531 example: __INTERFACE-NAME__
10532 - name: interface-name
10534 description: Name given to the interface
10537 example: __INTERFACE-NAME__
10538 - name: vlan-interface
10540 description: String that identifies the interface
10543 example: __VLAN-INTERFACE__
10546 description: vlan object that needs to be updated.
10549 $ref: "#/patchDefinitions/vlan"
10552 - CloudInfrastructure
10553 summary: delete an existing vlan
10554 description: delete an existing vlan
10555 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
10564 description: Response codes found in [response codes](https://wiki.onap.org/).
10568 description: Value from executing hostname on the compute node.
10571 example: __HOSTNAME__
10572 - name: interface-name
10574 description: Name that identifies the link aggregate interface
10577 example: __INTERFACE-NAME__
10578 - name: interface-name
10580 description: Name given to the interface
10583 example: __INTERFACE-NAME__
10584 - name: vlan-interface
10586 description: String that identifies the interface
10589 example: __VLAN-INTERFACE__
10590 - name: resource-version
10592 description: resource-version for concurrency
10595 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
10598 - CloudInfrastructure
10599 summary: returns vlans
10600 description: returns vlans
10601 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
10607 description: successful operation
10609 $ref: "#/getDefinitions/vlans"
10611 description: Response codes found in [response codes](https://wiki.onap.org/).
10615 description: Value from executing hostname on the compute node.
10618 example: __HOSTNAME__
10619 - name: interface-name
10621 description: Name that identifies the link aggregate interface
10624 example: __INTERFACE-NAME__
10625 - name: interface-name
10627 description: Name given to the interface
10630 example: __INTERFACE-NAME__
10631 - name: vlan-interface
10636 - name: vlan-id-inner
10647 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
10650 - CloudInfrastructure
10651 summary: see node definition for valid relationships
10652 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
10661 description: Response codes found in [response codes](https://wiki.onap.org/).
10665 description: Value from executing hostname on the compute node.
10668 example: __HOSTNAME__
10669 - name: interface-name
10671 description: Name that identifies the link aggregate interface
10674 example: __INTERFACE-NAME__
10675 - name: interface-name
10677 description: Name given to the interface
10680 example: __INTERFACE-NAME__
10683 description: PCI ID used to identify the sriov-vf
10686 example: __PCI-ID__
10689 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
10692 $ref: "#/definitions/relationship"
10695 - CloudInfrastructure
10696 summary: delete an existing relationship
10697 description: delete an existing relationship
10698 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
10707 description: Response codes found in [response codes](https://wiki.onap.org/).
10711 description: Value from executing hostname on the compute node.
10714 example: __HOSTNAME__
10715 - name: interface-name
10717 description: Name that identifies the link aggregate interface
10720 example: __INTERFACE-NAME__
10721 - name: interface-name
10723 description: Name given to the interface
10726 example: __INTERFACE-NAME__
10729 description: PCI ID used to identify the sriov-vf
10732 example: __PCI-ID__
10733 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
10736 - CloudInfrastructure
10737 summary: returns sriov-vf
10738 description: returns sriov-vf
10739 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10745 description: successful operation
10747 $ref: "#/getDefinitions/sriov-vf"
10749 description: Response codes found in [response codes](https://wiki.onap.org/).
10753 description: Value from executing hostname on the compute node.
10756 example: __HOSTNAME__
10757 - name: interface-name
10759 description: Name that identifies the link aggregate interface
10762 example: __INTERFACE-NAME__
10763 - name: interface-name
10765 description: Name given to the interface
10768 example: __INTERFACE-NAME__
10771 description: PCI ID used to identify the sriov-vf
10774 example: __PCI-ID__
10777 - CloudInfrastructure
10778 summary: create or update an existing sriov-vf
10780 Create or update an existing sriov-vf.
10782 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10783 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10792 description: Response codes found in [response codes](https://wiki.onap.org/).
10796 description: Value from executing hostname on the compute node.
10799 example: __HOSTNAME__
10800 - name: interface-name
10802 description: Name that identifies the link aggregate interface
10805 example: __INTERFACE-NAME__
10806 - name: interface-name
10808 description: Name given to the interface
10811 example: __INTERFACE-NAME__
10814 description: PCI ID used to identify the sriov-vf
10817 example: __PCI-ID__
10820 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
10823 $ref: "#/definitions/sriov-vf"
10826 - CloudInfrastructure
10827 summary: update an existing sriov-vf
10829 Update an existing sriov-vf
10831 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10832 The PUT operation will entirely replace an existing object.
10833 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10835 Other differences between PUT and PATCH are:
10837 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10838 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10839 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10840 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10849 description: Response codes found in [response codes](https://wiki.onap.org/).
10853 description: Value from executing hostname on the compute node.
10856 example: __HOSTNAME__
10857 - name: interface-name
10859 description: Name that identifies the link aggregate interface
10862 example: __INTERFACE-NAME__
10863 - name: interface-name
10865 description: Name given to the interface
10868 example: __INTERFACE-NAME__
10871 description: PCI ID used to identify the sriov-vf
10874 example: __PCI-ID__
10877 description: sriov-vf object that needs to be updated.
10880 $ref: "#/patchDefinitions/sriov-vf"
10883 - CloudInfrastructure
10884 summary: delete an existing sriov-vf
10885 description: delete an existing sriov-vf
10886 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10895 description: Response codes found in [response codes](https://wiki.onap.org/).
10899 description: Value from executing hostname on the compute node.
10902 example: __HOSTNAME__
10903 - name: interface-name
10905 description: Name that identifies the link aggregate interface
10908 example: __INTERFACE-NAME__
10909 - name: interface-name
10911 description: Name given to the interface
10914 example: __INTERFACE-NAME__
10917 description: PCI ID used to identify the sriov-vf
10920 example: __PCI-ID__
10921 - name: resource-version
10923 description: resource-version for concurrency
10926 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
10929 - CloudInfrastructure
10930 summary: returns sriov-vfs
10931 description: returns sriov-vfs
10932 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
10938 description: successful operation
10940 $ref: "#/getDefinitions/sriov-vfs"
10942 description: Response codes found in [response codes](https://wiki.onap.org/).
10946 description: Value from executing hostname on the compute node.
10949 example: __HOSTNAME__
10950 - name: interface-name
10952 description: Name that identifies the link aggregate interface
10955 example: __INTERFACE-NAME__
10956 - name: interface-name
10958 description: Name given to the interface
10961 example: __INTERFACE-NAME__
10967 - name: vf-vlan-filter
10972 - name: vf-mac-filter
10977 - name: vf-vlan-strip
10982 - name: neutron-network-id
10987 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
10990 - CloudInfrastructure
10991 summary: see node definition for valid relationships
10992 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
11001 description: Response codes found in [response codes](https://wiki.onap.org/).
11005 description: Value from executing hostname on the compute node.
11008 example: __HOSTNAME__
11009 - name: interface-name
11011 description: Name that identifies the link aggregate interface
11014 example: __INTERFACE-NAME__
11015 - name: interface-name
11017 description: Name given to the interface
11020 example: __INTERFACE-NAME__
11023 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
11026 $ref: "#/definitions/relationship"
11029 - CloudInfrastructure
11030 summary: delete an existing relationship
11031 description: delete an existing relationship
11032 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
11041 description: Response codes found in [response codes](https://wiki.onap.org/).
11045 description: Value from executing hostname on the compute node.
11048 example: __HOSTNAME__
11049 - name: interface-name
11051 description: Name that identifies the link aggregate interface
11054 example: __INTERFACE-NAME__
11055 - name: interface-name
11057 description: Name given to the interface
11060 example: __INTERFACE-NAME__
11061 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
11064 - CloudInfrastructure
11065 summary: see node definition for valid relationships
11066 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
11075 description: Response codes found in [response codes](https://wiki.onap.org/).
11079 description: Value from executing hostname on the compute node.
11082 example: __HOSTNAME__
11083 - name: interface-name
11085 description: Name that identifies the link aggregate interface
11088 example: __INTERFACE-NAME__
11089 - name: interface-name
11091 description: Name given to the interface
11094 example: __INTERFACE-NAME__
11095 - name: l3-interface-ipv4-address
11097 description: IP address
11100 example: __L3-INTERFACE-IPV4-ADDRESS__
11103 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
11106 $ref: "#/definitions/relationship"
11109 - CloudInfrastructure
11110 summary: delete an existing relationship
11111 description: delete an existing relationship
11112 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
11121 description: Response codes found in [response codes](https://wiki.onap.org/).
11125 description: Value from executing hostname on the compute node.
11128 example: __HOSTNAME__
11129 - name: interface-name
11131 description: Name that identifies the link aggregate interface
11134 example: __INTERFACE-NAME__
11135 - name: interface-name
11137 description: Name given to the interface
11140 example: __INTERFACE-NAME__
11141 - name: l3-interface-ipv4-address
11143 description: IP address
11146 example: __L3-INTERFACE-IPV4-ADDRESS__
11147 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
11150 - CloudInfrastructure
11151 summary: returns l3-interface-ipv4-address-list
11152 description: returns l3-interface-ipv4-address-list
11153 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11159 description: successful operation
11161 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
11163 description: Response codes found in [response codes](https://wiki.onap.org/).
11167 description: Value from executing hostname on the compute node.
11170 example: __HOSTNAME__
11171 - name: interface-name
11173 description: Name that identifies the link aggregate interface
11176 example: __INTERFACE-NAME__
11177 - name: interface-name
11179 description: Name given to the interface
11182 example: __INTERFACE-NAME__
11183 - name: l3-interface-ipv4-address
11185 description: IP address
11188 example: __L3-INTERFACE-IPV4-ADDRESS__
11191 - CloudInfrastructure
11192 summary: create or update an existing l3-interface-ipv4-address-list
11194 Create or update an existing l3-interface-ipv4-address-list.
11196 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11197 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11206 description: Response codes found in [response codes](https://wiki.onap.org/).
11210 description: Value from executing hostname on the compute node.
11213 example: __HOSTNAME__
11214 - name: interface-name
11216 description: Name that identifies the link aggregate interface
11219 example: __INTERFACE-NAME__
11220 - name: interface-name
11222 description: Name given to the interface
11225 example: __INTERFACE-NAME__
11226 - name: l3-interface-ipv4-address
11228 description: IP address
11231 example: __L3-INTERFACE-IPV4-ADDRESS__
11234 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
11237 $ref: "#/definitions/l3-interface-ipv4-address-list"
11240 - CloudInfrastructure
11241 summary: update an existing l3-interface-ipv4-address-list
11243 Update an existing l3-interface-ipv4-address-list
11245 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11246 The PUT operation will entirely replace an existing object.
11247 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11249 Other differences between PUT and PATCH are:
11251 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11252 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11253 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11254 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11263 description: Response codes found in [response codes](https://wiki.onap.org/).
11267 description: Value from executing hostname on the compute node.
11270 example: __HOSTNAME__
11271 - name: interface-name
11273 description: Name that identifies the link aggregate interface
11276 example: __INTERFACE-NAME__
11277 - name: interface-name
11279 description: Name given to the interface
11282 example: __INTERFACE-NAME__
11283 - name: l3-interface-ipv4-address
11285 description: IP address
11288 example: __L3-INTERFACE-IPV4-ADDRESS__
11291 description: l3-interface-ipv4-address-list object that needs to be updated.
11294 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
11297 - CloudInfrastructure
11298 summary: delete an existing l3-interface-ipv4-address-list
11299 description: delete an existing l3-interface-ipv4-address-list
11300 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11309 description: Response codes found in [response codes](https://wiki.onap.org/).
11313 description: Value from executing hostname on the compute node.
11316 example: __HOSTNAME__
11317 - name: interface-name
11319 description: Name that identifies the link aggregate interface
11322 example: __INTERFACE-NAME__
11323 - name: interface-name
11325 description: Name given to the interface
11328 example: __INTERFACE-NAME__
11329 - name: l3-interface-ipv4-address
11331 description: IP address
11334 example: __L3-INTERFACE-IPV4-ADDRESS__
11335 - name: resource-version
11337 description: resource-version for concurrency
11340 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
11343 - CloudInfrastructure
11344 summary: see node definition for valid relationships
11345 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
11354 description: Response codes found in [response codes](https://wiki.onap.org/).
11358 description: Value from executing hostname on the compute node.
11361 example: __HOSTNAME__
11362 - name: interface-name
11364 description: Name that identifies the link aggregate interface
11367 example: __INTERFACE-NAME__
11368 - name: interface-name
11370 description: Name given to the interface
11373 example: __INTERFACE-NAME__
11374 - name: l3-interface-ipv6-address
11376 description: IP address
11379 example: __L3-INTERFACE-IPV6-ADDRESS__
11382 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
11385 $ref: "#/definitions/relationship"
11388 - CloudInfrastructure
11389 summary: delete an existing relationship
11390 description: delete an existing relationship
11391 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
11400 description: Response codes found in [response codes](https://wiki.onap.org/).
11404 description: Value from executing hostname on the compute node.
11407 example: __HOSTNAME__
11408 - name: interface-name
11410 description: Name that identifies the link aggregate interface
11413 example: __INTERFACE-NAME__
11414 - name: interface-name
11416 description: Name given to the interface
11419 example: __INTERFACE-NAME__
11420 - name: l3-interface-ipv6-address
11422 description: IP address
11425 example: __L3-INTERFACE-IPV6-ADDRESS__
11426 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
11429 - CloudInfrastructure
11430 summary: returns l3-interface-ipv6-address-list
11431 description: returns l3-interface-ipv6-address-list
11432 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11438 description: successful operation
11440 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
11442 description: Response codes found in [response codes](https://wiki.onap.org/).
11446 description: Value from executing hostname on the compute node.
11449 example: __HOSTNAME__
11450 - name: interface-name
11452 description: Name that identifies the link aggregate interface
11455 example: __INTERFACE-NAME__
11456 - name: interface-name
11458 description: Name given to the interface
11461 example: __INTERFACE-NAME__
11462 - name: l3-interface-ipv6-address
11464 description: IP address
11467 example: __L3-INTERFACE-IPV6-ADDRESS__
11470 - CloudInfrastructure
11471 summary: create or update an existing l3-interface-ipv6-address-list
11473 Create or update an existing l3-interface-ipv6-address-list.
11475 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11476 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11485 description: Response codes found in [response codes](https://wiki.onap.org/).
11489 description: Value from executing hostname on the compute node.
11492 example: __HOSTNAME__
11493 - name: interface-name
11495 description: Name that identifies the link aggregate interface
11498 example: __INTERFACE-NAME__
11499 - name: interface-name
11501 description: Name given to the interface
11504 example: __INTERFACE-NAME__
11505 - name: l3-interface-ipv6-address
11507 description: IP address
11510 example: __L3-INTERFACE-IPV6-ADDRESS__
11513 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
11516 $ref: "#/definitions/l3-interface-ipv6-address-list"
11519 - CloudInfrastructure
11520 summary: update an existing l3-interface-ipv6-address-list
11522 Update an existing l3-interface-ipv6-address-list
11524 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11525 The PUT operation will entirely replace an existing object.
11526 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11528 Other differences between PUT and PATCH are:
11530 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11531 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11532 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11533 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11542 description: Response codes found in [response codes](https://wiki.onap.org/).
11546 description: Value from executing hostname on the compute node.
11549 example: __HOSTNAME__
11550 - name: interface-name
11552 description: Name that identifies the link aggregate interface
11555 example: __INTERFACE-NAME__
11556 - name: interface-name
11558 description: Name given to the interface
11561 example: __INTERFACE-NAME__
11562 - name: l3-interface-ipv6-address
11564 description: IP address
11567 example: __L3-INTERFACE-IPV6-ADDRESS__
11570 description: l3-interface-ipv6-address-list object that needs to be updated.
11573 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
11576 - CloudInfrastructure
11577 summary: delete an existing l3-interface-ipv6-address-list
11578 description: delete an existing l3-interface-ipv6-address-list
11579 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11588 description: Response codes found in [response codes](https://wiki.onap.org/).
11592 description: Value from executing hostname on the compute node.
11595 example: __HOSTNAME__
11596 - name: interface-name
11598 description: Name that identifies the link aggregate interface
11601 example: __INTERFACE-NAME__
11602 - name: interface-name
11604 description: Name given to the interface
11607 example: __INTERFACE-NAME__
11608 - name: l3-interface-ipv6-address
11610 description: IP address
11613 example: __L3-INTERFACE-IPV6-ADDRESS__
11614 - name: resource-version
11616 description: resource-version for concurrency
11619 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
11622 - CloudInfrastructure
11623 summary: returns l-interface
11624 description: returns l-interface
11625 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
11631 description: successful operation
11633 $ref: "#/getDefinitions/l-interface"
11635 description: Response codes found in [response codes](https://wiki.onap.org/).
11639 description: Value from executing hostname on the compute node.
11642 example: __HOSTNAME__
11643 - name: interface-name
11645 description: Name that identifies the link aggregate interface
11648 example: __INTERFACE-NAME__
11649 - name: interface-name
11651 description: Name given to the interface
11654 example: __INTERFACE-NAME__
11657 - CloudInfrastructure
11658 summary: create or update an existing l-interface
11660 Create or update an existing l-interface.
11662 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11663 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
11672 description: Response codes found in [response codes](https://wiki.onap.org/).
11676 description: Value from executing hostname on the compute node.
11679 example: __HOSTNAME__
11680 - name: interface-name
11682 description: Name that identifies the link aggregate interface
11685 example: __INTERFACE-NAME__
11686 - name: interface-name
11688 description: Name given to the interface
11691 example: __INTERFACE-NAME__
11694 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
11697 $ref: "#/definitions/l-interface"
11700 - CloudInfrastructure
11701 summary: update an existing l-interface
11703 Update an existing l-interface
11705 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11706 The PUT operation will entirely replace an existing object.
11707 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11709 Other differences between PUT and PATCH are:
11711 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11712 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11713 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11714 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
11723 description: Response codes found in [response codes](https://wiki.onap.org/).
11727 description: Value from executing hostname on the compute node.
11730 example: __HOSTNAME__
11731 - name: interface-name
11733 description: Name that identifies the link aggregate interface
11736 example: __INTERFACE-NAME__
11737 - name: interface-name
11739 description: Name given to the interface
11742 example: __INTERFACE-NAME__
11745 description: l-interface object that needs to be updated.
11748 $ref: "#/patchDefinitions/l-interface"
11751 - CloudInfrastructure
11752 summary: delete an existing l-interface
11753 description: delete an existing l-interface
11754 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
11763 description: Response codes found in [response codes](https://wiki.onap.org/).
11767 description: Value from executing hostname on the compute node.
11770 example: __HOSTNAME__
11771 - name: interface-name
11773 description: Name that identifies the link aggregate interface
11776 example: __INTERFACE-NAME__
11777 - name: interface-name
11779 description: Name given to the interface
11782 example: __INTERFACE-NAME__
11783 - name: resource-version
11785 description: resource-version for concurrency
11788 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
11791 - CloudInfrastructure
11792 summary: returns l-interfaces
11793 description: returns l-interfaces
11794 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces
11800 description: successful operation
11802 $ref: "#/getDefinitions/l-interfaces"
11804 description: Response codes found in [response codes](https://wiki.onap.org/).
11808 description: Value from executing hostname on the compute node.
11811 example: __HOSTNAME__
11812 - name: interface-name
11814 description: Name that identifies the link aggregate interface
11817 example: __INTERFACE-NAME__
11818 - name: interface-name
11823 - name: interface-id
11833 - name: network-name
11838 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}:
11841 - CloudInfrastructure
11842 summary: returns lag-interface
11843 description: returns lag-interface
11844 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface
11850 description: successful operation
11852 $ref: "#/getDefinitions/lag-interface"
11854 description: Response codes found in [response codes](https://wiki.onap.org/).
11858 description: Value from executing hostname on the compute node.
11861 example: __HOSTNAME__
11862 - name: interface-name
11864 description: Name that identifies the link aggregate interface
11867 example: __INTERFACE-NAME__
11870 - CloudInfrastructure
11871 summary: create or update an existing lag-interface
11873 Create or update an existing lag-interface.
11875 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11876 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
11885 description: Response codes found in [response codes](https://wiki.onap.org/).
11889 description: Value from executing hostname on the compute node.
11892 example: __HOSTNAME__
11893 - name: interface-name
11895 description: Name that identifies the link aggregate interface
11898 example: __INTERFACE-NAME__
11901 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
11904 $ref: "#/definitions/lag-interface"
11907 - CloudInfrastructure
11908 summary: update an existing lag-interface
11910 Update an existing lag-interface
11912 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11913 The PUT operation will entirely replace an existing object.
11914 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11916 Other differences between PUT and PATCH are:
11918 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11919 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11920 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11921 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
11930 description: Response codes found in [response codes](https://wiki.onap.org/).
11934 description: Value from executing hostname on the compute node.
11937 example: __HOSTNAME__
11938 - name: interface-name
11940 description: Name that identifies the link aggregate interface
11943 example: __INTERFACE-NAME__
11946 description: lag-interface object that needs to be updated.
11949 $ref: "#/patchDefinitions/lag-interface"
11952 - CloudInfrastructure
11953 summary: delete an existing lag-interface
11954 description: delete an existing lag-interface
11955 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface
11964 description: Response codes found in [response codes](https://wiki.onap.org/).
11968 description: Value from executing hostname on the compute node.
11971 example: __HOSTNAME__
11972 - name: interface-name
11974 description: Name that identifies the link aggregate interface
11977 example: __INTERFACE-NAME__
11978 - name: resource-version
11980 description: resource-version for concurrency
11983 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces:
11986 - CloudInfrastructure
11987 summary: returns lag-interfaces
11988 description: returns lag-interfaces
11989 operationId: getCloudInfrastructurePserversPserverLagInterfaces
11995 description: successful operation
11997 $ref: "#/getDefinitions/lag-interfaces"
11999 description: Response codes found in [response codes](https://wiki.onap.org/).
12003 description: Value from executing hostname on the compute node.
12006 example: __HOSTNAME__
12007 - name: interface-name
12012 - name: interface-id
12017 - name: interface-role
12022 /cloud-infrastructure/pservers/pserver/{hostname}:
12025 - CloudInfrastructure
12026 summary: returns pserver
12027 description: returns pserver
12028 operationId: getCloudInfrastructurePserversPserver
12034 description: successful operation
12036 $ref: "#/getDefinitions/pserver"
12038 description: Response codes found in [response codes](https://wiki.onap.org/).
12042 description: Value from executing hostname on the compute node.
12045 example: __HOSTNAME__
12048 - CloudInfrastructure
12049 summary: create or update an existing pserver
12051 Create or update an existing pserver.
12053 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12054 operationId: createOrUpdateCloudInfrastructurePserversPserver
12063 description: Response codes found in [response codes](https://wiki.onap.org/).
12067 description: Value from executing hostname on the compute node.
12070 example: __HOSTNAME__
12073 description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserver.json)
12076 $ref: "#/definitions/pserver"
12079 - CloudInfrastructure
12080 summary: update an existing pserver
12082 Update an existing pserver
12084 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12085 The PUT operation will entirely replace an existing object.
12086 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12088 Other differences between PUT and PATCH are:
12090 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12091 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12092 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12093 operationId: UpdateCloudInfrastructurePserversPserver
12102 description: Response codes found in [response codes](https://wiki.onap.org/).
12106 description: Value from executing hostname on the compute node.
12109 example: __HOSTNAME__
12112 description: pserver object that needs to be updated.
12115 $ref: "#/patchDefinitions/pserver"
12118 - CloudInfrastructure
12119 summary: delete an existing pserver
12120 description: delete an existing pserver
12121 operationId: deleteCloudInfrastructurePserversPserver
12130 description: Response codes found in [response codes](https://wiki.onap.org/).
12134 description: Value from executing hostname on the compute node.
12137 example: __HOSTNAME__
12138 - name: resource-version
12140 description: resource-version for concurrency
12143 /cloud-infrastructure/pservers:
12146 - CloudInfrastructure
12147 summary: returns pservers
12148 description: returns pservers
12149 operationId: getCloudInfrastructurePservers
12155 description: successful operation
12157 $ref: "#/getDefinitions/pservers"
12159 description: Response codes found in [response codes](https://wiki.onap.org/).
12181 - name: pserver-name2
12186 /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship:
12189 - CloudInfrastructure
12190 summary: see node definition for valid relationships
12191 operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
12200 description: Response codes found in [response codes](https://wiki.onap.org/).
12204 description: Unique ID of the vdc
12207 example: __VDC-ID__
12210 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
12213 $ref: "#/definitions/relationship"
12216 - CloudInfrastructure
12217 summary: delete an existing relationship
12218 description: delete an existing relationship
12219 operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
12228 description: Response codes found in [response codes](https://wiki.onap.org/).
12232 description: Unique ID of the vdc
12235 example: __VDC-ID__
12236 /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}:
12239 - CloudInfrastructure
12240 summary: returns virtual-data-center
12241 description: returns virtual-data-center
12242 operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter
12248 description: successful operation
12250 $ref: "#/getDefinitions/virtual-data-center"
12252 description: Response codes found in [response codes](https://wiki.onap.org/).
12256 description: Unique ID of the vdc
12259 example: __VDC-ID__
12262 - CloudInfrastructure
12263 summary: create or update an existing virtual-data-center
12265 Create or update an existing virtual-data-center.
12267 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12268 operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
12277 description: Response codes found in [response codes](https://wiki.onap.org/).
12281 description: Unique ID of the vdc
12284 example: __VDC-ID__
12287 description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
12290 $ref: "#/definitions/virtual-data-center"
12293 - CloudInfrastructure
12294 summary: update an existing virtual-data-center
12296 Update an existing virtual-data-center
12298 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12299 The PUT operation will entirely replace an existing object.
12300 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12302 Other differences between PUT and PATCH are:
12304 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12305 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12306 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12307 operationId: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
12316 description: Response codes found in [response codes](https://wiki.onap.org/).
12320 description: Unique ID of the vdc
12323 example: __VDC-ID__
12326 description: virtual-data-center object that needs to be updated.
12329 $ref: "#/patchDefinitions/virtual-data-center"
12332 - CloudInfrastructure
12333 summary: delete an existing virtual-data-center
12334 description: delete an existing virtual-data-center
12335 operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter
12344 description: Response codes found in [response codes](https://wiki.onap.org/).
12348 description: Unique ID of the vdc
12351 example: __VDC-ID__
12352 - name: resource-version
12354 description: resource-version for concurrency
12357 /cloud-infrastructure/virtual-data-centers:
12360 - CloudInfrastructure
12361 summary: returns virtual-data-centers
12362 description: returns virtual-data-centers
12363 operationId: getCloudInfrastructureVirtualDataCenters
12369 description: successful operation
12371 $ref: "#/getDefinitions/virtual-data-centers"
12373 description: Response codes found in [response codes](https://wiki.onap.org/).
12385 /business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
12389 summary: see node definition for valid relationships
12390 operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship
12399 description: Response codes found in [response codes](https://wiki.onap.org/).
12401 - name: resource-instance-id
12403 description: Unique id of resource instance.
12406 example: __RESOURCE-INSTANCE-ID__
12409 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessConnectorsConnector.json)
12412 $ref: "#/definitions/relationship"
12416 summary: delete an existing relationship
12417 description: delete an existing relationship
12418 operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship
12427 description: Response codes found in [response codes](https://wiki.onap.org/).
12429 - name: resource-instance-id
12431 description: Unique id of resource instance.
12434 example: __RESOURCE-INSTANCE-ID__
12435 /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
12439 summary: returns metadatum
12440 description: returns metadatum
12441 operationId: getBusinessConnectorsConnectorMetadataMetadatum
12447 description: successful operation
12449 $ref: "#/getDefinitions/metadatum"
12451 description: Response codes found in [response codes](https://wiki.onap.org/).
12453 - name: resource-instance-id
12455 description: Unique id of resource instance.
12458 example: __RESOURCE-INSTANCE-ID__
12463 example: __METANAME__
12467 summary: create or update an existing metadatum
12469 Create or update an existing metadatum.
12471 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12472 operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum
12481 description: Response codes found in [response codes](https://wiki.onap.org/).
12483 - name: resource-instance-id
12485 description: Unique id of resource instance.
12488 example: __RESOURCE-INSTANCE-ID__
12493 example: __METANAME__
12496 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessConnectorsConnectorMetadataMetadatum.json)
12499 $ref: "#/definitions/metadatum"
12503 summary: update an existing metadatum
12505 Update an existing metadatum
12507 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12508 The PUT operation will entirely replace an existing object.
12509 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12511 Other differences between PUT and PATCH are:
12513 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12514 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12515 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12516 operationId: UpdateBusinessConnectorsConnectorMetadataMetadatum
12525 description: Response codes found in [response codes](https://wiki.onap.org/).
12527 - name: resource-instance-id
12529 description: Unique id of resource instance.
12532 example: __RESOURCE-INSTANCE-ID__
12537 example: __METANAME__
12540 description: metadatum object that needs to be updated.
12543 $ref: "#/patchDefinitions/metadatum"
12547 summary: delete an existing metadatum
12548 description: delete an existing metadatum
12549 operationId: deleteBusinessConnectorsConnectorMetadataMetadatum
12558 description: Response codes found in [response codes](https://wiki.onap.org/).
12560 - name: resource-instance-id
12562 description: Unique id of resource instance.
12565 example: __RESOURCE-INSTANCE-ID__
12570 example: __METANAME__
12571 - name: resource-version
12573 description: resource-version for concurrency
12576 /business/connectors/connector/{resource-instance-id}/metadata:
12580 summary: returns metadata
12581 description: returns metadata
12582 operationId: getBusinessConnectorsConnectorMetadata
12588 description: successful operation
12590 $ref: "#/getDefinitions/metadata"
12592 description: Response codes found in [response codes](https://wiki.onap.org/).
12594 - name: resource-instance-id
12596 description: Unique id of resource instance.
12599 example: __RESOURCE-INSTANCE-ID__
12605 /business/connectors/connector/{resource-instance-id}:
12609 summary: returns connector
12610 description: returns connector
12611 operationId: getBusinessConnectorsConnector
12617 description: successful operation
12619 $ref: "#/getDefinitions/connector"
12621 description: Response codes found in [response codes](https://wiki.onap.org/).
12623 - name: resource-instance-id
12625 description: Unique id of resource instance.
12628 example: __RESOURCE-INSTANCE-ID__
12632 summary: create or update an existing connector
12634 Create or update an existing connector.
12636 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12637 operationId: createOrUpdateBusinessConnectorsConnector
12646 description: Response codes found in [response codes](https://wiki.onap.org/).
12648 - name: resource-instance-id
12650 description: Unique id of resource instance.
12653 example: __RESOURCE-INSTANCE-ID__
12656 description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessConnectorsConnector.json)
12659 $ref: "#/definitions/connector"
12663 summary: update an existing connector
12665 Update an existing connector
12667 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12668 The PUT operation will entirely replace an existing object.
12669 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12671 Other differences between PUT and PATCH are:
12673 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12674 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12675 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12676 operationId: UpdateBusinessConnectorsConnector
12685 description: Response codes found in [response codes](https://wiki.onap.org/).
12687 - name: resource-instance-id
12689 description: Unique id of resource instance.
12692 example: __RESOURCE-INSTANCE-ID__
12695 description: connector object that needs to be updated.
12698 $ref: "#/patchDefinitions/connector"
12702 summary: delete an existing connector
12703 description: delete an existing connector
12704 operationId: deleteBusinessConnectorsConnector
12713 description: Response codes found in [response codes](https://wiki.onap.org/).
12715 - name: resource-instance-id
12717 description: Unique id of resource instance.
12720 example: __RESOURCE-INSTANCE-ID__
12721 - name: resource-version
12723 description: resource-version for concurrency
12726 /business/connectors:
12730 summary: returns connectors
12731 description: returns connectors
12732 operationId: getBusinessConnectors
12738 description: successful operation
12740 $ref: "#/getDefinitions/connectors"
12742 description: Response codes found in [response codes](https://wiki.onap.org/).
12744 - name: resource-instance-id
12749 - name: persona-model-id
12754 - name: persona-model-version
12759 - name: widget-model-id
12764 - name: widget-model-version
12769 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
12773 summary: see node definition for valid relationships
12774 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
12783 description: Response codes found in [response codes](https://wiki.onap.org/).
12785 - name: global-customer-id
12787 description: Global customer id used across ECOMP to uniquely identify customer.
12790 example: __GLOBAL-CUSTOMER-ID__
12791 - name: service-type
12793 description: Value defined by orchestration to identify this service across ECOMP.
12796 example: __SERVICE-TYPE__
12797 - name: service-instance-id
12799 description: Uniquely identifies this instance of a service
12802 example: __SERVICE-INSTANCE-ID__
12805 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
12808 $ref: "#/definitions/relationship"
12812 summary: delete an existing relationship
12813 description: delete an existing relationship
12814 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
12823 description: Response codes found in [response codes](https://wiki.onap.org/).
12825 - name: global-customer-id
12827 description: Global customer id used across ECOMP to uniquely identify customer.
12830 example: __GLOBAL-CUSTOMER-ID__
12831 - name: service-type
12833 description: Value defined by orchestration to identify this service across ECOMP.
12836 example: __SERVICE-TYPE__
12837 - name: service-instance-id
12839 description: Uniquely identifies this instance of a service
12842 example: __SERVICE-INSTANCE-ID__
12843 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
12847 summary: returns metadatum
12848 description: returns metadatum
12849 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
12855 description: successful operation
12857 $ref: "#/getDefinitions/metadatum"
12859 description: Response codes found in [response codes](https://wiki.onap.org/).
12861 - name: global-customer-id
12863 description: Global customer id used across ECOMP to uniquely identify customer.
12866 example: __GLOBAL-CUSTOMER-ID__
12867 - name: service-type
12869 description: Value defined by orchestration to identify this service across ECOMP.
12872 example: __SERVICE-TYPE__
12873 - name: service-instance-id
12875 description: Uniquely identifies this instance of a service
12878 example: __SERVICE-INSTANCE-ID__
12883 example: __METANAME__
12887 summary: create or update an existing metadatum
12889 Create or update an existing metadatum.
12891 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12892 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
12901 description: Response codes found in [response codes](https://wiki.onap.org/).
12903 - name: global-customer-id
12905 description: Global customer id used across ECOMP to uniquely identify customer.
12908 example: __GLOBAL-CUSTOMER-ID__
12909 - name: service-type
12911 description: Value defined by orchestration to identify this service across ECOMP.
12914 example: __SERVICE-TYPE__
12915 - name: service-instance-id
12917 description: Uniquely identifies this instance of a service
12920 example: __SERVICE-INSTANCE-ID__
12925 example: __METANAME__
12928 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)
12931 $ref: "#/definitions/metadatum"
12935 summary: update an existing metadatum
12937 Update an existing metadatum
12939 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12940 The PUT operation will entirely replace an existing object.
12941 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12943 Other differences between PUT and PATCH are:
12945 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12946 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12947 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12948 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
12957 description: Response codes found in [response codes](https://wiki.onap.org/).
12959 - name: global-customer-id
12961 description: Global customer id used across ECOMP to uniquely identify customer.
12964 example: __GLOBAL-CUSTOMER-ID__
12965 - name: service-type
12967 description: Value defined by orchestration to identify this service across ECOMP.
12970 example: __SERVICE-TYPE__
12971 - name: service-instance-id
12973 description: Uniquely identifies this instance of a service
12976 example: __SERVICE-INSTANCE-ID__
12981 example: __METANAME__
12984 description: metadatum object that needs to be updated.
12987 $ref: "#/patchDefinitions/metadatum"
12991 summary: delete an existing metadatum
12992 description: delete an existing metadatum
12993 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
13002 description: Response codes found in [response codes](https://wiki.onap.org/).
13004 - name: global-customer-id
13006 description: Global customer id used across ECOMP to uniquely identify customer.
13009 example: __GLOBAL-CUSTOMER-ID__
13010 - name: service-type
13012 description: Value defined by orchestration to identify this service across ECOMP.
13015 example: __SERVICE-TYPE__
13016 - name: service-instance-id
13018 description: Uniquely identifies this instance of a service
13021 example: __SERVICE-INSTANCE-ID__
13026 example: __METANAME__
13027 - name: resource-version
13029 description: resource-version for concurrency
13032 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
13036 summary: returns metadata
13037 description: returns metadata
13038 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
13044 description: successful operation
13046 $ref: "#/getDefinitions/metadata"
13048 description: Response codes found in [response codes](https://wiki.onap.org/).
13050 - name: global-customer-id
13052 description: Global customer id used across ECOMP to uniquely identify customer.
13055 example: __GLOBAL-CUSTOMER-ID__
13056 - name: service-type
13058 description: Value defined by orchestration to identify this service across ECOMP.
13061 example: __SERVICE-TYPE__
13062 - name: service-instance-id
13064 description: Uniquely identifies this instance of a service
13067 example: __SERVICE-INSTANCE-ID__
13073 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}/relationship-list/relationship:
13077 summary: see node definition for valid relationships
13078 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
13087 description: Response codes found in [response codes](https://wiki.onap.org/).
13089 - name: global-customer-id
13091 description: Global customer id used across ECOMP to uniquely identify customer.
13094 example: __GLOBAL-CUSTOMER-ID__
13095 - name: service-type
13097 description: Value defined by orchestration to identify this service across ECOMP.
13100 example: __SERVICE-TYPE__
13101 - name: service-instance-id
13103 description: Uniquely identifies this instance of a service
13106 example: __SERVICE-INSTANCE-ID__
13109 description: Allotted Resource id UUID assigned to this instance.
13115 description: Allotted Resource id UUID assigned to this instance.
13121 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
13124 $ref: "#/definitions/relationship"
13128 summary: delete an existing relationship
13129 description: delete an existing relationship
13130 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
13139 description: Response codes found in [response codes](https://wiki.onap.org/).
13141 - name: global-customer-id
13143 description: Global customer id used across ECOMP to uniquely identify customer.
13146 example: __GLOBAL-CUSTOMER-ID__
13147 - name: service-type
13149 description: Value defined by orchestration to identify this service across ECOMP.
13152 example: __SERVICE-TYPE__
13153 - name: service-instance-id
13155 description: Uniquely identifies this instance of a service
13158 example: __SERVICE-INSTANCE-ID__
13161 description: Allotted Resource id UUID assigned to this instance.
13167 description: Allotted Resource id UUID assigned to this instance.
13171 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}:
13175 summary: returns tunnel-xconnect
13176 description: returns tunnel-xconnect
13177 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
13183 description: successful operation
13185 $ref: "#/getDefinitions/tunnel-xconnect"
13187 description: Response codes found in [response codes](https://wiki.onap.org/).
13189 - name: global-customer-id
13191 description: Global customer id used across ECOMP to uniquely identify customer.
13194 example: __GLOBAL-CUSTOMER-ID__
13195 - name: service-type
13197 description: Value defined by orchestration to identify this service across ECOMP.
13200 example: __SERVICE-TYPE__
13201 - name: service-instance-id
13203 description: Uniquely identifies this instance of a service
13206 example: __SERVICE-INSTANCE-ID__
13209 description: Allotted Resource id UUID assigned to this instance.
13215 description: Allotted Resource id UUID assigned to this instance.
13222 summary: create or update an existing tunnel-xconnect
13224 Create or update an existing tunnel-xconnect.
13226 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13227 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
13236 description: Response codes found in [response codes](https://wiki.onap.org/).
13238 - name: global-customer-id
13240 description: Global customer id used across ECOMP to uniquely identify customer.
13243 example: __GLOBAL-CUSTOMER-ID__
13244 - name: service-type
13246 description: Value defined by orchestration to identify this service across ECOMP.
13249 example: __SERVICE-TYPE__
13250 - name: service-instance-id
13252 description: Uniquely identifies this instance of a service
13255 example: __SERVICE-INSTANCE-ID__
13258 description: Allotted Resource id UUID assigned to this instance.
13264 description: Allotted Resource id UUID assigned to this instance.
13270 description: tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
13273 $ref: "#/definitions/tunnel-xconnect"
13277 summary: update an existing tunnel-xconnect
13279 Update an existing tunnel-xconnect
13281 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13282 The PUT operation will entirely replace an existing object.
13283 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13285 Other differences between PUT and PATCH are:
13287 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13288 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13289 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13290 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
13299 description: Response codes found in [response codes](https://wiki.onap.org/).
13301 - name: global-customer-id
13303 description: Global customer id used across ECOMP to uniquely identify customer.
13306 example: __GLOBAL-CUSTOMER-ID__
13307 - name: service-type
13309 description: Value defined by orchestration to identify this service across ECOMP.
13312 example: __SERVICE-TYPE__
13313 - name: service-instance-id
13315 description: Uniquely identifies this instance of a service
13318 example: __SERVICE-INSTANCE-ID__
13321 description: Allotted Resource id UUID assigned to this instance.
13327 description: Allotted Resource id UUID assigned to this instance.
13333 description: tunnel-xconnect object that needs to be updated.
13336 $ref: "#/patchDefinitions/tunnel-xconnect"
13340 summary: delete an existing tunnel-xconnect
13341 description: delete an existing tunnel-xconnect
13342 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
13351 description: Response codes found in [response codes](https://wiki.onap.org/).
13353 - name: global-customer-id
13355 description: Global customer id used across ECOMP to uniquely identify customer.
13358 example: __GLOBAL-CUSTOMER-ID__
13359 - name: service-type
13361 description: Value defined by orchestration to identify this service across ECOMP.
13364 example: __SERVICE-TYPE__
13365 - name: service-instance-id
13367 description: Uniquely identifies this instance of a service
13370 example: __SERVICE-INSTANCE-ID__
13373 description: Allotted Resource id UUID assigned to this instance.
13379 description: Allotted Resource id UUID assigned to this instance.
13383 - name: resource-version
13385 description: resource-version for concurrency
13388 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects:
13392 summary: returns tunnel-xconnects
13393 description: returns tunnel-xconnects
13394 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects
13400 description: successful operation
13402 $ref: "#/getDefinitions/tunnel-xconnects"
13404 description: Response codes found in [response codes](https://wiki.onap.org/).
13406 - name: global-customer-id
13408 description: Global customer id used across ECOMP to uniquely identify customer.
13411 example: __GLOBAL-CUSTOMER-ID__
13412 - name: service-type
13414 description: Value defined by orchestration to identify this service across ECOMP.
13417 example: __SERVICE-TYPE__
13418 - name: service-instance-id
13420 description: Uniquely identifies this instance of a service
13423 example: __SERVICE-INSTANCE-ID__
13426 description: Allotted Resource id UUID assigned to this instance.
13435 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship:
13439 summary: see node definition for valid relationships
13440 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
13449 description: Response codes found in [response codes](https://wiki.onap.org/).
13451 - name: global-customer-id
13453 description: Global customer id used across ECOMP to uniquely identify customer.
13456 example: __GLOBAL-CUSTOMER-ID__
13457 - name: service-type
13459 description: Value defined by orchestration to identify this service across ECOMP.
13462 example: __SERVICE-TYPE__
13463 - name: service-instance-id
13465 description: Uniquely identifies this instance of a service
13468 example: __SERVICE-INSTANCE-ID__
13471 description: Allotted Resource id UUID assigned to this instance.
13477 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
13480 $ref: "#/definitions/relationship"
13484 summary: delete an existing relationship
13485 description: delete an existing relationship
13486 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
13495 description: Response codes found in [response codes](https://wiki.onap.org/).
13497 - name: global-customer-id
13499 description: Global customer id used across ECOMP to uniquely identify customer.
13502 example: __GLOBAL-CUSTOMER-ID__
13503 - name: service-type
13505 description: Value defined by orchestration to identify this service across ECOMP.
13508 example: __SERVICE-TYPE__
13509 - name: service-instance-id
13511 description: Uniquely identifies this instance of a service
13514 example: __SERVICE-INSTANCE-ID__
13517 description: Allotted Resource id UUID assigned to this instance.
13521 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}:
13525 summary: returns allotted-resource
13526 description: returns allotted-resource
13527 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
13533 description: successful operation
13535 $ref: "#/getDefinitions/allotted-resource"
13537 description: Response codes found in [response codes](https://wiki.onap.org/).
13539 - name: global-customer-id
13541 description: Global customer id used across ECOMP to uniquely identify customer.
13544 example: __GLOBAL-CUSTOMER-ID__
13545 - name: service-type
13547 description: Value defined by orchestration to identify this service across ECOMP.
13550 example: __SERVICE-TYPE__
13551 - name: service-instance-id
13553 description: Uniquely identifies this instance of a service
13556 example: __SERVICE-INSTANCE-ID__
13559 description: Allotted Resource id UUID assigned to this instance.
13566 summary: create or update an existing allotted-resource
13568 Create or update an existing allotted-resource.
13570 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13571 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
13580 description: Response codes found in [response codes](https://wiki.onap.org/).
13582 - name: global-customer-id
13584 description: Global customer id used across ECOMP to uniquely identify customer.
13587 example: __GLOBAL-CUSTOMER-ID__
13588 - name: service-type
13590 description: Value defined by orchestration to identify this service across ECOMP.
13593 example: __SERVICE-TYPE__
13594 - name: service-instance-id
13596 description: Uniquely identifies this instance of a service
13599 example: __SERVICE-INSTANCE-ID__
13602 description: Allotted Resource id UUID assigned to this instance.
13608 description: allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
13611 $ref: "#/definitions/allotted-resource"
13615 summary: update an existing allotted-resource
13617 Update an existing allotted-resource
13619 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13620 The PUT operation will entirely replace an existing object.
13621 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13623 Other differences between PUT and PATCH are:
13625 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13626 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13627 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13628 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
13637 description: Response codes found in [response codes](https://wiki.onap.org/).
13639 - name: global-customer-id
13641 description: Global customer id used across ECOMP to uniquely identify customer.
13644 example: __GLOBAL-CUSTOMER-ID__
13645 - name: service-type
13647 description: Value defined by orchestration to identify this service across ECOMP.
13650 example: __SERVICE-TYPE__
13651 - name: service-instance-id
13653 description: Uniquely identifies this instance of a service
13656 example: __SERVICE-INSTANCE-ID__
13659 description: Allotted Resource id UUID assigned to this instance.
13665 description: allotted-resource object that needs to be updated.
13668 $ref: "#/patchDefinitions/allotted-resource"
13672 summary: delete an existing allotted-resource
13673 description: delete an existing allotted-resource
13674 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
13683 description: Response codes found in [response codes](https://wiki.onap.org/).
13685 - name: global-customer-id
13687 description: Global customer id used across ECOMP to uniquely identify customer.
13690 example: __GLOBAL-CUSTOMER-ID__
13691 - name: service-type
13693 description: Value defined by orchestration to identify this service across ECOMP.
13696 example: __SERVICE-TYPE__
13697 - name: service-instance-id
13699 description: Uniquely identifies this instance of a service
13702 example: __SERVICE-INSTANCE-ID__
13705 description: Allotted Resource id UUID assigned to this instance.
13709 - name: resource-version
13711 description: resource-version for concurrency
13714 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources:
13718 summary: returns allotted-resources
13719 description: returns allotted-resources
13720 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources
13726 description: successful operation
13728 $ref: "#/getDefinitions/allotted-resources"
13730 description: Response codes found in [response codes](https://wiki.onap.org/).
13732 - name: global-customer-id
13734 description: Global customer id used across ECOMP to uniquely identify customer.
13737 example: __GLOBAL-CUSTOMER-ID__
13738 - name: service-type
13740 description: Value defined by orchestration to identify this service across ECOMP.
13743 example: __SERVICE-TYPE__
13744 - name: service-instance-id
13746 description: Uniquely identifies this instance of a service
13749 example: __SERVICE-INSTANCE-ID__
13755 - name: persona-model-id
13760 - name: persona-model-version
13765 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
13769 summary: returns service-instance
13770 description: returns service-instance
13771 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
13777 description: successful operation
13779 $ref: "#/getDefinitions/service-instance"
13781 description: Response codes found in [response codes](https://wiki.onap.org/).
13783 - name: global-customer-id
13785 description: Global customer id used across ECOMP to uniquely identify customer.
13788 example: __GLOBAL-CUSTOMER-ID__
13789 - name: service-type
13791 description: Value defined by orchestration to identify this service across ECOMP.
13794 example: __SERVICE-TYPE__
13795 - name: service-instance-id
13797 description: Uniquely identifies this instance of a service
13800 example: __SERVICE-INSTANCE-ID__
13804 summary: create or update an existing service-instance
13806 Create or update an existing service-instance.
13808 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13809 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
13818 description: Response codes found in [response codes](https://wiki.onap.org/).
13820 - name: global-customer-id
13822 description: Global customer id used across ECOMP to uniquely identify customer.
13825 example: __GLOBAL-CUSTOMER-ID__
13826 - name: service-type
13828 description: Value defined by orchestration to identify this service across ECOMP.
13831 example: __SERVICE-TYPE__
13832 - name: service-instance-id
13834 description: Uniquely identifies this instance of a service
13837 example: __SERVICE-INSTANCE-ID__
13840 description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
13843 $ref: "#/definitions/service-instance"
13847 summary: update an existing service-instance
13849 Update an existing service-instance
13851 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13852 The PUT operation will entirely replace an existing object.
13853 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13855 Other differences between PUT and PATCH are:
13857 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13858 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13859 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13860 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
13869 description: Response codes found in [response codes](https://wiki.onap.org/).
13871 - name: global-customer-id
13873 description: Global customer id used across ECOMP to uniquely identify customer.
13876 example: __GLOBAL-CUSTOMER-ID__
13877 - name: service-type
13879 description: Value defined by orchestration to identify this service across ECOMP.
13882 example: __SERVICE-TYPE__
13883 - name: service-instance-id
13885 description: Uniquely identifies this instance of a service
13888 example: __SERVICE-INSTANCE-ID__
13891 description: service-instance object that needs to be updated.
13894 $ref: "#/patchDefinitions/service-instance"
13898 summary: delete an existing service-instance
13899 description: delete an existing service-instance
13900 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
13909 description: Response codes found in [response codes](https://wiki.onap.org/).
13911 - name: global-customer-id
13913 description: Global customer id used across ECOMP to uniquely identify customer.
13916 example: __GLOBAL-CUSTOMER-ID__
13917 - name: service-type
13919 description: Value defined by orchestration to identify this service across ECOMP.
13922 example: __SERVICE-TYPE__
13923 - name: service-instance-id
13925 description: Uniquely identifies this instance of a service
13928 example: __SERVICE-INSTANCE-ID__
13929 - name: resource-version
13931 description: resource-version for concurrency
13934 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances:
13938 summary: returns service-instances
13939 description: returns service-instances
13940 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances
13946 description: successful operation
13948 $ref: "#/getDefinitions/service-instances"
13950 description: Response codes found in [response codes](https://wiki.onap.org/).
13952 - name: global-customer-id
13954 description: Global customer id used across ECOMP to uniquely identify customer.
13957 example: __GLOBAL-CUSTOMER-ID__
13958 - name: service-type
13960 description: Value defined by orchestration to identify this service across ECOMP.
13963 example: __SERVICE-TYPE__
13964 - name: service-instance-id
13969 - name: service-instance-name
13974 - name: persona-model-id
13979 - name: persona-model-version
13984 - name: widget-model-id
13989 - name: widget-model-version
13994 - name: service-instance-location-id
13999 - name: orchestration-status
14004 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship:
14008 summary: see node definition for valid relationships
14009 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
14018 description: Response codes found in [response codes](https://wiki.onap.org/).
14020 - name: global-customer-id
14022 description: Global customer id used across ECOMP to uniquely identify customer.
14025 example: __GLOBAL-CUSTOMER-ID__
14026 - name: service-type
14028 description: Value defined by orchestration to identify this service across ECOMP.
14031 example: __SERVICE-TYPE__
14034 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
14037 $ref: "#/definitions/relationship"
14041 summary: delete an existing relationship
14042 description: delete an existing relationship
14043 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
14052 description: Response codes found in [response codes](https://wiki.onap.org/).
14054 - name: global-customer-id
14056 description: Global customer id used across ECOMP to uniquely identify customer.
14059 example: __GLOBAL-CUSTOMER-ID__
14060 - name: service-type
14062 description: Value defined by orchestration to identify this service across ECOMP.
14065 example: __SERVICE-TYPE__
14066 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}:
14070 summary: returns service-subscription
14071 description: returns service-subscription
14072 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
14078 description: successful operation
14080 $ref: "#/getDefinitions/service-subscription"
14082 description: Response codes found in [response codes](https://wiki.onap.org/).
14084 - name: global-customer-id
14086 description: Global customer id used across ECOMP to uniquely identify customer.
14089 example: __GLOBAL-CUSTOMER-ID__
14090 - name: service-type
14092 description: Value defined by orchestration to identify this service across ECOMP.
14095 example: __SERVICE-TYPE__
14099 summary: create or update an existing service-subscription
14101 Create or update an existing service-subscription.
14103 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14104 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
14113 description: Response codes found in [response codes](https://wiki.onap.org/).
14115 - name: global-customer-id
14117 description: Global customer id used across ECOMP to uniquely identify customer.
14120 example: __GLOBAL-CUSTOMER-ID__
14121 - name: service-type
14123 description: Value defined by orchestration to identify this service across ECOMP.
14126 example: __SERVICE-TYPE__
14129 description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
14132 $ref: "#/definitions/service-subscription"
14136 summary: update an existing service-subscription
14138 Update an existing service-subscription
14140 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14141 The PUT operation will entirely replace an existing object.
14142 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14144 Other differences between PUT and PATCH are:
14146 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14147 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14148 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14149 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
14158 description: Response codes found in [response codes](https://wiki.onap.org/).
14160 - name: global-customer-id
14162 description: Global customer id used across ECOMP to uniquely identify customer.
14165 example: __GLOBAL-CUSTOMER-ID__
14166 - name: service-type
14168 description: Value defined by orchestration to identify this service across ECOMP.
14171 example: __SERVICE-TYPE__
14174 description: service-subscription object that needs to be updated.
14177 $ref: "#/patchDefinitions/service-subscription"
14181 summary: delete an existing service-subscription
14182 description: delete an existing service-subscription
14183 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
14192 description: Response codes found in [response codes](https://wiki.onap.org/).
14194 - name: global-customer-id
14196 description: Global customer id used across ECOMP to uniquely identify customer.
14199 example: __GLOBAL-CUSTOMER-ID__
14200 - name: service-type
14202 description: Value defined by orchestration to identify this service across ECOMP.
14205 example: __SERVICE-TYPE__
14206 - name: resource-version
14208 description: resource-version for concurrency
14211 /business/customers/customer/{global-customer-id}/service-subscriptions:
14215 summary: returns service-subscriptions
14216 description: returns service-subscriptions
14217 operationId: getBusinessCustomersCustomerServiceSubscriptions
14223 description: successful operation
14225 $ref: "#/getDefinitions/service-subscriptions"
14227 description: Response codes found in [response codes](https://wiki.onap.org/).
14229 - name: global-customer-id
14231 description: Global customer id used across ECOMP to uniquely identify customer.
14234 example: __GLOBAL-CUSTOMER-ID__
14235 - name: service-type
14240 /business/customers/customer/{global-customer-id}/relationship-list/relationship:
14244 summary: see node definition for valid relationships
14245 operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship
14254 description: Response codes found in [response codes](https://wiki.onap.org/).
14256 - name: global-customer-id
14258 description: Global customer id used across ECOMP to uniquely identify customer.
14261 example: __GLOBAL-CUSTOMER-ID__
14264 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomer.json)
14267 $ref: "#/definitions/relationship"
14271 summary: delete an existing relationship
14272 description: delete an existing relationship
14273 operationId: deleteBusinessCustomersCustomerRelationshipListRelationship
14282 description: Response codes found in [response codes](https://wiki.onap.org/).
14284 - name: global-customer-id
14286 description: Global customer id used across ECOMP to uniquely identify customer.
14289 example: __GLOBAL-CUSTOMER-ID__
14290 /business/customers/customer/{global-customer-id}:
14294 summary: returns customer
14295 description: returns customer
14296 operationId: getBusinessCustomersCustomer
14302 description: successful operation
14304 $ref: "#/getDefinitions/customer"
14306 description: Response codes found in [response codes](https://wiki.onap.org/).
14308 - name: global-customer-id
14310 description: Global customer id used across ECOMP to uniquely identify customer.
14313 example: __GLOBAL-CUSTOMER-ID__
14317 summary: create or update an existing customer
14319 Create or update an existing customer.
14321 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14322 operationId: createOrUpdateBusinessCustomersCustomer
14331 description: Response codes found in [response codes](https://wiki.onap.org/).
14333 - name: global-customer-id
14335 description: Global customer id used across ECOMP to uniquely identify customer.
14338 example: __GLOBAL-CUSTOMER-ID__
14341 description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomer.json)
14344 $ref: "#/definitions/customer"
14348 summary: update an existing customer
14350 Update an existing customer
14352 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14353 The PUT operation will entirely replace an existing object.
14354 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14356 Other differences between PUT and PATCH are:
14358 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14359 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14360 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14361 operationId: UpdateBusinessCustomersCustomer
14370 description: Response codes found in [response codes](https://wiki.onap.org/).
14372 - name: global-customer-id
14374 description: Global customer id used across ECOMP to uniquely identify customer.
14377 example: __GLOBAL-CUSTOMER-ID__
14380 description: customer object that needs to be updated.
14383 $ref: "#/patchDefinitions/customer"
14387 summary: delete an existing customer
14388 description: delete an existing customer
14389 operationId: deleteBusinessCustomersCustomer
14398 description: Response codes found in [response codes](https://wiki.onap.org/).
14400 - name: global-customer-id
14402 description: Global customer id used across ECOMP to uniquely identify customer.
14405 example: __GLOBAL-CUSTOMER-ID__
14406 - name: resource-version
14408 description: resource-version for concurrency
14411 /business/customers:
14415 summary: returns customers
14416 description: returns customers
14417 operationId: getBusinessCustomers
14423 description: successful operation
14425 $ref: "#/getDefinitions/customers"
14427 description: Response codes found in [response codes](https://wiki.onap.org/).
14429 - name: global-customer-id
14434 - name: subscriber-name
14439 - name: subscriber-type
14444 /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
14447 - ServiceDesignAndCreation
14448 summary: see node definition for valid relationships
14449 operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
14458 description: Response codes found in [response codes](https://wiki.onap.org/).
14460 - name: vnf-image-uuid
14462 description: Unique ID of this asset
14465 example: __VNF-IMAGE-UUID__
14468 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationVnfImagesVnfImage.json)
14471 $ref: "#/definitions/relationship"
14474 - ServiceDesignAndCreation
14475 summary: delete an existing relationship
14476 description: delete an existing relationship
14477 operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
14486 description: Response codes found in [response codes](https://wiki.onap.org/).
14488 - name: vnf-image-uuid
14490 description: Unique ID of this asset
14493 example: __VNF-IMAGE-UUID__
14494 /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}:
14497 - ServiceDesignAndCreation
14498 summary: returns vnf-image
14499 description: returns vnf-image
14500 operationId: getServiceDesignAndCreationVnfImagesVnfImage
14506 description: successful operation
14508 $ref: "#/getDefinitions/vnf-image"
14510 description: Response codes found in [response codes](https://wiki.onap.org/).
14512 - name: vnf-image-uuid
14514 description: Unique ID of this asset
14517 example: __VNF-IMAGE-UUID__
14520 - ServiceDesignAndCreation
14521 summary: create or update an existing vnf-image
14523 Create or update an existing vnf-image.
14525 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14526 operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage
14535 description: Response codes found in [response codes](https://wiki.onap.org/).
14537 - name: vnf-image-uuid
14539 description: Unique ID of this asset
14542 example: __VNF-IMAGE-UUID__
14545 description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationVnfImagesVnfImage.json)
14548 $ref: "#/definitions/vnf-image"
14551 - ServiceDesignAndCreation
14552 summary: update an existing vnf-image
14554 Update an existing vnf-image
14556 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14557 The PUT operation will entirely replace an existing object.
14558 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14560 Other differences between PUT and PATCH are:
14562 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14563 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14564 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14565 operationId: UpdateServiceDesignAndCreationVnfImagesVnfImage
14574 description: Response codes found in [response codes](https://wiki.onap.org/).
14576 - name: vnf-image-uuid
14578 description: Unique ID of this asset
14581 example: __VNF-IMAGE-UUID__
14584 description: vnf-image object that needs to be updated.
14587 $ref: "#/patchDefinitions/vnf-image"
14590 - ServiceDesignAndCreation
14591 summary: delete an existing vnf-image
14592 description: delete an existing vnf-image
14593 operationId: deleteServiceDesignAndCreationVnfImagesVnfImage
14602 description: Response codes found in [response codes](https://wiki.onap.org/).
14604 - name: vnf-image-uuid
14606 description: Unique ID of this asset
14609 example: __VNF-IMAGE-UUID__
14610 - name: resource-version
14612 description: resource-version for concurrency
14615 /service-design-and-creation/vnf-images:
14618 - ServiceDesignAndCreation
14619 summary: returns vnf-images
14620 description: returns vnf-images
14621 operationId: getServiceDesignAndCreationVnfImages
14627 description: successful operation
14629 $ref: "#/getDefinitions/vnf-images"
14631 description: Response codes found in [response codes](https://wiki.onap.org/).
14633 - name: vnf-image-uuid
14638 - name: application
14643 - name: application-vendor
14648 - name: application-version
14653 /service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
14656 - ServiceDesignAndCreation
14657 summary: see node definition for valid relationships
14658 operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship
14667 description: Response codes found in [response codes](https://wiki.onap.org/).
14671 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14674 example: __SERVICE-ID__
14677 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationServicesService.json)
14680 $ref: "#/definitions/relationship"
14683 - ServiceDesignAndCreation
14684 summary: delete an existing relationship
14685 description: delete an existing relationship
14686 operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship
14695 description: Response codes found in [response codes](https://wiki.onap.org/).
14699 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14702 example: __SERVICE-ID__
14703 /service-design-and-creation/services/service/{service-id}:
14706 - ServiceDesignAndCreation
14707 summary: returns service
14708 description: returns service
14709 operationId: getServiceDesignAndCreationServicesService
14715 description: successful operation
14717 $ref: "#/getDefinitions/service"
14719 description: Response codes found in [response codes](https://wiki.onap.org/).
14723 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14726 example: __SERVICE-ID__
14729 - ServiceDesignAndCreation
14730 summary: create or update an existing service
14732 Create or update an existing service.
14734 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14735 operationId: createOrUpdateServiceDesignAndCreationServicesService
14744 description: Response codes found in [response codes](https://wiki.onap.org/).
14748 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14751 example: __SERVICE-ID__
14754 description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationServicesService.json)
14757 $ref: "#/definitions/service"
14760 - ServiceDesignAndCreation
14761 summary: update an existing service
14763 Update an existing service
14765 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14766 The PUT operation will entirely replace an existing object.
14767 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14769 Other differences between PUT and PATCH are:
14771 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14772 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14773 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14774 operationId: UpdateServiceDesignAndCreationServicesService
14783 description: Response codes found in [response codes](https://wiki.onap.org/).
14787 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14790 example: __SERVICE-ID__
14793 description: service object that needs to be updated.
14796 $ref: "#/patchDefinitions/service"
14799 - ServiceDesignAndCreation
14800 summary: delete an existing service
14801 description: delete an existing service
14802 operationId: deleteServiceDesignAndCreationServicesService
14811 description: Response codes found in [response codes](https://wiki.onap.org/).
14815 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14818 example: __SERVICE-ID__
14819 - name: resource-version
14821 description: resource-version for concurrency
14824 /service-design-and-creation/services:
14827 - ServiceDesignAndCreation
14828 summary: returns services
14829 description: returns services
14830 operationId: getServiceDesignAndCreationServices
14836 description: successful operation
14838 $ref: "#/getDefinitions/services"
14840 description: Response codes found in [response codes](https://wiki.onap.org/).
14847 - name: service-description
14852 /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
14855 - ServiceDesignAndCreation
14856 summary: see node definition for valid relationships
14857 operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
14866 description: Response codes found in [response codes](https://wiki.onap.org/).
14868 - name: service-type
14870 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14873 example: __SERVICE-TYPE__
14876 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.
14879 example: __VNF-TYPE__
14882 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
14885 $ref: "#/definitions/relationship"
14888 - ServiceDesignAndCreation
14889 summary: delete an existing relationship
14890 description: delete an existing relationship
14891 operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
14900 description: Response codes found in [response codes](https://wiki.onap.org/).
14902 - name: service-type
14904 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14907 example: __SERVICE-TYPE__
14910 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.
14913 example: __VNF-TYPE__
14914 /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
14917 - ServiceDesignAndCreation
14918 summary: returns service-capability
14919 description: returns service-capability
14920 operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability
14926 description: successful operation
14928 $ref: "#/getDefinitions/service-capability"
14930 description: Response codes found in [response codes](https://wiki.onap.org/).
14932 - name: service-type
14934 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14937 example: __SERVICE-TYPE__
14940 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.
14943 example: __VNF-TYPE__
14946 - ServiceDesignAndCreation
14947 summary: create or update an existing service-capability
14949 Create or update an existing service-capability.
14951 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14952 operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
14961 description: Response codes found in [response codes](https://wiki.onap.org/).
14963 - name: service-type
14965 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
14968 example: __SERVICE-TYPE__
14971 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.
14974 example: __VNF-TYPE__
14977 description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
14980 $ref: "#/definitions/service-capability"
14983 - ServiceDesignAndCreation
14984 summary: update an existing service-capability
14986 Update an existing service-capability
14988 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14989 The PUT operation will entirely replace an existing object.
14990 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14992 Other differences between PUT and PATCH are:
14994 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14995 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14996 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14997 operationId: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
15006 description: Response codes found in [response codes](https://wiki.onap.org/).
15008 - name: service-type
15010 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15013 example: __SERVICE-TYPE__
15016 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.
15019 example: __VNF-TYPE__
15022 description: service-capability object that needs to be updated.
15025 $ref: "#/patchDefinitions/service-capability"
15028 - ServiceDesignAndCreation
15029 summary: delete an existing service-capability
15030 description: delete an existing service-capability
15031 operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
15040 description: Response codes found in [response codes](https://wiki.onap.org/).
15042 - name: service-type
15044 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15047 example: __SERVICE-TYPE__
15050 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.
15053 example: __VNF-TYPE__
15054 - name: resource-version
15056 description: resource-version for concurrency
15059 /service-design-and-creation/service-capabilities:
15062 - ServiceDesignAndCreation
15063 summary: returns service-capabilities
15064 description: returns service-capabilities
15065 operationId: getServiceDesignAndCreationServiceCapabilities
15071 description: successful operation
15073 $ref: "#/getDefinitions/service-capabilities"
15075 description: Response codes found in [response codes](https://wiki.onap.org/).
15077 - name: service-type
15087 /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:
15090 - ServiceDesignAndCreation
15091 summary: see node definition for valid relationships
15092 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
15101 description: Response codes found in [response codes](https://wiki.onap.org/).
15103 - name: model-invariant-id
15105 description: Unique identifier corresponding to the main definition of a model in ASDC
15108 example: __MODEL-INVARIANT-ID__
15109 - name: model-version-id
15111 description: Unique identifier corresponding to one version of a model in ASDC
15114 example: __MODEL-VERSION-ID__
15115 - name: model-element-uuid
15119 example: __MODEL-ELEMENT-UUID__
15120 - name: model-constraint-uuid
15124 example: __MODEL-CONSTRAINT-UUID__
15125 - name: constrained-element-set-uuid
15129 example: __CONSTRAINED-ELEMENT-SET-UUID__
15130 - name: element-choice-set-uuid
15134 example: __ELEMENT-CHOICE-SET-UUID__
15137 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
15140 $ref: "#/definitions/relationship"
15143 - ServiceDesignAndCreation
15144 summary: delete an existing relationship
15145 description: delete an existing relationship
15146 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
15155 description: Response codes found in [response codes](https://wiki.onap.org/).
15157 - name: model-invariant-id
15159 description: Unique identifier corresponding to the main definition of a model in ASDC
15162 example: __MODEL-INVARIANT-ID__
15163 - name: model-version-id
15165 description: Unique identifier corresponding to one version of a model in ASDC
15168 example: __MODEL-VERSION-ID__
15169 - name: model-element-uuid
15173 example: __MODEL-ELEMENT-UUID__
15174 - name: model-constraint-uuid
15178 example: __MODEL-CONSTRAINT-UUID__
15179 - name: constrained-element-set-uuid
15183 example: __CONSTRAINED-ELEMENT-SET-UUID__
15184 - name: element-choice-set-uuid
15188 example: __ELEMENT-CHOICE-SET-UUID__
15189 /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}:
15192 - ServiceDesignAndCreation
15193 summary: returns element-choice-set
15194 description: returns element-choice-set
15195 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
15201 description: successful operation
15203 $ref: "#/getDefinitions/element-choice-set"
15205 description: Response codes found in [response codes](https://wiki.onap.org/).
15207 - name: model-invariant-id
15209 description: Unique identifier corresponding to the main definition of a model in ASDC
15212 example: __MODEL-INVARIANT-ID__
15213 - name: model-version-id
15215 description: Unique identifier corresponding to one version of a model in ASDC
15218 example: __MODEL-VERSION-ID__
15219 - name: model-element-uuid
15223 example: __MODEL-ELEMENT-UUID__
15224 - name: model-constraint-uuid
15228 example: __MODEL-CONSTRAINT-UUID__
15229 - name: constrained-element-set-uuid
15233 example: __CONSTRAINED-ELEMENT-SET-UUID__
15234 - name: element-choice-set-uuid
15238 example: __ELEMENT-CHOICE-SET-UUID__
15241 - ServiceDesignAndCreation
15242 summary: create or update an existing element-choice-set
15244 Create or update an existing element-choice-set.
15246 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15247 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
15256 description: Response codes found in [response codes](https://wiki.onap.org/).
15258 - name: model-invariant-id
15260 description: Unique identifier corresponding to the main definition of a model in ASDC
15263 example: __MODEL-INVARIANT-ID__
15264 - name: model-version-id
15266 description: Unique identifier corresponding to one version of a model in ASDC
15269 example: __MODEL-VERSION-ID__
15270 - name: model-element-uuid
15274 example: __MODEL-ELEMENT-UUID__
15275 - name: model-constraint-uuid
15279 example: __MODEL-CONSTRAINT-UUID__
15280 - name: constrained-element-set-uuid
15284 example: __CONSTRAINED-ELEMENT-SET-UUID__
15285 - name: element-choice-set-uuid
15289 example: __ELEMENT-CHOICE-SET-UUID__
15292 description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
15295 $ref: "#/definitions/element-choice-set"
15298 - ServiceDesignAndCreation
15299 summary: update an existing element-choice-set
15301 Update an existing element-choice-set
15303 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15304 The PUT operation will entirely replace an existing object.
15305 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15307 Other differences between PUT and PATCH are:
15309 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15310 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15311 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15312 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
15321 description: Response codes found in [response codes](https://wiki.onap.org/).
15323 - name: model-invariant-id
15325 description: Unique identifier corresponding to the main definition of a model in ASDC
15328 example: __MODEL-INVARIANT-ID__
15329 - name: model-version-id
15331 description: Unique identifier corresponding to one version of a model in ASDC
15334 example: __MODEL-VERSION-ID__
15335 - name: model-element-uuid
15339 example: __MODEL-ELEMENT-UUID__
15340 - name: model-constraint-uuid
15344 example: __MODEL-CONSTRAINT-UUID__
15345 - name: constrained-element-set-uuid
15349 example: __CONSTRAINED-ELEMENT-SET-UUID__
15350 - name: element-choice-set-uuid
15354 example: __ELEMENT-CHOICE-SET-UUID__
15357 description: element-choice-set object that needs to be updated.
15360 $ref: "#/patchDefinitions/element-choice-set"
15363 - ServiceDesignAndCreation
15364 summary: delete an existing element-choice-set
15365 description: delete an existing element-choice-set
15366 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
15375 description: Response codes found in [response codes](https://wiki.onap.org/).
15377 - name: model-invariant-id
15379 description: Unique identifier corresponding to the main definition of a model in ASDC
15382 example: __MODEL-INVARIANT-ID__
15383 - name: model-version-id
15385 description: Unique identifier corresponding to one version of a model in ASDC
15388 example: __MODEL-VERSION-ID__
15389 - name: model-element-uuid
15393 example: __MODEL-ELEMENT-UUID__
15394 - name: model-constraint-uuid
15398 example: __MODEL-CONSTRAINT-UUID__
15399 - name: constrained-element-set-uuid
15403 example: __CONSTRAINED-ELEMENT-SET-UUID__
15404 - name: element-choice-set-uuid
15408 example: __ELEMENT-CHOICE-SET-UUID__
15409 - name: resource-version
15411 description: resource-version for concurrency
15414 /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:
15417 - ServiceDesignAndCreation
15418 summary: returns element-choice-sets
15419 description: returns element-choice-sets
15420 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
15426 description: successful operation
15428 $ref: "#/getDefinitions/element-choice-sets"
15430 description: Response codes found in [response codes](https://wiki.onap.org/).
15432 - name: model-invariant-id
15434 description: Unique identifier corresponding to the main definition of a model in ASDC
15437 example: __MODEL-INVARIANT-ID__
15438 - name: model-version-id
15440 description: Unique identifier corresponding to one version of a model in ASDC
15443 example: __MODEL-VERSION-ID__
15444 - name: model-element-uuid
15448 example: __MODEL-ELEMENT-UUID__
15449 - name: model-constraint-uuid
15453 example: __MODEL-CONSTRAINT-UUID__
15454 - name: constrained-element-set-uuid
15458 example: __CONSTRAINED-ELEMENT-SET-UUID__
15459 - name: element-choice-set-uuid
15464 /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:
15467 - ServiceDesignAndCreation
15468 summary: see node definition for valid relationships
15469 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
15478 description: Response codes found in [response codes](https://wiki.onap.org/).
15480 - name: model-invariant-id
15482 description: Unique identifier corresponding to the main definition of a model in ASDC
15485 example: __MODEL-INVARIANT-ID__
15486 - name: model-version-id
15488 description: Unique identifier corresponding to one version of a model in ASDC
15491 example: __MODEL-VERSION-ID__
15492 - name: model-element-uuid
15496 example: __MODEL-ELEMENT-UUID__
15497 - name: model-constraint-uuid
15501 example: __MODEL-CONSTRAINT-UUID__
15502 - name: constrained-element-set-uuid
15506 example: __CONSTRAINED-ELEMENT-SET-UUID__
15509 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
15512 $ref: "#/definitions/relationship"
15515 - ServiceDesignAndCreation
15516 summary: delete an existing relationship
15517 description: delete an existing relationship
15518 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
15527 description: Response codes found in [response codes](https://wiki.onap.org/).
15529 - name: model-invariant-id
15531 description: Unique identifier corresponding to the main definition of a model in ASDC
15534 example: __MODEL-INVARIANT-ID__
15535 - name: model-version-id
15537 description: Unique identifier corresponding to one version of a model in ASDC
15540 example: __MODEL-VERSION-ID__
15541 - name: model-element-uuid
15545 example: __MODEL-ELEMENT-UUID__
15546 - name: model-constraint-uuid
15550 example: __MODEL-CONSTRAINT-UUID__
15551 - name: constrained-element-set-uuid
15555 example: __CONSTRAINED-ELEMENT-SET-UUID__
15556 /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}:
15559 - ServiceDesignAndCreation
15560 summary: returns constrained-element-set
15561 description: returns constrained-element-set
15562 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
15568 description: successful operation
15570 $ref: "#/getDefinitions/constrained-element-set"
15572 description: Response codes found in [response codes](https://wiki.onap.org/).
15574 - name: model-invariant-id
15576 description: Unique identifier corresponding to the main definition of a model in ASDC
15579 example: __MODEL-INVARIANT-ID__
15580 - name: model-version-id
15582 description: Unique identifier corresponding to one version of a model in ASDC
15585 example: __MODEL-VERSION-ID__
15586 - name: model-element-uuid
15590 example: __MODEL-ELEMENT-UUID__
15591 - name: model-constraint-uuid
15595 example: __MODEL-CONSTRAINT-UUID__
15596 - name: constrained-element-set-uuid
15600 example: __CONSTRAINED-ELEMENT-SET-UUID__
15603 - ServiceDesignAndCreation
15604 summary: create or update an existing constrained-element-set
15606 Create or update an existing constrained-element-set.
15608 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15609 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
15618 description: Response codes found in [response codes](https://wiki.onap.org/).
15620 - name: model-invariant-id
15622 description: Unique identifier corresponding to the main definition of a model in ASDC
15625 example: __MODEL-INVARIANT-ID__
15626 - name: model-version-id
15628 description: Unique identifier corresponding to one version of a model in ASDC
15631 example: __MODEL-VERSION-ID__
15632 - name: model-element-uuid
15636 example: __MODEL-ELEMENT-UUID__
15637 - name: model-constraint-uuid
15641 example: __MODEL-CONSTRAINT-UUID__
15642 - name: constrained-element-set-uuid
15646 example: __CONSTRAINED-ELEMENT-SET-UUID__
15649 description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
15652 $ref: "#/definitions/constrained-element-set"
15655 - ServiceDesignAndCreation
15656 summary: update an existing constrained-element-set
15658 Update an existing constrained-element-set
15660 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15661 The PUT operation will entirely replace an existing object.
15662 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15664 Other differences between PUT and PATCH are:
15666 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15667 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15668 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15669 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
15678 description: Response codes found in [response codes](https://wiki.onap.org/).
15680 - name: model-invariant-id
15682 description: Unique identifier corresponding to the main definition of a model in ASDC
15685 example: __MODEL-INVARIANT-ID__
15686 - name: model-version-id
15688 description: Unique identifier corresponding to one version of a model in ASDC
15691 example: __MODEL-VERSION-ID__
15692 - name: model-element-uuid
15696 example: __MODEL-ELEMENT-UUID__
15697 - name: model-constraint-uuid
15701 example: __MODEL-CONSTRAINT-UUID__
15702 - name: constrained-element-set-uuid
15706 example: __CONSTRAINED-ELEMENT-SET-UUID__
15709 description: constrained-element-set object that needs to be updated.
15712 $ref: "#/patchDefinitions/constrained-element-set"
15715 - ServiceDesignAndCreation
15716 summary: delete an existing constrained-element-set
15717 description: delete an existing constrained-element-set
15718 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
15727 description: Response codes found in [response codes](https://wiki.onap.org/).
15729 - name: model-invariant-id
15731 description: Unique identifier corresponding to the main definition of a model in ASDC
15734 example: __MODEL-INVARIANT-ID__
15735 - name: model-version-id
15737 description: Unique identifier corresponding to one version of a model in ASDC
15740 example: __MODEL-VERSION-ID__
15741 - name: model-element-uuid
15745 example: __MODEL-ELEMENT-UUID__
15746 - name: model-constraint-uuid
15750 example: __MODEL-CONSTRAINT-UUID__
15751 - name: constrained-element-set-uuid
15755 example: __CONSTRAINED-ELEMENT-SET-UUID__
15756 - name: resource-version
15758 description: resource-version for concurrency
15761 /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:
15764 - ServiceDesignAndCreation
15765 summary: returns constrained-element-sets
15766 description: returns constrained-element-sets
15767 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
15773 description: successful operation
15775 $ref: "#/getDefinitions/constrained-element-sets"
15777 description: Response codes found in [response codes](https://wiki.onap.org/).
15779 - name: model-invariant-id
15781 description: Unique identifier corresponding to the main definition of a model in ASDC
15784 example: __MODEL-INVARIANT-ID__
15785 - name: model-version-id
15787 description: Unique identifier corresponding to one version of a model in ASDC
15790 example: __MODEL-VERSION-ID__
15791 - name: model-element-uuid
15795 example: __MODEL-ELEMENT-UUID__
15796 - name: model-constraint-uuid
15800 example: __MODEL-CONSTRAINT-UUID__
15801 - name: constrained-element-set-uuid
15806 /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}:
15809 - ServiceDesignAndCreation
15810 summary: returns model-constraint
15811 description: returns model-constraint
15812 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
15818 description: successful operation
15820 $ref: "#/getDefinitions/model-constraint"
15822 description: Response codes found in [response codes](https://wiki.onap.org/).
15824 - name: model-invariant-id
15826 description: Unique identifier corresponding to the main definition of a model in ASDC
15829 example: __MODEL-INVARIANT-ID__
15830 - name: model-version-id
15832 description: Unique identifier corresponding to one version of a model in ASDC
15835 example: __MODEL-VERSION-ID__
15836 - name: model-element-uuid
15840 example: __MODEL-ELEMENT-UUID__
15841 - name: model-constraint-uuid
15845 example: __MODEL-CONSTRAINT-UUID__
15848 - ServiceDesignAndCreation
15849 summary: create or update an existing model-constraint
15851 Create or update an existing model-constraint.
15853 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15854 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
15863 description: Response codes found in [response codes](https://wiki.onap.org/).
15865 - name: model-invariant-id
15867 description: Unique identifier corresponding to the main definition of a model in ASDC
15870 example: __MODEL-INVARIANT-ID__
15871 - name: model-version-id
15873 description: Unique identifier corresponding to one version of a model in ASDC
15876 example: __MODEL-VERSION-ID__
15877 - name: model-element-uuid
15881 example: __MODEL-ELEMENT-UUID__
15882 - name: model-constraint-uuid
15886 example: __MODEL-CONSTRAINT-UUID__
15889 description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)
15892 $ref: "#/definitions/model-constraint"
15895 - ServiceDesignAndCreation
15896 summary: update an existing model-constraint
15898 Update an existing model-constraint
15900 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15901 The PUT operation will entirely replace an existing object.
15902 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15904 Other differences between PUT and PATCH are:
15906 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15907 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15908 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15909 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
15918 description: Response codes found in [response codes](https://wiki.onap.org/).
15920 - name: model-invariant-id
15922 description: Unique identifier corresponding to the main definition of a model in ASDC
15925 example: __MODEL-INVARIANT-ID__
15926 - name: model-version-id
15928 description: Unique identifier corresponding to one version of a model in ASDC
15931 example: __MODEL-VERSION-ID__
15932 - name: model-element-uuid
15936 example: __MODEL-ELEMENT-UUID__
15937 - name: model-constraint-uuid
15941 example: __MODEL-CONSTRAINT-UUID__
15944 description: model-constraint object that needs to be updated.
15947 $ref: "#/patchDefinitions/model-constraint"
15950 - ServiceDesignAndCreation
15951 summary: delete an existing model-constraint
15952 description: delete an existing model-constraint
15953 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
15962 description: Response codes found in [response codes](https://wiki.onap.org/).
15964 - name: model-invariant-id
15966 description: Unique identifier corresponding to the main definition of a model in ASDC
15969 example: __MODEL-INVARIANT-ID__
15970 - name: model-version-id
15972 description: Unique identifier corresponding to one version of a model in ASDC
15975 example: __MODEL-VERSION-ID__
15976 - name: model-element-uuid
15980 example: __MODEL-ELEMENT-UUID__
15981 - name: model-constraint-uuid
15985 example: __MODEL-CONSTRAINT-UUID__
15986 - name: resource-version
15988 description: resource-version for concurrency
15991 /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:
15994 - ServiceDesignAndCreation
15995 summary: returns model-constraints
15996 description: returns model-constraints
15997 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints
16003 description: successful operation
16005 $ref: "#/getDefinitions/model-constraints"
16007 description: Response codes found in [response codes](https://wiki.onap.org/).
16009 - name: model-invariant-id
16011 description: Unique identifier corresponding to the main definition of a model in ASDC
16014 example: __MODEL-INVARIANT-ID__
16015 - name: model-version-id
16017 description: Unique identifier corresponding to one version of a model in ASDC
16020 example: __MODEL-VERSION-ID__
16021 - name: model-element-uuid
16025 example: __MODEL-ELEMENT-UUID__
16026 - name: model-constraint-uuid
16031 /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:
16034 - ServiceDesignAndCreation
16035 summary: see node definition for valid relationships
16036 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
16045 description: Response codes found in [response codes](https://wiki.onap.org/).
16047 - name: model-invariant-id
16049 description: Unique identifier corresponding to the main definition of a model in ASDC
16052 example: __MODEL-INVARIANT-ID__
16053 - name: model-version-id
16055 description: Unique identifier corresponding to one version of a model in ASDC
16058 example: __MODEL-VERSION-ID__
16059 - name: model-element-uuid
16063 example: __MODEL-ELEMENT-UUID__
16066 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
16069 $ref: "#/definitions/relationship"
16072 - ServiceDesignAndCreation
16073 summary: delete an existing relationship
16074 description: delete an existing relationship
16075 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
16084 description: Response codes found in [response codes](https://wiki.onap.org/).
16086 - name: model-invariant-id
16088 description: Unique identifier corresponding to the main definition of a model in ASDC
16091 example: __MODEL-INVARIANT-ID__
16092 - name: model-version-id
16094 description: Unique identifier corresponding to one version of a model in ASDC
16097 example: __MODEL-VERSION-ID__
16098 - name: model-element-uuid
16102 example: __MODEL-ELEMENT-UUID__
16103 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}:
16106 - ServiceDesignAndCreation
16107 summary: returns model-element
16108 description: returns model-element
16109 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
16115 description: successful operation
16117 $ref: "#/getDefinitions/model-element"
16119 description: Response codes found in [response codes](https://wiki.onap.org/).
16121 - name: model-invariant-id
16123 description: Unique identifier corresponding to the main definition of a model in ASDC
16126 example: __MODEL-INVARIANT-ID__
16127 - name: model-version-id
16129 description: Unique identifier corresponding to one version of a model in ASDC
16132 example: __MODEL-VERSION-ID__
16133 - name: model-element-uuid
16137 example: __MODEL-ELEMENT-UUID__
16140 - ServiceDesignAndCreation
16141 summary: create or update an existing model-element
16143 Create or update an existing model-element.
16145 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16146 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
16155 description: Response codes found in [response codes](https://wiki.onap.org/).
16157 - name: model-invariant-id
16159 description: Unique identifier corresponding to the main definition of a model in ASDC
16162 example: __MODEL-INVARIANT-ID__
16163 - name: model-version-id
16165 description: Unique identifier corresponding to one version of a model in ASDC
16168 example: __MODEL-VERSION-ID__
16169 - name: model-element-uuid
16173 example: __MODEL-ELEMENT-UUID__
16176 description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
16179 $ref: "#/definitions/model-element"
16182 - ServiceDesignAndCreation
16183 summary: update an existing model-element
16185 Update an existing model-element
16187 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16188 The PUT operation will entirely replace an existing object.
16189 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16191 Other differences between PUT and PATCH are:
16193 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16194 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16195 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16196 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
16205 description: Response codes found in [response codes](https://wiki.onap.org/).
16207 - name: model-invariant-id
16209 description: Unique identifier corresponding to the main definition of a model in ASDC
16212 example: __MODEL-INVARIANT-ID__
16213 - name: model-version-id
16215 description: Unique identifier corresponding to one version of a model in ASDC
16218 example: __MODEL-VERSION-ID__
16219 - name: model-element-uuid
16223 example: __MODEL-ELEMENT-UUID__
16226 description: model-element object that needs to be updated.
16229 $ref: "#/patchDefinitions/model-element"
16232 - ServiceDesignAndCreation
16233 summary: delete an existing model-element
16234 description: delete an existing model-element
16235 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
16244 description: Response codes found in [response codes](https://wiki.onap.org/).
16246 - name: model-invariant-id
16248 description: Unique identifier corresponding to the main definition of a model in ASDC
16251 example: __MODEL-INVARIANT-ID__
16252 - name: model-version-id
16254 description: Unique identifier corresponding to one version of a model in ASDC
16257 example: __MODEL-VERSION-ID__
16258 - name: model-element-uuid
16262 example: __MODEL-ELEMENT-UUID__
16263 - name: resource-version
16265 description: resource-version for concurrency
16268 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements:
16271 - ServiceDesignAndCreation
16272 summary: returns model-elements
16273 description: returns model-elements
16274 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements
16280 description: successful operation
16282 $ref: "#/getDefinitions/model-elements"
16284 description: Response codes found in [response codes](https://wiki.onap.org/).
16286 - name: model-invariant-id
16288 description: Unique identifier corresponding to the main definition of a model in ASDC
16291 example: __MODEL-INVARIANT-ID__
16292 - name: model-version-id
16294 description: Unique identifier corresponding to one version of a model in ASDC
16297 example: __MODEL-VERSION-ID__
16298 - name: model-element-uuid
16303 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}:
16306 - ServiceDesignAndCreation
16307 summary: returns metadatum
16308 description: returns metadatum
16309 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
16315 description: successful operation
16317 $ref: "#/getDefinitions/metadatum"
16319 description: Response codes found in [response codes](https://wiki.onap.org/).
16321 - name: model-invariant-id
16323 description: Unique identifier corresponding to the main definition of a model in ASDC
16326 example: __MODEL-INVARIANT-ID__
16327 - name: model-version-id
16329 description: Unique identifier corresponding to one version of a model in ASDC
16332 example: __MODEL-VERSION-ID__
16337 example: __METANAME__
16340 - ServiceDesignAndCreation
16341 summary: create or update an existing metadatum
16343 Create or update an existing metadatum.
16345 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16346 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
16355 description: Response codes found in [response codes](https://wiki.onap.org/).
16357 - name: model-invariant-id
16359 description: Unique identifier corresponding to the main definition of a model in ASDC
16362 example: __MODEL-INVARIANT-ID__
16363 - name: model-version-id
16365 description: Unique identifier corresponding to one version of a model in ASDC
16368 example: __MODEL-VERSION-ID__
16373 example: __METANAME__
16376 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json)
16379 $ref: "#/definitions/metadatum"
16382 - ServiceDesignAndCreation
16383 summary: update an existing metadatum
16385 Update an existing metadatum
16387 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16388 The PUT operation will entirely replace an existing object.
16389 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16391 Other differences between PUT and PATCH are:
16393 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16394 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16395 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16396 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
16405 description: Response codes found in [response codes](https://wiki.onap.org/).
16407 - name: model-invariant-id
16409 description: Unique identifier corresponding to the main definition of a model in ASDC
16412 example: __MODEL-INVARIANT-ID__
16413 - name: model-version-id
16415 description: Unique identifier corresponding to one version of a model in ASDC
16418 example: __MODEL-VERSION-ID__
16423 example: __METANAME__
16426 description: metadatum object that needs to be updated.
16429 $ref: "#/patchDefinitions/metadatum"
16432 - ServiceDesignAndCreation
16433 summary: delete an existing metadatum
16434 description: delete an existing metadatum
16435 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
16444 description: Response codes found in [response codes](https://wiki.onap.org/).
16446 - name: model-invariant-id
16448 description: Unique identifier corresponding to the main definition of a model in ASDC
16451 example: __MODEL-INVARIANT-ID__
16452 - name: model-version-id
16454 description: Unique identifier corresponding to one version of a model in ASDC
16457 example: __MODEL-VERSION-ID__
16462 example: __METANAME__
16463 - name: resource-version
16465 description: resource-version for concurrency
16468 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata:
16471 - ServiceDesignAndCreation
16472 summary: returns metadata
16473 description: returns metadata
16474 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata
16480 description: successful operation
16482 $ref: "#/getDefinitions/metadata"
16484 description: Response codes found in [response codes](https://wiki.onap.org/).
16486 - name: model-invariant-id
16488 description: Unique identifier corresponding to the main definition of a model in ASDC
16491 example: __MODEL-INVARIANT-ID__
16492 - name: model-version-id
16494 description: Unique identifier corresponding to one version of a model in ASDC
16497 example: __MODEL-VERSION-ID__
16503 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship:
16506 - ServiceDesignAndCreation
16507 summary: see node definition for valid relationships
16508 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
16517 description: Response codes found in [response codes](https://wiki.onap.org/).
16519 - name: model-invariant-id
16521 description: Unique identifier corresponding to the main definition of a model in ASDC
16524 example: __MODEL-INVARIANT-ID__
16525 - name: model-version-id
16527 description: Unique identifier corresponding to one version of a model in ASDC
16530 example: __MODEL-VERSION-ID__
16533 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
16536 $ref: "#/definitions/relationship"
16539 - ServiceDesignAndCreation
16540 summary: delete an existing relationship
16541 description: delete an existing relationship
16542 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
16551 description: Response codes found in [response codes](https://wiki.onap.org/).
16553 - name: model-invariant-id
16555 description: Unique identifier corresponding to the main definition of a model in ASDC
16558 example: __MODEL-INVARIANT-ID__
16559 - name: model-version-id
16561 description: Unique identifier corresponding to one version of a model in ASDC
16564 example: __MODEL-VERSION-ID__
16565 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}:
16568 - ServiceDesignAndCreation
16569 summary: returns model-ver
16570 description: returns model-ver
16571 operationId: getServiceDesignAndCreationModelsModelModelVersModelVer
16577 description: successful operation
16579 $ref: "#/getDefinitions/model-ver"
16581 description: Response codes found in [response codes](https://wiki.onap.org/).
16583 - name: model-invariant-id
16585 description: Unique identifier corresponding to the main definition of a model in ASDC
16588 example: __MODEL-INVARIANT-ID__
16589 - name: model-version-id
16591 description: Unique identifier corresponding to one version of a model in ASDC
16594 example: __MODEL-VERSION-ID__
16597 - ServiceDesignAndCreation
16598 summary: create or update an existing model-ver
16600 Create or update an existing model-ver.
16602 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16603 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer
16612 description: Response codes found in [response codes](https://wiki.onap.org/).
16614 - name: model-invariant-id
16616 description: Unique identifier corresponding to the main definition of a model in ASDC
16619 example: __MODEL-INVARIANT-ID__
16620 - name: model-version-id
16622 description: Unique identifier corresponding to one version of a model in ASDC
16625 example: __MODEL-VERSION-ID__
16628 description: model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
16631 $ref: "#/definitions/model-ver"
16634 - ServiceDesignAndCreation
16635 summary: update an existing model-ver
16637 Update an existing model-ver
16639 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16640 The PUT operation will entirely replace an existing object.
16641 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16643 Other differences between PUT and PATCH are:
16645 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16646 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16647 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16648 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVer
16657 description: Response codes found in [response codes](https://wiki.onap.org/).
16659 - name: model-invariant-id
16661 description: Unique identifier corresponding to the main definition of a model in ASDC
16664 example: __MODEL-INVARIANT-ID__
16665 - name: model-version-id
16667 description: Unique identifier corresponding to one version of a model in ASDC
16670 example: __MODEL-VERSION-ID__
16673 description: model-ver object that needs to be updated.
16676 $ref: "#/patchDefinitions/model-ver"
16679 - ServiceDesignAndCreation
16680 summary: delete an existing model-ver
16681 description: delete an existing model-ver
16682 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVer
16691 description: Response codes found in [response codes](https://wiki.onap.org/).
16693 - name: model-invariant-id
16695 description: Unique identifier corresponding to the main definition of a model in ASDC
16698 example: __MODEL-INVARIANT-ID__
16699 - name: model-version-id
16701 description: Unique identifier corresponding to one version of a model in ASDC
16704 example: __MODEL-VERSION-ID__
16705 - name: resource-version
16707 description: resource-version for concurrency
16710 /service-design-and-creation/models/model/{model-invariant-id}/model-vers:
16713 - ServiceDesignAndCreation
16714 summary: returns model-vers
16715 description: returns model-vers
16716 operationId: getServiceDesignAndCreationModelsModelModelVers
16722 description: successful operation
16724 $ref: "#/getDefinitions/model-vers"
16726 description: Response codes found in [response codes](https://wiki.onap.org/).
16728 - name: model-invariant-id
16730 description: Unique identifier corresponding to the main definition of a model in ASDC
16733 example: __MODEL-INVARIANT-ID__
16734 - name: model-version-id
16744 - name: model-version
16749 /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship:
16752 - ServiceDesignAndCreation
16753 summary: see node definition for valid relationships
16754 operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship
16763 description: Response codes found in [response codes](https://wiki.onap.org/).
16765 - name: model-invariant-id
16767 description: Unique identifier corresponding to the main definition of a model in ASDC
16770 example: __MODEL-INVARIANT-ID__
16773 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModel.json)
16776 $ref: "#/definitions/relationship"
16779 - ServiceDesignAndCreation
16780 summary: delete an existing relationship
16781 description: delete an existing relationship
16782 operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship
16791 description: Response codes found in [response codes](https://wiki.onap.org/).
16793 - name: model-invariant-id
16795 description: Unique identifier corresponding to the main definition of a model in ASDC
16798 example: __MODEL-INVARIANT-ID__
16799 /service-design-and-creation/models/model/{model-invariant-id}:
16802 - ServiceDesignAndCreation
16803 summary: returns model
16804 description: returns model
16805 operationId: getServiceDesignAndCreationModelsModel
16811 description: successful operation
16813 $ref: "#/getDefinitions/model"
16815 description: Response codes found in [response codes](https://wiki.onap.org/).
16817 - name: model-invariant-id
16819 description: Unique identifier corresponding to the main definition of a model in ASDC
16822 example: __MODEL-INVARIANT-ID__
16825 - ServiceDesignAndCreation
16826 summary: create or update an existing model
16828 Create or update an existing model.
16830 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16831 operationId: createOrUpdateServiceDesignAndCreationModelsModel
16840 description: Response codes found in [response codes](https://wiki.onap.org/).
16842 - name: model-invariant-id
16844 description: Unique identifier corresponding to the main definition of a model in ASDC
16847 example: __MODEL-INVARIANT-ID__
16850 description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModel.json)
16853 $ref: "#/definitions/model"
16856 - ServiceDesignAndCreation
16857 summary: update an existing model
16859 Update an existing model
16861 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16862 The PUT operation will entirely replace an existing object.
16863 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16865 Other differences between PUT and PATCH are:
16867 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16868 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16869 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16870 operationId: UpdateServiceDesignAndCreationModelsModel
16879 description: Response codes found in [response codes](https://wiki.onap.org/).
16881 - name: model-invariant-id
16883 description: Unique identifier corresponding to the main definition of a model in ASDC
16886 example: __MODEL-INVARIANT-ID__
16889 description: model object that needs to be updated.
16892 $ref: "#/patchDefinitions/model"
16895 - ServiceDesignAndCreation
16896 summary: delete an existing model
16897 description: delete an existing model
16898 operationId: deleteServiceDesignAndCreationModelsModel
16907 description: Response codes found in [response codes](https://wiki.onap.org/).
16909 - name: model-invariant-id
16911 description: Unique identifier corresponding to the main definition of a model in ASDC
16914 example: __MODEL-INVARIANT-ID__
16915 - name: resource-version
16917 description: resource-version for concurrency
16920 /service-design-and-creation/models:
16923 - ServiceDesignAndCreation
16924 summary: returns models
16925 description: returns models
16926 operationId: getServiceDesignAndCreationModels
16932 description: successful operation
16934 $ref: "#/getDefinitions/models"
16936 description: Response codes found in [response codes](https://wiki.onap.org/).
16938 - name: model-invariant-id
16948 /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:
16951 - ServiceDesignAndCreation
16952 summary: see node definition for valid relationships
16953 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
16962 description: Response codes found in [response codes](https://wiki.onap.org/).
16964 - name: named-query-uuid
16968 example: __NAMED-QUERY-UUID__
16969 - name: named-query-element-uuid
16973 example: __NAMED-QUERY-ELEMENT-UUID__
16974 - name: related-lookup-uuid
16978 example: __RELATED-LOOKUP-UUID__
16981 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
16984 $ref: "#/definitions/relationship"
16987 - ServiceDesignAndCreation
16988 summary: delete an existing relationship
16989 description: delete an existing relationship
16990 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
16999 description: Response codes found in [response codes](https://wiki.onap.org/).
17001 - name: named-query-uuid
17005 example: __NAMED-QUERY-UUID__
17006 - name: named-query-element-uuid
17010 example: __NAMED-QUERY-ELEMENT-UUID__
17011 - name: related-lookup-uuid
17015 example: __RELATED-LOOKUP-UUID__
17016 /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}:
17019 - ServiceDesignAndCreation
17020 summary: returns related-lookup
17021 description: returns related-lookup
17022 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
17028 description: successful operation
17030 $ref: "#/getDefinitions/related-lookup"
17032 description: Response codes found in [response codes](https://wiki.onap.org/).
17034 - name: named-query-uuid
17038 example: __NAMED-QUERY-UUID__
17039 - name: named-query-element-uuid
17043 example: __NAMED-QUERY-ELEMENT-UUID__
17044 - name: related-lookup-uuid
17048 example: __RELATED-LOOKUP-UUID__
17051 - ServiceDesignAndCreation
17052 summary: create or update an existing related-lookup
17054 Create or update an existing related-lookup.
17056 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17057 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
17066 description: Response codes found in [response codes](https://wiki.onap.org/).
17068 - name: named-query-uuid
17072 example: __NAMED-QUERY-UUID__
17073 - name: named-query-element-uuid
17077 example: __NAMED-QUERY-ELEMENT-UUID__
17078 - name: related-lookup-uuid
17082 example: __RELATED-LOOKUP-UUID__
17085 description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
17088 $ref: "#/definitions/related-lookup"
17091 - ServiceDesignAndCreation
17092 summary: update an existing related-lookup
17094 Update an existing related-lookup
17096 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17097 The PUT operation will entirely replace an existing object.
17098 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17100 Other differences between PUT and PATCH are:
17102 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17103 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17104 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17105 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
17114 description: Response codes found in [response codes](https://wiki.onap.org/).
17116 - name: named-query-uuid
17120 example: __NAMED-QUERY-UUID__
17121 - name: named-query-element-uuid
17125 example: __NAMED-QUERY-ELEMENT-UUID__
17126 - name: related-lookup-uuid
17130 example: __RELATED-LOOKUP-UUID__
17133 description: related-lookup object that needs to be updated.
17136 $ref: "#/patchDefinitions/related-lookup"
17139 - ServiceDesignAndCreation
17140 summary: delete an existing related-lookup
17141 description: delete an existing related-lookup
17142 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
17151 description: Response codes found in [response codes](https://wiki.onap.org/).
17153 - name: named-query-uuid
17157 example: __NAMED-QUERY-UUID__
17158 - name: named-query-element-uuid
17162 example: __NAMED-QUERY-ELEMENT-UUID__
17163 - name: related-lookup-uuid
17167 example: __RELATED-LOOKUP-UUID__
17168 - name: resource-version
17170 description: resource-version for concurrency
17173 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups:
17176 - ServiceDesignAndCreation
17177 summary: returns related-lookups
17178 description: returns related-lookups
17179 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups
17185 description: successful operation
17187 $ref: "#/getDefinitions/related-lookups"
17189 description: Response codes found in [response codes](https://wiki.onap.org/).
17191 - name: named-query-uuid
17195 example: __NAMED-QUERY-UUID__
17196 - name: named-query-element-uuid
17200 example: __NAMED-QUERY-ELEMENT-UUID__
17201 - name: related-lookup-uuid
17206 /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}:
17209 - ServiceDesignAndCreation
17210 summary: returns property-constraint
17211 description: returns property-constraint
17212 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
17218 description: successful operation
17220 $ref: "#/getDefinitions/property-constraint"
17222 description: Response codes found in [response codes](https://wiki.onap.org/).
17224 - name: named-query-uuid
17228 example: __NAMED-QUERY-UUID__
17229 - name: named-query-element-uuid
17233 example: __NAMED-QUERY-ELEMENT-UUID__
17234 - name: property-constraint-uuid
17238 example: __PROPERTY-CONSTRAINT-UUID__
17241 - ServiceDesignAndCreation
17242 summary: create or update an existing property-constraint
17244 Create or update an existing property-constraint.
17246 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17247 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
17256 description: Response codes found in [response codes](https://wiki.onap.org/).
17258 - name: named-query-uuid
17262 example: __NAMED-QUERY-UUID__
17263 - name: named-query-element-uuid
17267 example: __NAMED-QUERY-ELEMENT-UUID__
17268 - name: property-constraint-uuid
17272 example: __PROPERTY-CONSTRAINT-UUID__
17275 description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)
17278 $ref: "#/definitions/property-constraint"
17281 - ServiceDesignAndCreation
17282 summary: update an existing property-constraint
17284 Update an existing property-constraint
17286 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17287 The PUT operation will entirely replace an existing object.
17288 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17290 Other differences between PUT and PATCH are:
17292 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17293 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17294 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17295 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
17304 description: Response codes found in [response codes](https://wiki.onap.org/).
17306 - name: named-query-uuid
17310 example: __NAMED-QUERY-UUID__
17311 - name: named-query-element-uuid
17315 example: __NAMED-QUERY-ELEMENT-UUID__
17316 - name: property-constraint-uuid
17320 example: __PROPERTY-CONSTRAINT-UUID__
17323 description: property-constraint object that needs to be updated.
17326 $ref: "#/patchDefinitions/property-constraint"
17329 - ServiceDesignAndCreation
17330 summary: delete an existing property-constraint
17331 description: delete an existing property-constraint
17332 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
17341 description: Response codes found in [response codes](https://wiki.onap.org/).
17343 - name: named-query-uuid
17347 example: __NAMED-QUERY-UUID__
17348 - name: named-query-element-uuid
17352 example: __NAMED-QUERY-ELEMENT-UUID__
17353 - name: property-constraint-uuid
17357 example: __PROPERTY-CONSTRAINT-UUID__
17358 - name: resource-version
17360 description: resource-version for concurrency
17363 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints:
17366 - ServiceDesignAndCreation
17367 summary: returns property-constraints
17368 description: returns property-constraints
17369 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints
17375 description: successful operation
17377 $ref: "#/getDefinitions/property-constraints"
17379 description: Response codes found in [response codes](https://wiki.onap.org/).
17381 - name: named-query-uuid
17385 example: __NAMED-QUERY-UUID__
17386 - name: named-query-element-uuid
17390 example: __NAMED-QUERY-ELEMENT-UUID__
17391 - name: property-constraint-uuid
17396 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship:
17399 - ServiceDesignAndCreation
17400 summary: see node definition for valid relationships
17401 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
17410 description: Response codes found in [response codes](https://wiki.onap.org/).
17412 - name: named-query-uuid
17416 example: __NAMED-QUERY-UUID__
17417 - name: named-query-element-uuid
17421 example: __NAMED-QUERY-ELEMENT-UUID__
17424 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
17427 $ref: "#/definitions/relationship"
17430 - ServiceDesignAndCreation
17431 summary: delete an existing relationship
17432 description: delete an existing relationship
17433 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
17442 description: Response codes found in [response codes](https://wiki.onap.org/).
17444 - name: named-query-uuid
17448 example: __NAMED-QUERY-UUID__
17449 - name: named-query-element-uuid
17453 example: __NAMED-QUERY-ELEMENT-UUID__
17454 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}:
17457 - ServiceDesignAndCreation
17458 summary: returns named-query-element
17459 description: returns named-query-element
17460 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
17466 description: successful operation
17468 $ref: "#/getDefinitions/named-query-element"
17470 description: Response codes found in [response codes](https://wiki.onap.org/).
17472 - name: named-query-uuid
17476 example: __NAMED-QUERY-UUID__
17477 - name: named-query-element-uuid
17481 example: __NAMED-QUERY-ELEMENT-UUID__
17484 - ServiceDesignAndCreation
17485 summary: create or update an existing named-query-element
17487 Create or update an existing named-query-element.
17489 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17490 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
17499 description: Response codes found in [response codes](https://wiki.onap.org/).
17501 - name: named-query-uuid
17505 example: __NAMED-QUERY-UUID__
17506 - name: named-query-element-uuid
17510 example: __NAMED-QUERY-ELEMENT-UUID__
17513 description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
17516 $ref: "#/definitions/named-query-element"
17519 - ServiceDesignAndCreation
17520 summary: update an existing named-query-element
17522 Update an existing named-query-element
17524 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17525 The PUT operation will entirely replace an existing object.
17526 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17528 Other differences between PUT and PATCH are:
17530 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17531 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17532 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17533 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
17542 description: Response codes found in [response codes](https://wiki.onap.org/).
17544 - name: named-query-uuid
17548 example: __NAMED-QUERY-UUID__
17549 - name: named-query-element-uuid
17553 example: __NAMED-QUERY-ELEMENT-UUID__
17556 description: named-query-element object that needs to be updated.
17559 $ref: "#/patchDefinitions/named-query-element"
17562 - ServiceDesignAndCreation
17563 summary: delete an existing named-query-element
17564 description: delete an existing named-query-element
17565 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
17574 description: Response codes found in [response codes](https://wiki.onap.org/).
17576 - name: named-query-uuid
17580 example: __NAMED-QUERY-UUID__
17581 - name: named-query-element-uuid
17585 example: __NAMED-QUERY-ELEMENT-UUID__
17586 - name: resource-version
17588 description: resource-version for concurrency
17591 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements:
17594 - ServiceDesignAndCreation
17595 summary: returns named-query-elements
17596 description: returns named-query-elements
17597 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements
17603 description: successful operation
17605 $ref: "#/getDefinitions/named-query-elements"
17607 description: Response codes found in [response codes](https://wiki.onap.org/).
17609 - name: named-query-uuid
17613 example: __NAMED-QUERY-UUID__
17614 - name: named-query-element-uuid
17619 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship:
17622 - ServiceDesignAndCreation
17623 summary: see node definition for valid relationships
17624 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
17633 description: Response codes found in [response codes](https://wiki.onap.org/).
17635 - name: named-query-uuid
17639 example: __NAMED-QUERY-UUID__
17642 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
17645 $ref: "#/definitions/relationship"
17648 - ServiceDesignAndCreation
17649 summary: delete an existing relationship
17650 description: delete an existing relationship
17651 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
17660 description: Response codes found in [response codes](https://wiki.onap.org/).
17662 - name: named-query-uuid
17666 example: __NAMED-QUERY-UUID__
17667 /service-design-and-creation/named-queries/named-query/{named-query-uuid}:
17670 - ServiceDesignAndCreation
17671 summary: returns named-query
17672 description: returns named-query
17673 operationId: getServiceDesignAndCreationNamedQueriesNamedQuery
17679 description: successful operation
17681 $ref: "#/getDefinitions/named-query"
17683 description: Response codes found in [response codes](https://wiki.onap.org/).
17685 - name: named-query-uuid
17689 example: __NAMED-QUERY-UUID__
17692 - ServiceDesignAndCreation
17693 summary: create or update an existing named-query
17695 Create or update an existing named-query.
17697 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17698 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery
17707 description: Response codes found in [response codes](https://wiki.onap.org/).
17709 - name: named-query-uuid
17713 example: __NAMED-QUERY-UUID__
17716 description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
17719 $ref: "#/definitions/named-query"
17722 - ServiceDesignAndCreation
17723 summary: update an existing named-query
17725 Update an existing named-query
17727 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17728 The PUT operation will entirely replace an existing object.
17729 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17731 Other differences between PUT and PATCH are:
17733 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17734 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17735 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17736 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQuery
17745 description: Response codes found in [response codes](https://wiki.onap.org/).
17747 - name: named-query-uuid
17751 example: __NAMED-QUERY-UUID__
17754 description: named-query object that needs to be updated.
17757 $ref: "#/patchDefinitions/named-query"
17760 - ServiceDesignAndCreation
17761 summary: delete an existing named-query
17762 description: delete an existing named-query
17763 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery
17772 description: Response codes found in [response codes](https://wiki.onap.org/).
17774 - name: named-query-uuid
17778 example: __NAMED-QUERY-UUID__
17779 - name: resource-version
17781 description: resource-version for concurrency
17784 /service-design-and-creation/named-queries:
17787 - ServiceDesignAndCreation
17788 summary: returns named-queries
17789 description: returns named-queries
17790 operationId: getServiceDesignAndCreationNamedQueries
17796 description: successful operation
17798 $ref: "#/getDefinitions/named-queries"
17800 description: Response codes found in [response codes](https://wiki.onap.org/).
17802 - name: named-query-uuid
17807 - name: named-query-name
17812 /network/logical-links/logical-link/{link-name}/relationship-list/relationship:
17816 summary: see node definition for valid relationships
17817 operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship
17826 description: Response codes found in [response codes](https://wiki.onap.org/).
17830 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
17833 example: __LINK-NAME__
17836 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkLogicalLinksLogicalLink.json)
17839 $ref: "#/definitions/relationship"
17843 summary: delete an existing relationship
17844 description: delete an existing relationship
17845 operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship
17854 description: Response codes found in [response codes](https://wiki.onap.org/).
17858 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
17861 example: __LINK-NAME__
17862 /network/logical-links/logical-link/{link-name}:
17866 summary: returns logical-link
17867 description: returns logical-link
17868 operationId: getNetworkLogicalLinksLogicalLink
17874 description: successful operation
17876 $ref: "#/getDefinitions/logical-link"
17878 description: Response codes found in [response codes](https://wiki.onap.org/).
17882 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
17885 example: __LINK-NAME__
17889 summary: create or update an existing logical-link
17891 Create or update an existing logical-link.
17893 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17894 operationId: createOrUpdateNetworkLogicalLinksLogicalLink
17903 description: Response codes found in [response codes](https://wiki.onap.org/).
17907 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
17910 example: __LINK-NAME__
17913 description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkLogicalLinksLogicalLink.json)
17916 $ref: "#/definitions/logical-link"
17920 summary: update an existing logical-link
17922 Update an existing logical-link
17924 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17925 The PUT operation will entirely replace an existing object.
17926 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17928 Other differences between PUT and PATCH are:
17930 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17931 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17932 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17933 operationId: UpdateNetworkLogicalLinksLogicalLink
17942 description: Response codes found in [response codes](https://wiki.onap.org/).
17946 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
17949 example: __LINK-NAME__
17952 description: logical-link object that needs to be updated.
17955 $ref: "#/patchDefinitions/logical-link"
17959 summary: delete an existing logical-link
17960 description: delete an existing logical-link
17961 operationId: deleteNetworkLogicalLinksLogicalLink
17970 description: Response codes found in [response codes](https://wiki.onap.org/).
17974 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
17977 example: __LINK-NAME__
17978 - name: resource-version
17980 description: resource-version for concurrency
17983 /network/logical-links:
17987 summary: returns logical-links
17988 description: returns logical-links
17989 operationId: getNetworkLogicalLinks
17995 description: successful operation
17997 $ref: "#/getDefinitions/logical-links"
17999 description: Response codes found in [response codes](https://wiki.onap.org/).
18006 - name: persona-model-id
18011 - name: persona-model-version
18016 - name: widget-model-id
18021 - name: widget-model-version
18026 - name: prov-status
18046 /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:
18050 summary: see node definition for valid relationships
18051 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
18060 description: Response codes found in [response codes](https://wiki.onap.org/).
18062 - name: site-pair-set-id
18064 description: Unique id of site pair set.
18067 example: __SITE-PAIR-SET-ID__
18068 - name: routing-instance-id
18070 description: Unique id of routing instance
18073 example: __ROUTING-INSTANCE-ID__
18074 - name: site-pair-id
18076 description: unique identifier of probe
18079 example: __SITE-PAIR-ID__
18082 description: unique identifier of probe
18088 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
18091 $ref: "#/definitions/relationship"
18095 summary: delete an existing relationship
18096 description: delete an existing relationship
18097 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
18106 description: Response codes found in [response codes](https://wiki.onap.org/).
18108 - name: site-pair-set-id
18110 description: Unique id of site pair set.
18113 example: __SITE-PAIR-SET-ID__
18114 - name: routing-instance-id
18116 description: Unique id of routing instance
18119 example: __ROUTING-INSTANCE-ID__
18120 - name: site-pair-id
18122 description: unique identifier of probe
18125 example: __SITE-PAIR-ID__
18128 description: unique identifier of probe
18132 /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}:
18136 summary: returns class-of-service
18137 description: returns class-of-service
18138 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
18144 description: successful operation
18146 $ref: "#/getDefinitions/class-of-service"
18148 description: Response codes found in [response codes](https://wiki.onap.org/).
18150 - name: site-pair-set-id
18152 description: Unique id of site pair set.
18155 example: __SITE-PAIR-SET-ID__
18156 - name: routing-instance-id
18158 description: Unique id of routing instance
18161 example: __ROUTING-INSTANCE-ID__
18162 - name: site-pair-id
18164 description: unique identifier of probe
18167 example: __SITE-PAIR-ID__
18170 description: unique identifier of probe
18177 summary: create or update an existing class-of-service
18179 Create or update an existing class-of-service.
18181 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18182 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
18191 description: Response codes found in [response codes](https://wiki.onap.org/).
18193 - name: site-pair-set-id
18195 description: Unique id of site pair set.
18198 example: __SITE-PAIR-SET-ID__
18199 - name: routing-instance-id
18201 description: Unique id of routing instance
18204 example: __ROUTING-INSTANCE-ID__
18205 - name: site-pair-id
18207 description: unique identifier of probe
18210 example: __SITE-PAIR-ID__
18213 description: unique identifier of probe
18219 description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
18222 $ref: "#/definitions/class-of-service"
18226 summary: update an existing class-of-service
18228 Update an existing class-of-service
18230 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18231 The PUT operation will entirely replace an existing object.
18232 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18234 Other differences between PUT and PATCH are:
18236 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18237 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18238 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18239 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
18248 description: Response codes found in [response codes](https://wiki.onap.org/).
18250 - name: site-pair-set-id
18252 description: Unique id of site pair set.
18255 example: __SITE-PAIR-SET-ID__
18256 - name: routing-instance-id
18258 description: Unique id of routing instance
18261 example: __ROUTING-INSTANCE-ID__
18262 - name: site-pair-id
18264 description: unique identifier of probe
18267 example: __SITE-PAIR-ID__
18270 description: unique identifier of probe
18276 description: class-of-service object that needs to be updated.
18279 $ref: "#/patchDefinitions/class-of-service"
18283 summary: delete an existing class-of-service
18284 description: delete an existing class-of-service
18285 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
18294 description: Response codes found in [response codes](https://wiki.onap.org/).
18296 - name: site-pair-set-id
18298 description: Unique id of site pair set.
18301 example: __SITE-PAIR-SET-ID__
18302 - name: routing-instance-id
18304 description: Unique id of routing instance
18307 example: __ROUTING-INSTANCE-ID__
18308 - name: site-pair-id
18310 description: unique identifier of probe
18313 example: __SITE-PAIR-ID__
18316 description: unique identifier of probe
18320 - name: resource-version
18322 description: resource-version for concurrency
18325 /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:
18329 summary: returns classes-of-service
18330 description: returns classes-of-service
18331 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService
18337 description: successful operation
18339 $ref: "#/getDefinitions/classes-of-service"
18341 description: Response codes found in [response codes](https://wiki.onap.org/).
18343 - name: site-pair-set-id
18345 description: Unique id of site pair set.
18348 example: __SITE-PAIR-SET-ID__
18349 - name: routing-instance-id
18351 description: Unique id of routing instance
18354 example: __ROUTING-INSTANCE-ID__
18355 - name: site-pair-id
18357 description: unique identifier of probe
18360 example: __SITE-PAIR-ID__
18366 /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:
18370 summary: see node definition for valid relationships
18371 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
18380 description: Response codes found in [response codes](https://wiki.onap.org/).
18382 - name: site-pair-set-id
18384 description: Unique id of site pair set.
18387 example: __SITE-PAIR-SET-ID__
18388 - name: routing-instance-id
18390 description: Unique id of routing instance
18393 example: __ROUTING-INSTANCE-ID__
18394 - name: site-pair-id
18396 description: unique identifier of probe
18399 example: __SITE-PAIR-ID__
18402 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
18405 $ref: "#/definitions/relationship"
18409 summary: delete an existing relationship
18410 description: delete an existing relationship
18411 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
18420 description: Response codes found in [response codes](https://wiki.onap.org/).
18422 - name: site-pair-set-id
18424 description: Unique id of site pair set.
18427 example: __SITE-PAIR-SET-ID__
18428 - name: routing-instance-id
18430 description: Unique id of routing instance
18433 example: __ROUTING-INSTANCE-ID__
18434 - name: site-pair-id
18436 description: unique identifier of probe
18439 example: __SITE-PAIR-ID__
18440 /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}:
18444 summary: returns site-pair
18445 description: returns site-pair
18446 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
18452 description: successful operation
18454 $ref: "#/getDefinitions/site-pair"
18456 description: Response codes found in [response codes](https://wiki.onap.org/).
18458 - name: site-pair-set-id
18460 description: Unique id of site pair set.
18463 example: __SITE-PAIR-SET-ID__
18464 - name: routing-instance-id
18466 description: Unique id of routing instance
18469 example: __ROUTING-INSTANCE-ID__
18470 - name: site-pair-id
18472 description: unique identifier of probe
18475 example: __SITE-PAIR-ID__
18479 summary: create or update an existing site-pair
18481 Create or update an existing site-pair.
18483 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18484 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
18493 description: Response codes found in [response codes](https://wiki.onap.org/).
18495 - name: site-pair-set-id
18497 description: Unique id of site pair set.
18500 example: __SITE-PAIR-SET-ID__
18501 - name: routing-instance-id
18503 description: Unique id of routing instance
18506 example: __ROUTING-INSTANCE-ID__
18507 - name: site-pair-id
18509 description: unique identifier of probe
18512 example: __SITE-PAIR-ID__
18515 description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
18518 $ref: "#/definitions/site-pair"
18522 summary: update an existing site-pair
18524 Update an existing site-pair
18526 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18527 The PUT operation will entirely replace an existing object.
18528 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18530 Other differences between PUT and PATCH are:
18532 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18533 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18534 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18535 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
18544 description: Response codes found in [response codes](https://wiki.onap.org/).
18546 - name: site-pair-set-id
18548 description: Unique id of site pair set.
18551 example: __SITE-PAIR-SET-ID__
18552 - name: routing-instance-id
18554 description: Unique id of routing instance
18557 example: __ROUTING-INSTANCE-ID__
18558 - name: site-pair-id
18560 description: unique identifier of probe
18563 example: __SITE-PAIR-ID__
18566 description: site-pair object that needs to be updated.
18569 $ref: "#/patchDefinitions/site-pair"
18573 summary: delete an existing site-pair
18574 description: delete an existing site-pair
18575 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
18584 description: Response codes found in [response codes](https://wiki.onap.org/).
18586 - name: site-pair-set-id
18588 description: Unique id of site pair set.
18591 example: __SITE-PAIR-SET-ID__
18592 - name: routing-instance-id
18594 description: Unique id of routing instance
18597 example: __ROUTING-INSTANCE-ID__
18598 - name: site-pair-id
18600 description: unique identifier of probe
18603 example: __SITE-PAIR-ID__
18604 - name: resource-version
18606 description: resource-version for concurrency
18609 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs:
18613 summary: returns site-pairs
18614 description: returns site-pairs
18615 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs
18621 description: successful operation
18623 $ref: "#/getDefinitions/site-pairs"
18625 description: Response codes found in [response codes](https://wiki.onap.org/).
18627 - name: site-pair-set-id
18629 description: Unique id of site pair set.
18632 example: __SITE-PAIR-SET-ID__
18633 - name: routing-instance-id
18635 description: Unique id of routing instance
18638 example: __ROUTING-INSTANCE-ID__
18639 - name: site-pair-id
18644 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship:
18648 summary: see node definition for valid relationships
18649 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
18658 description: Response codes found in [response codes](https://wiki.onap.org/).
18660 - name: site-pair-set-id
18662 description: Unique id of site pair set.
18665 example: __SITE-PAIR-SET-ID__
18666 - name: routing-instance-id
18668 description: Unique id of routing instance
18671 example: __ROUTING-INSTANCE-ID__
18674 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
18677 $ref: "#/definitions/relationship"
18681 summary: delete an existing relationship
18682 description: delete an existing relationship
18683 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
18692 description: Response codes found in [response codes](https://wiki.onap.org/).
18694 - name: site-pair-set-id
18696 description: Unique id of site pair set.
18699 example: __SITE-PAIR-SET-ID__
18700 - name: routing-instance-id
18702 description: Unique id of routing instance
18705 example: __ROUTING-INSTANCE-ID__
18706 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}:
18710 summary: returns routing-instance
18711 description: returns routing-instance
18712 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
18718 description: successful operation
18720 $ref: "#/getDefinitions/routing-instance"
18722 description: Response codes found in [response codes](https://wiki.onap.org/).
18724 - name: site-pair-set-id
18726 description: Unique id of site pair set.
18729 example: __SITE-PAIR-SET-ID__
18730 - name: routing-instance-id
18732 description: Unique id of routing instance
18735 example: __ROUTING-INSTANCE-ID__
18739 summary: create or update an existing routing-instance
18741 Create or update an existing routing-instance.
18743 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18744 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
18753 description: Response codes found in [response codes](https://wiki.onap.org/).
18755 - name: site-pair-set-id
18757 description: Unique id of site pair set.
18760 example: __SITE-PAIR-SET-ID__
18761 - name: routing-instance-id
18763 description: Unique id of routing instance
18766 example: __ROUTING-INSTANCE-ID__
18769 description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
18772 $ref: "#/definitions/routing-instance"
18776 summary: update an existing routing-instance
18778 Update an existing routing-instance
18780 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18781 The PUT operation will entirely replace an existing object.
18782 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18784 Other differences between PUT and PATCH are:
18786 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18787 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18788 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18789 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
18798 description: Response codes found in [response codes](https://wiki.onap.org/).
18800 - name: site-pair-set-id
18802 description: Unique id of site pair set.
18805 example: __SITE-PAIR-SET-ID__
18806 - name: routing-instance-id
18808 description: Unique id of routing instance
18811 example: __ROUTING-INSTANCE-ID__
18814 description: routing-instance object that needs to be updated.
18817 $ref: "#/patchDefinitions/routing-instance"
18821 summary: delete an existing routing-instance
18822 description: delete an existing routing-instance
18823 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
18832 description: Response codes found in [response codes](https://wiki.onap.org/).
18834 - name: site-pair-set-id
18836 description: Unique id of site pair set.
18839 example: __SITE-PAIR-SET-ID__
18840 - name: routing-instance-id
18842 description: Unique id of routing instance
18845 example: __ROUTING-INSTANCE-ID__
18846 - name: resource-version
18848 description: resource-version for concurrency
18851 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances:
18855 summary: returns routing-instances
18856 description: returns routing-instances
18857 operationId: getNetworkSitePairSetsSitePairSetRoutingInstances
18863 description: successful operation
18865 $ref: "#/getDefinitions/routing-instances"
18867 description: Response codes found in [response codes](https://wiki.onap.org/).
18869 - name: site-pair-set-id
18871 description: Unique id of site pair set.
18874 example: __SITE-PAIR-SET-ID__
18875 - name: routing-instance-id
18880 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship:
18884 summary: see node definition for valid relationships
18885 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship
18894 description: Response codes found in [response codes](https://wiki.onap.org/).
18896 - name: site-pair-set-id
18898 description: Unique id of site pair set.
18901 example: __SITE-PAIR-SET-ID__
18904 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSet.json)
18907 $ref: "#/definitions/relationship"
18911 summary: delete an existing relationship
18912 description: delete an existing relationship
18913 operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship
18922 description: Response codes found in [response codes](https://wiki.onap.org/).
18924 - name: site-pair-set-id
18926 description: Unique id of site pair set.
18929 example: __SITE-PAIR-SET-ID__
18930 /network/site-pair-sets/site-pair-set/{site-pair-set-id}:
18934 summary: returns site-pair-set
18935 description: returns site-pair-set
18936 operationId: getNetworkSitePairSetsSitePairSet
18942 description: successful operation
18944 $ref: "#/getDefinitions/site-pair-set"
18946 description: Response codes found in [response codes](https://wiki.onap.org/).
18948 - name: site-pair-set-id
18950 description: Unique id of site pair set.
18953 example: __SITE-PAIR-SET-ID__
18957 summary: create or update an existing site-pair-set
18959 Create or update an existing site-pair-set.
18961 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18962 operationId: createOrUpdateNetworkSitePairSetsSitePairSet
18971 description: Response codes found in [response codes](https://wiki.onap.org/).
18973 - name: site-pair-set-id
18975 description: Unique id of site pair set.
18978 example: __SITE-PAIR-SET-ID__
18981 description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSet.json)
18984 $ref: "#/definitions/site-pair-set"
18988 summary: update an existing site-pair-set
18990 Update an existing site-pair-set
18992 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18993 The PUT operation will entirely replace an existing object.
18994 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18996 Other differences between PUT and PATCH are:
18998 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18999 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19000 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19001 operationId: UpdateNetworkSitePairSetsSitePairSet
19010 description: Response codes found in [response codes](https://wiki.onap.org/).
19012 - name: site-pair-set-id
19014 description: Unique id of site pair set.
19017 example: __SITE-PAIR-SET-ID__
19020 description: site-pair-set object that needs to be updated.
19023 $ref: "#/patchDefinitions/site-pair-set"
19027 summary: delete an existing site-pair-set
19028 description: delete an existing site-pair-set
19029 operationId: deleteNetworkSitePairSetsSitePairSet
19038 description: Response codes found in [response codes](https://wiki.onap.org/).
19040 - name: site-pair-set-id
19042 description: Unique id of site pair set.
19045 example: __SITE-PAIR-SET-ID__
19046 - name: resource-version
19048 description: resource-version for concurrency
19051 /network/site-pair-sets:
19055 summary: returns site-pair-sets
19056 description: returns site-pair-sets
19057 operationId: getNetworkSitePairSets
19063 description: successful operation
19065 $ref: "#/getDefinitions/site-pair-sets"
19067 description: Response codes found in [response codes](https://wiki.onap.org/).
19069 - name: site-pair-set-id
19074 /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship:
19078 summary: see node definition for valid relationships
19079 operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship
19088 description: Response codes found in [response codes](https://wiki.onap.org/).
19092 description: VPN ID, globally unique within A&AI
19095 example: __VPN-ID__
19098 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVpnBindingsVpnBinding.json)
19101 $ref: "#/definitions/relationship"
19105 summary: delete an existing relationship
19106 description: delete an existing relationship
19107 operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship
19116 description: Response codes found in [response codes](https://wiki.onap.org/).
19120 description: VPN ID, globally unique within A&AI
19123 example: __VPN-ID__
19124 /network/vpn-bindings/vpn-binding/{vpn-id}:
19128 summary: returns vpn-binding
19129 description: returns vpn-binding
19130 operationId: getNetworkVpnBindingsVpnBinding
19136 description: successful operation
19138 $ref: "#/getDefinitions/vpn-binding"
19140 description: Response codes found in [response codes](https://wiki.onap.org/).
19144 description: VPN ID, globally unique within A&AI
19147 example: __VPN-ID__
19151 summary: create or update an existing vpn-binding
19153 Create or update an existing vpn-binding.
19155 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19156 operationId: createOrUpdateNetworkVpnBindingsVpnBinding
19165 description: Response codes found in [response codes](https://wiki.onap.org/).
19169 description: VPN ID, globally unique within A&AI
19172 example: __VPN-ID__
19175 description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVpnBindingsVpnBinding.json)
19178 $ref: "#/definitions/vpn-binding"
19182 summary: update an existing vpn-binding
19184 Update an existing vpn-binding
19186 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19187 The PUT operation will entirely replace an existing object.
19188 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19190 Other differences between PUT and PATCH are:
19192 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19193 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19194 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19195 operationId: UpdateNetworkVpnBindingsVpnBinding
19204 description: Response codes found in [response codes](https://wiki.onap.org/).
19208 description: VPN ID, globally unique within A&AI
19211 example: __VPN-ID__
19214 description: vpn-binding object that needs to be updated.
19217 $ref: "#/patchDefinitions/vpn-binding"
19221 summary: delete an existing vpn-binding
19222 description: delete an existing vpn-binding
19223 operationId: deleteNetworkVpnBindingsVpnBinding
19232 description: Response codes found in [response codes](https://wiki.onap.org/).
19236 description: VPN ID, globally unique within A&AI
19239 example: __VPN-ID__
19240 - name: resource-version
19242 description: resource-version for concurrency
19245 /network/vpn-bindings:
19249 summary: returns vpn-bindings
19250 description: returns vpn-bindings
19251 operationId: getNetworkVpnBindings
19257 description: successful operation
19259 $ref: "#/getDefinitions/vpn-bindings"
19261 description: Response codes found in [response codes](https://wiki.onap.org/).
19273 - name: global-route-target
19283 /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
19287 summary: see node definition for valid relationships
19288 operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship
19297 description: Response codes found in [response codes](https://wiki.onap.org/).
19299 - name: equipment-name
19303 example: __EQUIPMENT-NAME__
19306 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPe.json)
19309 $ref: "#/definitions/relationship"
19313 summary: delete an existing relationship
19314 description: delete an existing relationship
19315 operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship
19324 description: Response codes found in [response codes](https://wiki.onap.org/).
19326 - name: equipment-name
19330 example: __EQUIPMENT-NAME__
19331 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
19335 summary: see node definition for valid relationships
19336 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
19345 description: Response codes found in [response codes](https://wiki.onap.org/).
19347 - name: equipment-name
19351 example: __EQUIPMENT-NAME__
19352 - name: interface-name
19354 description: Name that identifies the physical interface
19357 example: __INTERFACE-NAME__
19360 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterface.json)
19363 $ref: "#/definitions/relationship"
19367 summary: delete an existing relationship
19368 description: delete an existing relationship
19369 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
19378 description: Response codes found in [response codes](https://wiki.onap.org/).
19380 - name: equipment-name
19384 example: __EQUIPMENT-NAME__
19385 - name: interface-name
19387 description: Name that identifies the physical interface
19390 example: __INTERFACE-NAME__
19391 /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:
19395 summary: see node definition for valid relationships
19396 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
19405 description: Response codes found in [response codes](https://wiki.onap.org/).
19407 - name: equipment-name
19411 example: __EQUIPMENT-NAME__
19412 - name: interface-name
19414 description: Name that identifies the physical interface
19417 example: __INTERFACE-NAME__
19418 - name: interface-name
19420 description: Name given to the interface
19423 example: __INTERFACE-NAME__
19424 - name: vlan-interface
19426 description: String that identifies the interface
19429 example: __VLAN-INTERFACE__
19432 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
19435 $ref: "#/definitions/relationship"
19439 summary: delete an existing relationship
19440 description: delete an existing relationship
19441 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
19450 description: Response codes found in [response codes](https://wiki.onap.org/).
19452 - name: equipment-name
19456 example: __EQUIPMENT-NAME__
19457 - name: interface-name
19459 description: Name that identifies the physical interface
19462 example: __INTERFACE-NAME__
19463 - name: interface-name
19465 description: Name given to the interface
19468 example: __INTERFACE-NAME__
19469 - name: vlan-interface
19471 description: String that identifies the interface
19474 example: __VLAN-INTERFACE__
19475 /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:
19479 summary: see node definition for valid relationships
19480 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
19489 description: Response codes found in [response codes](https://wiki.onap.org/).
19491 - name: equipment-name
19495 example: __EQUIPMENT-NAME__
19496 - name: interface-name
19498 description: Name that identifies the physical interface
19501 example: __INTERFACE-NAME__
19502 - name: interface-name
19504 description: Name given to the interface
19507 example: __INTERFACE-NAME__
19508 - name: vlan-interface
19510 description: String that identifies the interface
19513 example: __VLAN-INTERFACE__
19514 - name: l3-interface-ipv4-address
19516 description: IP address
19519 example: __L3-INTERFACE-IPV4-ADDRESS__
19522 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
19525 $ref: "#/definitions/relationship"
19529 summary: delete an existing relationship
19530 description: delete an existing relationship
19531 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
19540 description: Response codes found in [response codes](https://wiki.onap.org/).
19542 - name: equipment-name
19546 example: __EQUIPMENT-NAME__
19547 - name: interface-name
19549 description: Name that identifies the physical interface
19552 example: __INTERFACE-NAME__
19553 - name: interface-name
19555 description: Name given to the interface
19558 example: __INTERFACE-NAME__
19559 - name: vlan-interface
19561 description: String that identifies the interface
19564 example: __VLAN-INTERFACE__
19565 - name: l3-interface-ipv4-address
19567 description: IP address
19570 example: __L3-INTERFACE-IPV4-ADDRESS__
19571 /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}:
19575 summary: returns l3-interface-ipv4-address-list
19576 description: returns l3-interface-ipv4-address-list
19577 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
19583 description: successful operation
19585 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
19587 description: Response codes found in [response codes](https://wiki.onap.org/).
19589 - name: equipment-name
19593 example: __EQUIPMENT-NAME__
19594 - name: interface-name
19596 description: Name that identifies the physical interface
19599 example: __INTERFACE-NAME__
19600 - name: interface-name
19602 description: Name given to the interface
19605 example: __INTERFACE-NAME__
19606 - name: vlan-interface
19608 description: String that identifies the interface
19611 example: __VLAN-INTERFACE__
19612 - name: l3-interface-ipv4-address
19614 description: IP address
19617 example: __L3-INTERFACE-IPV4-ADDRESS__
19621 summary: create or update an existing l3-interface-ipv4-address-list
19623 Create or update an existing l3-interface-ipv4-address-list.
19625 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19626 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
19635 description: Response codes found in [response codes](https://wiki.onap.org/).
19637 - name: equipment-name
19641 example: __EQUIPMENT-NAME__
19642 - name: interface-name
19644 description: Name that identifies the physical interface
19647 example: __INTERFACE-NAME__
19648 - name: interface-name
19650 description: Name given to the interface
19653 example: __INTERFACE-NAME__
19654 - name: vlan-interface
19656 description: String that identifies the interface
19659 example: __VLAN-INTERFACE__
19660 - name: l3-interface-ipv4-address
19662 description: IP address
19665 example: __L3-INTERFACE-IPV4-ADDRESS__
19668 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
19671 $ref: "#/definitions/l3-interface-ipv4-address-list"
19675 summary: update an existing l3-interface-ipv4-address-list
19677 Update an existing l3-interface-ipv4-address-list
19679 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19680 The PUT operation will entirely replace an existing object.
19681 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19683 Other differences between PUT and PATCH are:
19685 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19686 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19687 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19688 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
19697 description: Response codes found in [response codes](https://wiki.onap.org/).
19699 - name: equipment-name
19703 example: __EQUIPMENT-NAME__
19704 - name: interface-name
19706 description: Name that identifies the physical interface
19709 example: __INTERFACE-NAME__
19710 - name: interface-name
19712 description: Name given to the interface
19715 example: __INTERFACE-NAME__
19716 - name: vlan-interface
19718 description: String that identifies the interface
19721 example: __VLAN-INTERFACE__
19722 - name: l3-interface-ipv4-address
19724 description: IP address
19727 example: __L3-INTERFACE-IPV4-ADDRESS__
19730 description: l3-interface-ipv4-address-list object that needs to be updated.
19733 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
19737 summary: delete an existing l3-interface-ipv4-address-list
19738 description: delete an existing l3-interface-ipv4-address-list
19739 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
19748 description: Response codes found in [response codes](https://wiki.onap.org/).
19750 - name: equipment-name
19754 example: __EQUIPMENT-NAME__
19755 - name: interface-name
19757 description: Name that identifies the physical interface
19760 example: __INTERFACE-NAME__
19761 - name: interface-name
19763 description: Name given to the interface
19766 example: __INTERFACE-NAME__
19767 - name: vlan-interface
19769 description: String that identifies the interface
19772 example: __VLAN-INTERFACE__
19773 - name: l3-interface-ipv4-address
19775 description: IP address
19778 example: __L3-INTERFACE-IPV4-ADDRESS__
19779 - name: resource-version
19781 description: resource-version for concurrency
19784 /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:
19788 summary: see node definition for valid relationships
19789 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
19798 description: Response codes found in [response codes](https://wiki.onap.org/).
19800 - name: equipment-name
19804 example: __EQUIPMENT-NAME__
19805 - name: interface-name
19807 description: Name that identifies the physical interface
19810 example: __INTERFACE-NAME__
19811 - name: interface-name
19813 description: Name given to the interface
19816 example: __INTERFACE-NAME__
19817 - name: vlan-interface
19819 description: String that identifies the interface
19822 example: __VLAN-INTERFACE__
19823 - name: l3-interface-ipv6-address
19825 description: IP address
19828 example: __L3-INTERFACE-IPV6-ADDRESS__
19831 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
19834 $ref: "#/definitions/relationship"
19838 summary: delete an existing relationship
19839 description: delete an existing relationship
19840 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
19849 description: Response codes found in [response codes](https://wiki.onap.org/).
19851 - name: equipment-name
19855 example: __EQUIPMENT-NAME__
19856 - name: interface-name
19858 description: Name that identifies the physical interface
19861 example: __INTERFACE-NAME__
19862 - name: interface-name
19864 description: Name given to the interface
19867 example: __INTERFACE-NAME__
19868 - name: vlan-interface
19870 description: String that identifies the interface
19873 example: __VLAN-INTERFACE__
19874 - name: l3-interface-ipv6-address
19876 description: IP address
19879 example: __L3-INTERFACE-IPV6-ADDRESS__
19880 /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}:
19884 summary: returns l3-interface-ipv6-address-list
19885 description: returns l3-interface-ipv6-address-list
19886 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
19892 description: successful operation
19894 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
19896 description: Response codes found in [response codes](https://wiki.onap.org/).
19898 - name: equipment-name
19902 example: __EQUIPMENT-NAME__
19903 - name: interface-name
19905 description: Name that identifies the physical interface
19908 example: __INTERFACE-NAME__
19909 - name: interface-name
19911 description: Name given to the interface
19914 example: __INTERFACE-NAME__
19915 - name: vlan-interface
19917 description: String that identifies the interface
19920 example: __VLAN-INTERFACE__
19921 - name: l3-interface-ipv6-address
19923 description: IP address
19926 example: __L3-INTERFACE-IPV6-ADDRESS__
19930 summary: create or update an existing l3-interface-ipv6-address-list
19932 Create or update an existing l3-interface-ipv6-address-list.
19934 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19935 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
19944 description: Response codes found in [response codes](https://wiki.onap.org/).
19946 - name: equipment-name
19950 example: __EQUIPMENT-NAME__
19951 - name: interface-name
19953 description: Name that identifies the physical interface
19956 example: __INTERFACE-NAME__
19957 - name: interface-name
19959 description: Name given to the interface
19962 example: __INTERFACE-NAME__
19963 - name: vlan-interface
19965 description: String that identifies the interface
19968 example: __VLAN-INTERFACE__
19969 - name: l3-interface-ipv6-address
19971 description: IP address
19974 example: __L3-INTERFACE-IPV6-ADDRESS__
19977 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
19980 $ref: "#/definitions/l3-interface-ipv6-address-list"
19984 summary: update an existing l3-interface-ipv6-address-list
19986 Update an existing l3-interface-ipv6-address-list
19988 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19989 The PUT operation will entirely replace an existing object.
19990 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19992 Other differences between PUT and PATCH are:
19994 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19995 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19996 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19997 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
20006 description: Response codes found in [response codes](https://wiki.onap.org/).
20008 - name: equipment-name
20012 example: __EQUIPMENT-NAME__
20013 - name: interface-name
20015 description: Name that identifies the physical interface
20018 example: __INTERFACE-NAME__
20019 - name: interface-name
20021 description: Name given to the interface
20024 example: __INTERFACE-NAME__
20025 - name: vlan-interface
20027 description: String that identifies the interface
20030 example: __VLAN-INTERFACE__
20031 - name: l3-interface-ipv6-address
20033 description: IP address
20036 example: __L3-INTERFACE-IPV6-ADDRESS__
20039 description: l3-interface-ipv6-address-list object that needs to be updated.
20042 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
20046 summary: delete an existing l3-interface-ipv6-address-list
20047 description: delete an existing l3-interface-ipv6-address-list
20048 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
20057 description: Response codes found in [response codes](https://wiki.onap.org/).
20059 - name: equipment-name
20063 example: __EQUIPMENT-NAME__
20064 - name: interface-name
20066 description: Name that identifies the physical interface
20069 example: __INTERFACE-NAME__
20070 - name: interface-name
20072 description: Name given to the interface
20075 example: __INTERFACE-NAME__
20076 - name: vlan-interface
20078 description: String that identifies the interface
20081 example: __VLAN-INTERFACE__
20082 - name: l3-interface-ipv6-address
20084 description: IP address
20087 example: __L3-INTERFACE-IPV6-ADDRESS__
20088 - name: resource-version
20090 description: resource-version for concurrency
20093 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
20097 summary: returns vlan
20098 description: returns vlan
20099 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
20105 description: successful operation
20107 $ref: "#/getDefinitions/vlan"
20109 description: Response codes found in [response codes](https://wiki.onap.org/).
20111 - name: equipment-name
20115 example: __EQUIPMENT-NAME__
20116 - name: interface-name
20118 description: Name that identifies the physical interface
20121 example: __INTERFACE-NAME__
20122 - name: interface-name
20124 description: Name given to the interface
20127 example: __INTERFACE-NAME__
20128 - name: vlan-interface
20130 description: String that identifies the interface
20133 example: __VLAN-INTERFACE__
20137 summary: create or update an existing vlan
20139 Create or update an existing vlan.
20141 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20142 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
20151 description: Response codes found in [response codes](https://wiki.onap.org/).
20153 - name: equipment-name
20157 example: __EQUIPMENT-NAME__
20158 - name: interface-name
20160 description: Name that identifies the physical interface
20163 example: __INTERFACE-NAME__
20164 - name: interface-name
20166 description: Name given to the interface
20169 example: __INTERFACE-NAME__
20170 - name: vlan-interface
20172 description: String that identifies the interface
20175 example: __VLAN-INTERFACE__
20178 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
20181 $ref: "#/definitions/vlan"
20185 summary: update an existing vlan
20187 Update an existing vlan
20189 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20190 The PUT operation will entirely replace an existing object.
20191 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20193 Other differences between PUT and PATCH are:
20195 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20196 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20197 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20198 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
20207 description: Response codes found in [response codes](https://wiki.onap.org/).
20209 - name: equipment-name
20213 example: __EQUIPMENT-NAME__
20214 - name: interface-name
20216 description: Name that identifies the physical interface
20219 example: __INTERFACE-NAME__
20220 - name: interface-name
20222 description: Name given to the interface
20225 example: __INTERFACE-NAME__
20226 - name: vlan-interface
20228 description: String that identifies the interface
20231 example: __VLAN-INTERFACE__
20234 description: vlan object that needs to be updated.
20237 $ref: "#/patchDefinitions/vlan"
20241 summary: delete an existing vlan
20242 description: delete an existing vlan
20243 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
20252 description: Response codes found in [response codes](https://wiki.onap.org/).
20254 - name: equipment-name
20258 example: __EQUIPMENT-NAME__
20259 - name: interface-name
20261 description: Name that identifies the physical interface
20264 example: __INTERFACE-NAME__
20265 - name: interface-name
20267 description: Name given to the interface
20270 example: __INTERFACE-NAME__
20271 - name: vlan-interface
20273 description: String that identifies the interface
20276 example: __VLAN-INTERFACE__
20277 - name: resource-version
20279 description: resource-version for concurrency
20282 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
20286 summary: returns vlans
20287 description: returns vlans
20288 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans
20294 description: successful operation
20296 $ref: "#/getDefinitions/vlans"
20298 description: Response codes found in [response codes](https://wiki.onap.org/).
20300 - name: equipment-name
20304 example: __EQUIPMENT-NAME__
20305 - name: interface-name
20307 description: Name that identifies the physical interface
20310 example: __INTERFACE-NAME__
20311 - name: interface-name
20313 description: Name given to the interface
20316 example: __INTERFACE-NAME__
20317 - name: vlan-interface
20322 - name: vlan-id-inner
20333 /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:
20337 summary: see node definition for valid relationships
20338 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
20347 description: Response codes found in [response codes](https://wiki.onap.org/).
20349 - name: equipment-name
20353 example: __EQUIPMENT-NAME__
20354 - name: interface-name
20356 description: Name that identifies the physical interface
20359 example: __INTERFACE-NAME__
20360 - name: interface-name
20362 description: Name given to the interface
20365 example: __INTERFACE-NAME__
20368 description: PCI ID used to identify the sriov-vf
20371 example: __PCI-ID__
20374 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
20377 $ref: "#/definitions/relationship"
20381 summary: delete an existing relationship
20382 description: delete an existing relationship
20383 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
20392 description: Response codes found in [response codes](https://wiki.onap.org/).
20394 - name: equipment-name
20398 example: __EQUIPMENT-NAME__
20399 - name: interface-name
20401 description: Name that identifies the physical interface
20404 example: __INTERFACE-NAME__
20405 - name: interface-name
20407 description: Name given to the interface
20410 example: __INTERFACE-NAME__
20413 description: PCI ID used to identify the sriov-vf
20416 example: __PCI-ID__
20417 /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}:
20421 summary: returns sriov-vf
20422 description: returns sriov-vf
20423 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
20429 description: successful operation
20431 $ref: "#/getDefinitions/sriov-vf"
20433 description: Response codes found in [response codes](https://wiki.onap.org/).
20435 - name: equipment-name
20439 example: __EQUIPMENT-NAME__
20440 - name: interface-name
20442 description: Name that identifies the physical interface
20445 example: __INTERFACE-NAME__
20446 - name: interface-name
20448 description: Name given to the interface
20451 example: __INTERFACE-NAME__
20454 description: PCI ID used to identify the sriov-vf
20457 example: __PCI-ID__
20461 summary: create or update an existing sriov-vf
20463 Create or update an existing sriov-vf.
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: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
20475 description: Response codes found in [response codes](https://wiki.onap.org/).
20477 - name: equipment-name
20481 example: __EQUIPMENT-NAME__
20482 - name: interface-name
20484 description: Name that identifies the physical interface
20487 example: __INTERFACE-NAME__
20488 - name: interface-name
20490 description: Name given to the interface
20493 example: __INTERFACE-NAME__
20496 description: PCI ID used to identify the sriov-vf
20499 example: __PCI-ID__
20502 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
20505 $ref: "#/definitions/sriov-vf"
20509 summary: update an existing sriov-vf
20511 Update an existing sriov-vf
20513 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20514 The PUT operation will entirely replace an existing object.
20515 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20517 Other differences between PUT and PATCH are:
20519 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20520 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20521 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20522 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
20531 description: Response codes found in [response codes](https://wiki.onap.org/).
20533 - name: equipment-name
20537 example: __EQUIPMENT-NAME__
20538 - name: interface-name
20540 description: Name that identifies the physical interface
20543 example: __INTERFACE-NAME__
20544 - name: interface-name
20546 description: Name given to the interface
20549 example: __INTERFACE-NAME__
20552 description: PCI ID used to identify the sriov-vf
20555 example: __PCI-ID__
20558 description: sriov-vf object that needs to be updated.
20561 $ref: "#/patchDefinitions/sriov-vf"
20565 summary: delete an existing sriov-vf
20566 description: delete an existing sriov-vf
20567 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
20576 description: Response codes found in [response codes](https://wiki.onap.org/).
20578 - name: equipment-name
20582 example: __EQUIPMENT-NAME__
20583 - name: interface-name
20585 description: Name that identifies the physical interface
20588 example: __INTERFACE-NAME__
20589 - name: interface-name
20591 description: Name given to the interface
20594 example: __INTERFACE-NAME__
20597 description: PCI ID used to identify the sriov-vf
20600 example: __PCI-ID__
20601 - name: resource-version
20603 description: resource-version for concurrency
20606 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
20610 summary: returns sriov-vfs
20611 description: returns sriov-vfs
20612 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
20618 description: successful operation
20620 $ref: "#/getDefinitions/sriov-vfs"
20622 description: Response codes found in [response codes](https://wiki.onap.org/).
20624 - name: equipment-name
20628 example: __EQUIPMENT-NAME__
20629 - name: interface-name
20631 description: Name that identifies the physical interface
20634 example: __INTERFACE-NAME__
20635 - name: interface-name
20637 description: Name given to the interface
20640 example: __INTERFACE-NAME__
20646 - name: vf-vlan-filter
20651 - name: vf-mac-filter
20656 - name: vf-vlan-strip
20661 - name: neutron-network-id
20666 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
20670 summary: see node definition for valid relationships
20671 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
20680 description: Response codes found in [response codes](https://wiki.onap.org/).
20682 - name: equipment-name
20686 example: __EQUIPMENT-NAME__
20687 - name: interface-name
20689 description: Name that identifies the physical interface
20692 example: __INTERFACE-NAME__
20693 - name: interface-name
20695 description: Name given to the interface
20698 example: __INTERFACE-NAME__
20701 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
20704 $ref: "#/definitions/relationship"
20708 summary: delete an existing relationship
20709 description: delete an existing relationship
20710 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
20719 description: Response codes found in [response codes](https://wiki.onap.org/).
20721 - name: equipment-name
20725 example: __EQUIPMENT-NAME__
20726 - name: interface-name
20728 description: Name that identifies the physical interface
20731 example: __INTERFACE-NAME__
20732 - name: interface-name
20734 description: Name given to the interface
20737 example: __INTERFACE-NAME__
20738 /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:
20742 summary: see node definition for valid relationships
20743 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
20752 description: Response codes found in [response codes](https://wiki.onap.org/).
20754 - name: equipment-name
20758 example: __EQUIPMENT-NAME__
20759 - name: interface-name
20761 description: Name that identifies the physical interface
20764 example: __INTERFACE-NAME__
20765 - name: interface-name
20767 description: Name given to the interface
20770 example: __INTERFACE-NAME__
20771 - name: l3-interface-ipv4-address
20773 description: IP address
20776 example: __L3-INTERFACE-IPV4-ADDRESS__
20779 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
20782 $ref: "#/definitions/relationship"
20786 summary: delete an existing relationship
20787 description: delete an existing relationship
20788 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
20797 description: Response codes found in [response codes](https://wiki.onap.org/).
20799 - name: equipment-name
20803 example: __EQUIPMENT-NAME__
20804 - name: interface-name
20806 description: Name that identifies the physical interface
20809 example: __INTERFACE-NAME__
20810 - name: interface-name
20812 description: Name given to the interface
20815 example: __INTERFACE-NAME__
20816 - name: l3-interface-ipv4-address
20818 description: IP address
20821 example: __L3-INTERFACE-IPV4-ADDRESS__
20822 /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}:
20826 summary: returns l3-interface-ipv4-address-list
20827 description: returns l3-interface-ipv4-address-list
20828 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
20834 description: successful operation
20836 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
20838 description: Response codes found in [response codes](https://wiki.onap.org/).
20840 - name: equipment-name
20844 example: __EQUIPMENT-NAME__
20845 - name: interface-name
20847 description: Name that identifies the physical interface
20850 example: __INTERFACE-NAME__
20851 - name: interface-name
20853 description: Name given to the interface
20856 example: __INTERFACE-NAME__
20857 - name: l3-interface-ipv4-address
20859 description: IP address
20862 example: __L3-INTERFACE-IPV4-ADDRESS__
20866 summary: create or update an existing l3-interface-ipv4-address-list
20868 Create or update an existing l3-interface-ipv4-address-list.
20870 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20871 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
20880 description: Response codes found in [response codes](https://wiki.onap.org/).
20882 - name: equipment-name
20886 example: __EQUIPMENT-NAME__
20887 - name: interface-name
20889 description: Name that identifies the physical interface
20892 example: __INTERFACE-NAME__
20893 - name: interface-name
20895 description: Name given to the interface
20898 example: __INTERFACE-NAME__
20899 - name: l3-interface-ipv4-address
20901 description: IP address
20904 example: __L3-INTERFACE-IPV4-ADDRESS__
20907 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
20910 $ref: "#/definitions/l3-interface-ipv4-address-list"
20914 summary: update an existing l3-interface-ipv4-address-list
20916 Update an existing l3-interface-ipv4-address-list
20918 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20919 The PUT operation will entirely replace an existing object.
20920 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20922 Other differences between PUT and PATCH are:
20924 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20925 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20926 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20927 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
20936 description: Response codes found in [response codes](https://wiki.onap.org/).
20938 - name: equipment-name
20942 example: __EQUIPMENT-NAME__
20943 - name: interface-name
20945 description: Name that identifies the physical interface
20948 example: __INTERFACE-NAME__
20949 - name: interface-name
20951 description: Name given to the interface
20954 example: __INTERFACE-NAME__
20955 - name: l3-interface-ipv4-address
20957 description: IP address
20960 example: __L3-INTERFACE-IPV4-ADDRESS__
20963 description: l3-interface-ipv4-address-list object that needs to be updated.
20966 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
20970 summary: delete an existing l3-interface-ipv4-address-list
20971 description: delete an existing l3-interface-ipv4-address-list
20972 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
20981 description: Response codes found in [response codes](https://wiki.onap.org/).
20983 - name: equipment-name
20987 example: __EQUIPMENT-NAME__
20988 - name: interface-name
20990 description: Name that identifies the physical interface
20993 example: __INTERFACE-NAME__
20994 - name: interface-name
20996 description: Name given to the interface
20999 example: __INTERFACE-NAME__
21000 - name: l3-interface-ipv4-address
21002 description: IP address
21005 example: __L3-INTERFACE-IPV4-ADDRESS__
21006 - name: resource-version
21008 description: resource-version for concurrency
21011 /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:
21015 summary: see node definition for valid relationships
21016 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
21025 description: Response codes found in [response codes](https://wiki.onap.org/).
21027 - name: equipment-name
21031 example: __EQUIPMENT-NAME__
21032 - name: interface-name
21034 description: Name that identifies the physical interface
21037 example: __INTERFACE-NAME__
21038 - name: interface-name
21040 description: Name given to the interface
21043 example: __INTERFACE-NAME__
21044 - name: l3-interface-ipv6-address
21046 description: IP address
21049 example: __L3-INTERFACE-IPV6-ADDRESS__
21052 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
21055 $ref: "#/definitions/relationship"
21059 summary: delete an existing relationship
21060 description: delete an existing relationship
21061 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
21070 description: Response codes found in [response codes](https://wiki.onap.org/).
21072 - name: equipment-name
21076 example: __EQUIPMENT-NAME__
21077 - name: interface-name
21079 description: Name that identifies the physical interface
21082 example: __INTERFACE-NAME__
21083 - name: interface-name
21085 description: Name given to the interface
21088 example: __INTERFACE-NAME__
21089 - name: l3-interface-ipv6-address
21091 description: IP address
21094 example: __L3-INTERFACE-IPV6-ADDRESS__
21095 /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}:
21099 summary: returns l3-interface-ipv6-address-list
21100 description: returns l3-interface-ipv6-address-list
21101 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
21107 description: successful operation
21109 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
21111 description: Response codes found in [response codes](https://wiki.onap.org/).
21113 - name: equipment-name
21117 example: __EQUIPMENT-NAME__
21118 - name: interface-name
21120 description: Name that identifies the physical interface
21123 example: __INTERFACE-NAME__
21124 - name: interface-name
21126 description: Name given to the interface
21129 example: __INTERFACE-NAME__
21130 - name: l3-interface-ipv6-address
21132 description: IP address
21135 example: __L3-INTERFACE-IPV6-ADDRESS__
21139 summary: create or update an existing l3-interface-ipv6-address-list
21141 Create or update an existing l3-interface-ipv6-address-list.
21143 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21144 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
21153 description: Response codes found in [response codes](https://wiki.onap.org/).
21155 - name: equipment-name
21159 example: __EQUIPMENT-NAME__
21160 - name: interface-name
21162 description: Name that identifies the physical interface
21165 example: __INTERFACE-NAME__
21166 - name: interface-name
21168 description: Name given to the interface
21171 example: __INTERFACE-NAME__
21172 - name: l3-interface-ipv6-address
21174 description: IP address
21177 example: __L3-INTERFACE-IPV6-ADDRESS__
21180 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
21183 $ref: "#/definitions/l3-interface-ipv6-address-list"
21187 summary: update an existing l3-interface-ipv6-address-list
21189 Update an existing l3-interface-ipv6-address-list
21191 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21192 The PUT operation will entirely replace an existing object.
21193 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21195 Other differences between PUT and PATCH are:
21197 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21198 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21199 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21200 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
21209 description: Response codes found in [response codes](https://wiki.onap.org/).
21211 - name: equipment-name
21215 example: __EQUIPMENT-NAME__
21216 - name: interface-name
21218 description: Name that identifies the physical interface
21221 example: __INTERFACE-NAME__
21222 - name: interface-name
21224 description: Name given to the interface
21227 example: __INTERFACE-NAME__
21228 - name: l3-interface-ipv6-address
21230 description: IP address
21233 example: __L3-INTERFACE-IPV6-ADDRESS__
21236 description: l3-interface-ipv6-address-list object that needs to be updated.
21239 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
21243 summary: delete an existing l3-interface-ipv6-address-list
21244 description: delete an existing l3-interface-ipv6-address-list
21245 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
21254 description: Response codes found in [response codes](https://wiki.onap.org/).
21256 - name: equipment-name
21260 example: __EQUIPMENT-NAME__
21261 - name: interface-name
21263 description: Name that identifies the physical interface
21266 example: __INTERFACE-NAME__
21267 - name: interface-name
21269 description: Name given to the interface
21272 example: __INTERFACE-NAME__
21273 - name: l3-interface-ipv6-address
21275 description: IP address
21278 example: __L3-INTERFACE-IPV6-ADDRESS__
21279 - name: resource-version
21281 description: resource-version for concurrency
21284 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
21288 summary: returns l-interface
21289 description: returns l-interface
21290 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
21296 description: successful operation
21298 $ref: "#/getDefinitions/l-interface"
21300 description: Response codes found in [response codes](https://wiki.onap.org/).
21302 - name: equipment-name
21306 example: __EQUIPMENT-NAME__
21307 - name: interface-name
21309 description: Name that identifies the physical interface
21312 example: __INTERFACE-NAME__
21313 - name: interface-name
21315 description: Name given to the interface
21318 example: __INTERFACE-NAME__
21322 summary: create or update an existing l-interface
21324 Create or update an existing l-interface.
21326 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21327 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
21336 description: Response codes found in [response codes](https://wiki.onap.org/).
21338 - name: equipment-name
21342 example: __EQUIPMENT-NAME__
21343 - name: interface-name
21345 description: Name that identifies the physical interface
21348 example: __INTERFACE-NAME__
21349 - name: interface-name
21351 description: Name given to the interface
21354 example: __INTERFACE-NAME__
21357 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
21360 $ref: "#/definitions/l-interface"
21364 summary: update an existing l-interface
21366 Update an existing l-interface
21368 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21369 The PUT operation will entirely replace an existing object.
21370 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21372 Other differences between PUT and PATCH are:
21374 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21375 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21376 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21377 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
21386 description: Response codes found in [response codes](https://wiki.onap.org/).
21388 - name: equipment-name
21392 example: __EQUIPMENT-NAME__
21393 - name: interface-name
21395 description: Name that identifies the physical interface
21398 example: __INTERFACE-NAME__
21399 - name: interface-name
21401 description: Name given to the interface
21404 example: __INTERFACE-NAME__
21407 description: l-interface object that needs to be updated.
21410 $ref: "#/patchDefinitions/l-interface"
21414 summary: delete an existing l-interface
21415 description: delete an existing l-interface
21416 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
21425 description: Response codes found in [response codes](https://wiki.onap.org/).
21427 - name: equipment-name
21431 example: __EQUIPMENT-NAME__
21432 - name: interface-name
21434 description: Name that identifies the physical interface
21437 example: __INTERFACE-NAME__
21438 - name: interface-name
21440 description: Name given to the interface
21443 example: __INTERFACE-NAME__
21444 - name: resource-version
21446 description: resource-version for concurrency
21449 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
21453 summary: returns l-interfaces
21454 description: returns l-interfaces
21455 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces
21461 description: successful operation
21463 $ref: "#/getDefinitions/l-interfaces"
21465 description: Response codes found in [response codes](https://wiki.onap.org/).
21467 - name: equipment-name
21471 example: __EQUIPMENT-NAME__
21472 - name: interface-name
21474 description: Name that identifies the physical interface
21477 example: __INTERFACE-NAME__
21478 - name: interface-name
21483 - name: interface-id
21493 - name: network-name
21498 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}:
21502 summary: returns p-interface
21503 description: returns p-interface
21504 operationId: getNetworkVplsPesVplsPePInterfacesPInterface
21510 description: successful operation
21512 $ref: "#/getDefinitions/p-interface"
21514 description: Response codes found in [response codes](https://wiki.onap.org/).
21516 - name: equipment-name
21520 example: __EQUIPMENT-NAME__
21521 - name: interface-name
21523 description: Name that identifies the physical interface
21526 example: __INTERFACE-NAME__
21530 summary: create or update an existing p-interface
21532 Create or update an existing p-interface.
21534 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21535 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface
21544 description: Response codes found in [response codes](https://wiki.onap.org/).
21546 - name: equipment-name
21550 example: __EQUIPMENT-NAME__
21551 - name: interface-name
21553 description: Name that identifies the physical interface
21556 example: __INTERFACE-NAME__
21559 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterface.json)
21562 $ref: "#/definitions/p-interface"
21566 summary: update an existing p-interface
21568 Update an existing p-interface
21570 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21571 The PUT operation will entirely replace an existing object.
21572 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21574 Other differences between PUT and PATCH are:
21576 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21577 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21578 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21579 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterface
21588 description: Response codes found in [response codes](https://wiki.onap.org/).
21590 - name: equipment-name
21594 example: __EQUIPMENT-NAME__
21595 - name: interface-name
21597 description: Name that identifies the physical interface
21600 example: __INTERFACE-NAME__
21603 description: p-interface object that needs to be updated.
21606 $ref: "#/patchDefinitions/p-interface"
21610 summary: delete an existing p-interface
21611 description: delete an existing p-interface
21612 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface
21621 description: Response codes found in [response codes](https://wiki.onap.org/).
21623 - name: equipment-name
21627 example: __EQUIPMENT-NAME__
21628 - name: interface-name
21630 description: Name that identifies the physical interface
21633 example: __INTERFACE-NAME__
21634 - name: resource-version
21636 description: resource-version for concurrency
21639 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces:
21643 summary: returns p-interfaces
21644 description: returns p-interfaces
21645 operationId: getNetworkVplsPesVplsPePInterfaces
21651 description: successful operation
21653 $ref: "#/getDefinitions/p-interfaces"
21655 description: Response codes found in [response codes](https://wiki.onap.org/).
21657 - name: equipment-name
21661 example: __EQUIPMENT-NAME__
21662 - name: interface-name
21667 - name: prov-status
21672 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
21676 summary: see node definition for valid relationships
21677 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
21686 description: Response codes found in [response codes](https://wiki.onap.org/).
21688 - name: equipment-name
21692 example: __EQUIPMENT-NAME__
21693 - name: interface-name
21695 description: Name that identifies the link aggregate interface
21698 example: __INTERFACE-NAME__
21701 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
21704 $ref: "#/definitions/relationship"
21708 summary: delete an existing relationship
21709 description: delete an existing relationship
21710 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
21719 description: Response codes found in [response codes](https://wiki.onap.org/).
21721 - name: equipment-name
21725 example: __EQUIPMENT-NAME__
21726 - name: interface-name
21728 description: Name that identifies the link aggregate interface
21731 example: __INTERFACE-NAME__
21732 /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:
21736 summary: see node definition for valid relationships
21737 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
21746 description: Response codes found in [response codes](https://wiki.onap.org/).
21748 - name: equipment-name
21752 example: __EQUIPMENT-NAME__
21753 - name: interface-name
21755 description: Name that identifies the link aggregate interface
21758 example: __INTERFACE-NAME__
21759 - name: interface-name
21761 description: Name given to the interface
21764 example: __INTERFACE-NAME__
21765 - name: vlan-interface
21767 description: String that identifies the interface
21770 example: __VLAN-INTERFACE__
21773 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
21776 $ref: "#/definitions/relationship"
21780 summary: delete an existing relationship
21781 description: delete an existing relationship
21782 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
21791 description: Response codes found in [response codes](https://wiki.onap.org/).
21793 - name: equipment-name
21797 example: __EQUIPMENT-NAME__
21798 - name: interface-name
21800 description: Name that identifies the link aggregate interface
21803 example: __INTERFACE-NAME__
21804 - name: interface-name
21806 description: Name given to the interface
21809 example: __INTERFACE-NAME__
21810 - name: vlan-interface
21812 description: String that identifies the interface
21815 example: __VLAN-INTERFACE__
21816 /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:
21820 summary: see node definition for valid relationships
21821 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
21830 description: Response codes found in [response codes](https://wiki.onap.org/).
21832 - name: equipment-name
21836 example: __EQUIPMENT-NAME__
21837 - name: interface-name
21839 description: Name that identifies the link aggregate interface
21842 example: __INTERFACE-NAME__
21843 - name: interface-name
21845 description: Name given to the interface
21848 example: __INTERFACE-NAME__
21849 - name: vlan-interface
21851 description: String that identifies the interface
21854 example: __VLAN-INTERFACE__
21855 - name: l3-interface-ipv4-address
21857 description: IP address
21860 example: __L3-INTERFACE-IPV4-ADDRESS__
21863 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
21866 $ref: "#/definitions/relationship"
21870 summary: delete an existing relationship
21871 description: delete an existing relationship
21872 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
21881 description: Response codes found in [response codes](https://wiki.onap.org/).
21883 - name: equipment-name
21887 example: __EQUIPMENT-NAME__
21888 - name: interface-name
21890 description: Name that identifies the link aggregate interface
21893 example: __INTERFACE-NAME__
21894 - name: interface-name
21896 description: Name given to the interface
21899 example: __INTERFACE-NAME__
21900 - name: vlan-interface
21902 description: String that identifies the interface
21905 example: __VLAN-INTERFACE__
21906 - name: l3-interface-ipv4-address
21908 description: IP address
21911 example: __L3-INTERFACE-IPV4-ADDRESS__
21912 /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}:
21916 summary: returns l3-interface-ipv4-address-list
21917 description: returns l3-interface-ipv4-address-list
21918 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
21924 description: successful operation
21926 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
21928 description: Response codes found in [response codes](https://wiki.onap.org/).
21930 - name: equipment-name
21934 example: __EQUIPMENT-NAME__
21935 - name: interface-name
21937 description: Name that identifies the link aggregate interface
21940 example: __INTERFACE-NAME__
21941 - name: interface-name
21943 description: Name given to the interface
21946 example: __INTERFACE-NAME__
21947 - name: vlan-interface
21949 description: String that identifies the interface
21952 example: __VLAN-INTERFACE__
21953 - name: l3-interface-ipv4-address
21955 description: IP address
21958 example: __L3-INTERFACE-IPV4-ADDRESS__
21962 summary: create or update an existing l3-interface-ipv4-address-list
21964 Create or update an existing l3-interface-ipv4-address-list.
21966 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21967 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
21976 description: Response codes found in [response codes](https://wiki.onap.org/).
21978 - name: equipment-name
21982 example: __EQUIPMENT-NAME__
21983 - name: interface-name
21985 description: Name that identifies the link aggregate interface
21988 example: __INTERFACE-NAME__
21989 - name: interface-name
21991 description: Name given to the interface
21994 example: __INTERFACE-NAME__
21995 - name: vlan-interface
21997 description: String that identifies the interface
22000 example: __VLAN-INTERFACE__
22001 - name: l3-interface-ipv4-address
22003 description: IP address
22006 example: __L3-INTERFACE-IPV4-ADDRESS__
22009 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
22012 $ref: "#/definitions/l3-interface-ipv4-address-list"
22016 summary: update an existing l3-interface-ipv4-address-list
22018 Update an existing l3-interface-ipv4-address-list
22020 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22021 The PUT operation will entirely replace an existing object.
22022 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22024 Other differences between PUT and PATCH are:
22026 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22027 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22028 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22029 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22038 description: Response codes found in [response codes](https://wiki.onap.org/).
22040 - name: equipment-name
22044 example: __EQUIPMENT-NAME__
22045 - name: interface-name
22047 description: Name that identifies the link aggregate interface
22050 example: __INTERFACE-NAME__
22051 - name: interface-name
22053 description: Name given to the interface
22056 example: __INTERFACE-NAME__
22057 - name: vlan-interface
22059 description: String that identifies the interface
22062 example: __VLAN-INTERFACE__
22063 - name: l3-interface-ipv4-address
22065 description: IP address
22068 example: __L3-INTERFACE-IPV4-ADDRESS__
22071 description: l3-interface-ipv4-address-list object that needs to be updated.
22074 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
22078 summary: delete an existing l3-interface-ipv4-address-list
22079 description: delete an existing l3-interface-ipv4-address-list
22080 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22089 description: Response codes found in [response codes](https://wiki.onap.org/).
22091 - name: equipment-name
22095 example: __EQUIPMENT-NAME__
22096 - name: interface-name
22098 description: Name that identifies the link aggregate interface
22101 example: __INTERFACE-NAME__
22102 - name: interface-name
22104 description: Name given to the interface
22107 example: __INTERFACE-NAME__
22108 - name: vlan-interface
22110 description: String that identifies the interface
22113 example: __VLAN-INTERFACE__
22114 - name: l3-interface-ipv4-address
22116 description: IP address
22119 example: __L3-INTERFACE-IPV4-ADDRESS__
22120 - name: resource-version
22122 description: resource-version for concurrency
22125 /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:
22129 summary: see node definition for valid relationships
22130 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
22139 description: Response codes found in [response codes](https://wiki.onap.org/).
22141 - name: equipment-name
22145 example: __EQUIPMENT-NAME__
22146 - name: interface-name
22148 description: Name that identifies the link aggregate interface
22151 example: __INTERFACE-NAME__
22152 - name: interface-name
22154 description: Name given to the interface
22157 example: __INTERFACE-NAME__
22158 - name: vlan-interface
22160 description: String that identifies the interface
22163 example: __VLAN-INTERFACE__
22164 - name: l3-interface-ipv6-address
22166 description: IP address
22169 example: __L3-INTERFACE-IPV6-ADDRESS__
22172 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
22175 $ref: "#/definitions/relationship"
22179 summary: delete an existing relationship
22180 description: delete an existing relationship
22181 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
22190 description: Response codes found in [response codes](https://wiki.onap.org/).
22192 - name: equipment-name
22196 example: __EQUIPMENT-NAME__
22197 - name: interface-name
22199 description: Name that identifies the link aggregate interface
22202 example: __INTERFACE-NAME__
22203 - name: interface-name
22205 description: Name given to the interface
22208 example: __INTERFACE-NAME__
22209 - name: vlan-interface
22211 description: String that identifies the interface
22214 example: __VLAN-INTERFACE__
22215 - name: l3-interface-ipv6-address
22217 description: IP address
22220 example: __L3-INTERFACE-IPV6-ADDRESS__
22221 /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}:
22225 summary: returns l3-interface-ipv6-address-list
22226 description: returns l3-interface-ipv6-address-list
22227 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22233 description: successful operation
22235 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
22237 description: Response codes found in [response codes](https://wiki.onap.org/).
22239 - name: equipment-name
22243 example: __EQUIPMENT-NAME__
22244 - name: interface-name
22246 description: Name that identifies the link aggregate interface
22249 example: __INTERFACE-NAME__
22250 - name: interface-name
22252 description: Name given to the interface
22255 example: __INTERFACE-NAME__
22256 - name: vlan-interface
22258 description: String that identifies the interface
22261 example: __VLAN-INTERFACE__
22262 - name: l3-interface-ipv6-address
22264 description: IP address
22267 example: __L3-INTERFACE-IPV6-ADDRESS__
22271 summary: create or update an existing l3-interface-ipv6-address-list
22273 Create or update an existing l3-interface-ipv6-address-list.
22275 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22276 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22285 description: Response codes found in [response codes](https://wiki.onap.org/).
22287 - name: equipment-name
22291 example: __EQUIPMENT-NAME__
22292 - name: interface-name
22294 description: Name that identifies the link aggregate interface
22297 example: __INTERFACE-NAME__
22298 - name: interface-name
22300 description: Name given to the interface
22303 example: __INTERFACE-NAME__
22304 - name: vlan-interface
22306 description: String that identifies the interface
22309 example: __VLAN-INTERFACE__
22310 - name: l3-interface-ipv6-address
22312 description: IP address
22315 example: __L3-INTERFACE-IPV6-ADDRESS__
22318 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
22321 $ref: "#/definitions/l3-interface-ipv6-address-list"
22325 summary: update an existing l3-interface-ipv6-address-list
22327 Update an existing l3-interface-ipv6-address-list
22329 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22330 The PUT operation will entirely replace an existing object.
22331 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22333 Other differences between PUT and PATCH are:
22335 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22336 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22337 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22338 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22347 description: Response codes found in [response codes](https://wiki.onap.org/).
22349 - name: equipment-name
22353 example: __EQUIPMENT-NAME__
22354 - name: interface-name
22356 description: Name that identifies the link aggregate interface
22359 example: __INTERFACE-NAME__
22360 - name: interface-name
22362 description: Name given to the interface
22365 example: __INTERFACE-NAME__
22366 - name: vlan-interface
22368 description: String that identifies the interface
22371 example: __VLAN-INTERFACE__
22372 - name: l3-interface-ipv6-address
22374 description: IP address
22377 example: __L3-INTERFACE-IPV6-ADDRESS__
22380 description: l3-interface-ipv6-address-list object that needs to be updated.
22383 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
22387 summary: delete an existing l3-interface-ipv6-address-list
22388 description: delete an existing l3-interface-ipv6-address-list
22389 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22398 description: Response codes found in [response codes](https://wiki.onap.org/).
22400 - name: equipment-name
22404 example: __EQUIPMENT-NAME__
22405 - name: interface-name
22407 description: Name that identifies the link aggregate interface
22410 example: __INTERFACE-NAME__
22411 - name: interface-name
22413 description: Name given to the interface
22416 example: __INTERFACE-NAME__
22417 - name: vlan-interface
22419 description: String that identifies the interface
22422 example: __VLAN-INTERFACE__
22423 - name: l3-interface-ipv6-address
22425 description: IP address
22428 example: __L3-INTERFACE-IPV6-ADDRESS__
22429 - name: resource-version
22431 description: resource-version for concurrency
22434 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
22438 summary: returns vlan
22439 description: returns vlan
22440 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
22446 description: successful operation
22448 $ref: "#/getDefinitions/vlan"
22450 description: Response codes found in [response codes](https://wiki.onap.org/).
22452 - name: equipment-name
22456 example: __EQUIPMENT-NAME__
22457 - name: interface-name
22459 description: Name that identifies the link aggregate interface
22462 example: __INTERFACE-NAME__
22463 - name: interface-name
22465 description: Name given to the interface
22468 example: __INTERFACE-NAME__
22469 - name: vlan-interface
22471 description: String that identifies the interface
22474 example: __VLAN-INTERFACE__
22478 summary: create or update an existing vlan
22480 Create or update an existing vlan.
22482 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22483 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
22492 description: Response codes found in [response codes](https://wiki.onap.org/).
22494 - name: equipment-name
22498 example: __EQUIPMENT-NAME__
22499 - name: interface-name
22501 description: Name that identifies the link aggregate interface
22504 example: __INTERFACE-NAME__
22505 - name: interface-name
22507 description: Name given to the interface
22510 example: __INTERFACE-NAME__
22511 - name: vlan-interface
22513 description: String that identifies the interface
22516 example: __VLAN-INTERFACE__
22519 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
22522 $ref: "#/definitions/vlan"
22526 summary: update an existing vlan
22528 Update an existing vlan
22530 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22531 The PUT operation will entirely replace an existing object.
22532 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22534 Other differences between PUT and PATCH are:
22536 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22537 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22538 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22539 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
22548 description: Response codes found in [response codes](https://wiki.onap.org/).
22550 - name: equipment-name
22554 example: __EQUIPMENT-NAME__
22555 - name: interface-name
22557 description: Name that identifies the link aggregate interface
22560 example: __INTERFACE-NAME__
22561 - name: interface-name
22563 description: Name given to the interface
22566 example: __INTERFACE-NAME__
22567 - name: vlan-interface
22569 description: String that identifies the interface
22572 example: __VLAN-INTERFACE__
22575 description: vlan object that needs to be updated.
22578 $ref: "#/patchDefinitions/vlan"
22582 summary: delete an existing vlan
22583 description: delete an existing vlan
22584 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
22593 description: Response codes found in [response codes](https://wiki.onap.org/).
22595 - name: equipment-name
22599 example: __EQUIPMENT-NAME__
22600 - name: interface-name
22602 description: Name that identifies the link aggregate interface
22605 example: __INTERFACE-NAME__
22606 - name: interface-name
22608 description: Name given to the interface
22611 example: __INTERFACE-NAME__
22612 - name: vlan-interface
22614 description: String that identifies the interface
22617 example: __VLAN-INTERFACE__
22618 - name: resource-version
22620 description: resource-version for concurrency
22623 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
22627 summary: returns vlans
22628 description: returns vlans
22629 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
22635 description: successful operation
22637 $ref: "#/getDefinitions/vlans"
22639 description: Response codes found in [response codes](https://wiki.onap.org/).
22641 - name: equipment-name
22645 example: __EQUIPMENT-NAME__
22646 - name: interface-name
22648 description: Name that identifies the link aggregate interface
22651 example: __INTERFACE-NAME__
22652 - name: interface-name
22654 description: Name given to the interface
22657 example: __INTERFACE-NAME__
22658 - name: vlan-interface
22663 - name: vlan-id-inner
22674 /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:
22678 summary: see node definition for valid relationships
22679 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
22688 description: Response codes found in [response codes](https://wiki.onap.org/).
22690 - name: equipment-name
22694 example: __EQUIPMENT-NAME__
22695 - name: interface-name
22697 description: Name that identifies the link aggregate interface
22700 example: __INTERFACE-NAME__
22701 - name: interface-name
22703 description: Name given to the interface
22706 example: __INTERFACE-NAME__
22709 description: PCI ID used to identify the sriov-vf
22712 example: __PCI-ID__
22715 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
22718 $ref: "#/definitions/relationship"
22722 summary: delete an existing relationship
22723 description: delete an existing relationship
22724 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
22733 description: Response codes found in [response codes](https://wiki.onap.org/).
22735 - name: equipment-name
22739 example: __EQUIPMENT-NAME__
22740 - name: interface-name
22742 description: Name that identifies the link aggregate interface
22745 example: __INTERFACE-NAME__
22746 - name: interface-name
22748 description: Name given to the interface
22751 example: __INTERFACE-NAME__
22754 description: PCI ID used to identify the sriov-vf
22757 example: __PCI-ID__
22758 /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}:
22762 summary: returns sriov-vf
22763 description: returns sriov-vf
22764 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
22770 description: successful operation
22772 $ref: "#/getDefinitions/sriov-vf"
22774 description: Response codes found in [response codes](https://wiki.onap.org/).
22776 - name: equipment-name
22780 example: __EQUIPMENT-NAME__
22781 - name: interface-name
22783 description: Name that identifies the link aggregate interface
22786 example: __INTERFACE-NAME__
22787 - name: interface-name
22789 description: Name given to the interface
22792 example: __INTERFACE-NAME__
22795 description: PCI ID used to identify the sriov-vf
22798 example: __PCI-ID__
22802 summary: create or update an existing sriov-vf
22804 Create or update an existing sriov-vf.
22806 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22807 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
22816 description: Response codes found in [response codes](https://wiki.onap.org/).
22818 - name: equipment-name
22822 example: __EQUIPMENT-NAME__
22823 - name: interface-name
22825 description: Name that identifies the link aggregate interface
22828 example: __INTERFACE-NAME__
22829 - name: interface-name
22831 description: Name given to the interface
22834 example: __INTERFACE-NAME__
22837 description: PCI ID used to identify the sriov-vf
22840 example: __PCI-ID__
22843 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
22846 $ref: "#/definitions/sriov-vf"
22850 summary: update an existing sriov-vf
22852 Update an existing sriov-vf
22854 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22855 The PUT operation will entirely replace an existing object.
22856 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22858 Other differences between PUT and PATCH are:
22860 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22861 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22862 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22863 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
22872 description: Response codes found in [response codes](https://wiki.onap.org/).
22874 - name: equipment-name
22878 example: __EQUIPMENT-NAME__
22879 - name: interface-name
22881 description: Name that identifies the link aggregate interface
22884 example: __INTERFACE-NAME__
22885 - name: interface-name
22887 description: Name given to the interface
22890 example: __INTERFACE-NAME__
22893 description: PCI ID used to identify the sriov-vf
22896 example: __PCI-ID__
22899 description: sriov-vf object that needs to be updated.
22902 $ref: "#/patchDefinitions/sriov-vf"
22906 summary: delete an existing sriov-vf
22907 description: delete an existing sriov-vf
22908 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
22917 description: Response codes found in [response codes](https://wiki.onap.org/).
22919 - name: equipment-name
22923 example: __EQUIPMENT-NAME__
22924 - name: interface-name
22926 description: Name that identifies the link aggregate interface
22929 example: __INTERFACE-NAME__
22930 - name: interface-name
22932 description: Name given to the interface
22935 example: __INTERFACE-NAME__
22938 description: PCI ID used to identify the sriov-vf
22941 example: __PCI-ID__
22942 - name: resource-version
22944 description: resource-version for concurrency
22947 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
22951 summary: returns sriov-vfs
22952 description: returns sriov-vfs
22953 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
22959 description: successful operation
22961 $ref: "#/getDefinitions/sriov-vfs"
22963 description: Response codes found in [response codes](https://wiki.onap.org/).
22965 - name: equipment-name
22969 example: __EQUIPMENT-NAME__
22970 - name: interface-name
22972 description: Name that identifies the link aggregate interface
22975 example: __INTERFACE-NAME__
22976 - name: interface-name
22978 description: Name given to the interface
22981 example: __INTERFACE-NAME__
22987 - name: vf-vlan-filter
22992 - name: vf-mac-filter
22997 - name: vf-vlan-strip
23002 - name: neutron-network-id
23007 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
23011 summary: see node definition for valid relationships
23012 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
23021 description: Response codes found in [response codes](https://wiki.onap.org/).
23023 - name: equipment-name
23027 example: __EQUIPMENT-NAME__
23028 - name: interface-name
23030 description: Name that identifies the link aggregate interface
23033 example: __INTERFACE-NAME__
23034 - name: interface-name
23036 description: Name given to the interface
23039 example: __INTERFACE-NAME__
23042 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
23045 $ref: "#/definitions/relationship"
23049 summary: delete an existing relationship
23050 description: delete an existing relationship
23051 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
23060 description: Response codes found in [response codes](https://wiki.onap.org/).
23062 - name: equipment-name
23066 example: __EQUIPMENT-NAME__
23067 - name: interface-name
23069 description: Name that identifies the link aggregate interface
23072 example: __INTERFACE-NAME__
23073 - name: interface-name
23075 description: Name given to the interface
23078 example: __INTERFACE-NAME__
23079 /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:
23083 summary: see node definition for valid relationships
23084 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
23093 description: Response codes found in [response codes](https://wiki.onap.org/).
23095 - name: equipment-name
23099 example: __EQUIPMENT-NAME__
23100 - name: interface-name
23102 description: Name that identifies the link aggregate interface
23105 example: __INTERFACE-NAME__
23106 - name: interface-name
23108 description: Name given to the interface
23111 example: __INTERFACE-NAME__
23112 - name: l3-interface-ipv4-address
23114 description: IP address
23117 example: __L3-INTERFACE-IPV4-ADDRESS__
23120 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
23123 $ref: "#/definitions/relationship"
23127 summary: delete an existing relationship
23128 description: delete an existing relationship
23129 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
23138 description: Response codes found in [response codes](https://wiki.onap.org/).
23140 - name: equipment-name
23144 example: __EQUIPMENT-NAME__
23145 - name: interface-name
23147 description: Name that identifies the link aggregate interface
23150 example: __INTERFACE-NAME__
23151 - name: interface-name
23153 description: Name given to the interface
23156 example: __INTERFACE-NAME__
23157 - name: l3-interface-ipv4-address
23159 description: IP address
23162 example: __L3-INTERFACE-IPV4-ADDRESS__
23163 /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}:
23167 summary: returns l3-interface-ipv4-address-list
23168 description: returns l3-interface-ipv4-address-list
23169 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23175 description: successful operation
23177 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
23179 description: Response codes found in [response codes](https://wiki.onap.org/).
23181 - name: equipment-name
23185 example: __EQUIPMENT-NAME__
23186 - name: interface-name
23188 description: Name that identifies the link aggregate interface
23191 example: __INTERFACE-NAME__
23192 - name: interface-name
23194 description: Name given to the interface
23197 example: __INTERFACE-NAME__
23198 - name: l3-interface-ipv4-address
23200 description: IP address
23203 example: __L3-INTERFACE-IPV4-ADDRESS__
23207 summary: create or update an existing l3-interface-ipv4-address-list
23209 Create or update an existing l3-interface-ipv4-address-list.
23211 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23212 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23221 description: Response codes found in [response codes](https://wiki.onap.org/).
23223 - name: equipment-name
23227 example: __EQUIPMENT-NAME__
23228 - name: interface-name
23230 description: Name that identifies the link aggregate interface
23233 example: __INTERFACE-NAME__
23234 - name: interface-name
23236 description: Name given to the interface
23239 example: __INTERFACE-NAME__
23240 - name: l3-interface-ipv4-address
23242 description: IP address
23245 example: __L3-INTERFACE-IPV4-ADDRESS__
23248 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
23251 $ref: "#/definitions/l3-interface-ipv4-address-list"
23255 summary: update an existing l3-interface-ipv4-address-list
23257 Update an existing l3-interface-ipv4-address-list
23259 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23260 The PUT operation will entirely replace an existing object.
23261 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23263 Other differences between PUT and PATCH are:
23265 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23266 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23267 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23268 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23277 description: Response codes found in [response codes](https://wiki.onap.org/).
23279 - name: equipment-name
23283 example: __EQUIPMENT-NAME__
23284 - name: interface-name
23286 description: Name that identifies the link aggregate interface
23289 example: __INTERFACE-NAME__
23290 - name: interface-name
23292 description: Name given to the interface
23295 example: __INTERFACE-NAME__
23296 - name: l3-interface-ipv4-address
23298 description: IP address
23301 example: __L3-INTERFACE-IPV4-ADDRESS__
23304 description: l3-interface-ipv4-address-list object that needs to be updated.
23307 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
23311 summary: delete an existing l3-interface-ipv4-address-list
23312 description: delete an existing l3-interface-ipv4-address-list
23313 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23322 description: Response codes found in [response codes](https://wiki.onap.org/).
23324 - name: equipment-name
23328 example: __EQUIPMENT-NAME__
23329 - name: interface-name
23331 description: Name that identifies the link aggregate interface
23334 example: __INTERFACE-NAME__
23335 - name: interface-name
23337 description: Name given to the interface
23340 example: __INTERFACE-NAME__
23341 - name: l3-interface-ipv4-address
23343 description: IP address
23346 example: __L3-INTERFACE-IPV4-ADDRESS__
23347 - name: resource-version
23349 description: resource-version for concurrency
23352 /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:
23356 summary: see node definition for valid relationships
23357 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
23366 description: Response codes found in [response codes](https://wiki.onap.org/).
23368 - name: equipment-name
23372 example: __EQUIPMENT-NAME__
23373 - name: interface-name
23375 description: Name that identifies the link aggregate interface
23378 example: __INTERFACE-NAME__
23379 - name: interface-name
23381 description: Name given to the interface
23384 example: __INTERFACE-NAME__
23385 - name: l3-interface-ipv6-address
23387 description: IP address
23390 example: __L3-INTERFACE-IPV6-ADDRESS__
23393 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
23396 $ref: "#/definitions/relationship"
23400 summary: delete an existing relationship
23401 description: delete an existing relationship
23402 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
23411 description: Response codes found in [response codes](https://wiki.onap.org/).
23413 - name: equipment-name
23417 example: __EQUIPMENT-NAME__
23418 - name: interface-name
23420 description: Name that identifies the link aggregate interface
23423 example: __INTERFACE-NAME__
23424 - name: interface-name
23426 description: Name given to the interface
23429 example: __INTERFACE-NAME__
23430 - name: l3-interface-ipv6-address
23432 description: IP address
23435 example: __L3-INTERFACE-IPV6-ADDRESS__
23436 /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}:
23440 summary: returns l3-interface-ipv6-address-list
23441 description: returns l3-interface-ipv6-address-list
23442 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23448 description: successful operation
23450 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
23452 description: Response codes found in [response codes](https://wiki.onap.org/).
23454 - name: equipment-name
23458 example: __EQUIPMENT-NAME__
23459 - name: interface-name
23461 description: Name that identifies the link aggregate interface
23464 example: __INTERFACE-NAME__
23465 - name: interface-name
23467 description: Name given to the interface
23470 example: __INTERFACE-NAME__
23471 - name: l3-interface-ipv6-address
23473 description: IP address
23476 example: __L3-INTERFACE-IPV6-ADDRESS__
23480 summary: create or update an existing l3-interface-ipv6-address-list
23482 Create or update an existing l3-interface-ipv6-address-list.
23484 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23485 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23494 description: Response codes found in [response codes](https://wiki.onap.org/).
23496 - name: equipment-name
23500 example: __EQUIPMENT-NAME__
23501 - name: interface-name
23503 description: Name that identifies the link aggregate interface
23506 example: __INTERFACE-NAME__
23507 - name: interface-name
23509 description: Name given to the interface
23512 example: __INTERFACE-NAME__
23513 - name: l3-interface-ipv6-address
23515 description: IP address
23518 example: __L3-INTERFACE-IPV6-ADDRESS__
23521 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
23524 $ref: "#/definitions/l3-interface-ipv6-address-list"
23528 summary: update an existing l3-interface-ipv6-address-list
23530 Update an existing l3-interface-ipv6-address-list
23532 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23533 The PUT operation will entirely replace an existing object.
23534 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23536 Other differences between PUT and PATCH are:
23538 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23539 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23540 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23541 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23550 description: Response codes found in [response codes](https://wiki.onap.org/).
23552 - name: equipment-name
23556 example: __EQUIPMENT-NAME__
23557 - name: interface-name
23559 description: Name that identifies the link aggregate interface
23562 example: __INTERFACE-NAME__
23563 - name: interface-name
23565 description: Name given to the interface
23568 example: __INTERFACE-NAME__
23569 - name: l3-interface-ipv6-address
23571 description: IP address
23574 example: __L3-INTERFACE-IPV6-ADDRESS__
23577 description: l3-interface-ipv6-address-list object that needs to be updated.
23580 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
23584 summary: delete an existing l3-interface-ipv6-address-list
23585 description: delete an existing l3-interface-ipv6-address-list
23586 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23595 description: Response codes found in [response codes](https://wiki.onap.org/).
23597 - name: equipment-name
23601 example: __EQUIPMENT-NAME__
23602 - name: interface-name
23604 description: Name that identifies the link aggregate interface
23607 example: __INTERFACE-NAME__
23608 - name: interface-name
23610 description: Name given to the interface
23613 example: __INTERFACE-NAME__
23614 - name: l3-interface-ipv6-address
23616 description: IP address
23619 example: __L3-INTERFACE-IPV6-ADDRESS__
23620 - name: resource-version
23622 description: resource-version for concurrency
23625 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
23629 summary: returns l-interface
23630 description: returns l-interface
23631 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
23637 description: successful operation
23639 $ref: "#/getDefinitions/l-interface"
23641 description: Response codes found in [response codes](https://wiki.onap.org/).
23643 - name: equipment-name
23647 example: __EQUIPMENT-NAME__
23648 - name: interface-name
23650 description: Name that identifies the link aggregate interface
23653 example: __INTERFACE-NAME__
23654 - name: interface-name
23656 description: Name given to the interface
23659 example: __INTERFACE-NAME__
23663 summary: create or update an existing l-interface
23665 Create or update an existing l-interface.
23667 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23668 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
23677 description: Response codes found in [response codes](https://wiki.onap.org/).
23679 - name: equipment-name
23683 example: __EQUIPMENT-NAME__
23684 - name: interface-name
23686 description: Name that identifies the link aggregate interface
23689 example: __INTERFACE-NAME__
23690 - name: interface-name
23692 description: Name given to the interface
23695 example: __INTERFACE-NAME__
23698 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
23701 $ref: "#/definitions/l-interface"
23705 summary: update an existing l-interface
23707 Update an existing l-interface
23709 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23710 The PUT operation will entirely replace an existing object.
23711 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23713 Other differences between PUT and PATCH are:
23715 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23716 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23717 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23718 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
23727 description: Response codes found in [response codes](https://wiki.onap.org/).
23729 - name: equipment-name
23733 example: __EQUIPMENT-NAME__
23734 - name: interface-name
23736 description: Name that identifies the link aggregate interface
23739 example: __INTERFACE-NAME__
23740 - name: interface-name
23742 description: Name given to the interface
23745 example: __INTERFACE-NAME__
23748 description: l-interface object that needs to be updated.
23751 $ref: "#/patchDefinitions/l-interface"
23755 summary: delete an existing l-interface
23756 description: delete an existing l-interface
23757 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
23766 description: Response codes found in [response codes](https://wiki.onap.org/).
23768 - name: equipment-name
23772 example: __EQUIPMENT-NAME__
23773 - name: interface-name
23775 description: Name that identifies the link aggregate interface
23778 example: __INTERFACE-NAME__
23779 - name: interface-name
23781 description: Name given to the interface
23784 example: __INTERFACE-NAME__
23785 - name: resource-version
23787 description: resource-version for concurrency
23790 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
23794 summary: returns l-interfaces
23795 description: returns l-interfaces
23796 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces
23802 description: successful operation
23804 $ref: "#/getDefinitions/l-interfaces"
23806 description: Response codes found in [response codes](https://wiki.onap.org/).
23808 - name: equipment-name
23812 example: __EQUIPMENT-NAME__
23813 - name: interface-name
23815 description: Name that identifies the link aggregate interface
23818 example: __INTERFACE-NAME__
23819 - name: interface-name
23824 - name: interface-id
23834 - name: network-name
23839 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}:
23843 summary: returns lag-interface
23844 description: returns lag-interface
23845 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface
23851 description: successful operation
23853 $ref: "#/getDefinitions/lag-interface"
23855 description: Response codes found in [response codes](https://wiki.onap.org/).
23857 - name: equipment-name
23861 example: __EQUIPMENT-NAME__
23862 - name: interface-name
23864 description: Name that identifies the link aggregate interface
23867 example: __INTERFACE-NAME__
23871 summary: create or update an existing lag-interface
23873 Create or update an existing lag-interface.
23875 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23876 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
23885 description: Response codes found in [response codes](https://wiki.onap.org/).
23887 - name: equipment-name
23891 example: __EQUIPMENT-NAME__
23892 - name: interface-name
23894 description: Name that identifies the link aggregate interface
23897 example: __INTERFACE-NAME__
23900 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
23903 $ref: "#/definitions/lag-interface"
23907 summary: update an existing lag-interface
23909 Update an existing lag-interface
23911 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23912 The PUT operation will entirely replace an existing object.
23913 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23915 Other differences between PUT and PATCH are:
23917 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23918 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23919 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23920 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
23929 description: Response codes found in [response codes](https://wiki.onap.org/).
23931 - name: equipment-name
23935 example: __EQUIPMENT-NAME__
23936 - name: interface-name
23938 description: Name that identifies the link aggregate interface
23941 example: __INTERFACE-NAME__
23944 description: lag-interface object that needs to be updated.
23947 $ref: "#/patchDefinitions/lag-interface"
23951 summary: delete an existing lag-interface
23952 description: delete an existing lag-interface
23953 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface
23962 description: Response codes found in [response codes](https://wiki.onap.org/).
23964 - name: equipment-name
23968 example: __EQUIPMENT-NAME__
23969 - name: interface-name
23971 description: Name that identifies the link aggregate interface
23974 example: __INTERFACE-NAME__
23975 - name: resource-version
23977 description: resource-version for concurrency
23980 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces:
23984 summary: returns lag-interfaces
23985 description: returns lag-interfaces
23986 operationId: getNetworkVplsPesVplsPeLagInterfaces
23992 description: successful operation
23994 $ref: "#/getDefinitions/lag-interfaces"
23996 description: Response codes found in [response codes](https://wiki.onap.org/).
23998 - name: equipment-name
24002 example: __EQUIPMENT-NAME__
24003 - name: interface-name
24008 - name: interface-id
24013 - name: interface-role
24018 /network/vpls-pes/vpls-pe/{equipment-name}:
24022 summary: returns vpls-pe
24023 description: returns vpls-pe
24024 operationId: getNetworkVplsPesVplsPe
24030 description: successful operation
24032 $ref: "#/getDefinitions/vpls-pe"
24034 description: Response codes found in [response codes](https://wiki.onap.org/).
24036 - name: equipment-name
24040 example: __EQUIPMENT-NAME__
24044 summary: create or update an existing vpls-pe
24046 Create or update an existing vpls-pe.
24048 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24049 operationId: createOrUpdateNetworkVplsPesVplsPe
24058 description: Response codes found in [response codes](https://wiki.onap.org/).
24060 - name: equipment-name
24064 example: __EQUIPMENT-NAME__
24067 description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPe.json)
24070 $ref: "#/definitions/vpls-pe"
24074 summary: update an existing vpls-pe
24076 Update an existing vpls-pe
24078 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24079 The PUT operation will entirely replace an existing object.
24080 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24082 Other differences between PUT and PATCH are:
24084 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24085 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24086 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24087 operationId: UpdateNetworkVplsPesVplsPe
24096 description: Response codes found in [response codes](https://wiki.onap.org/).
24098 - name: equipment-name
24102 example: __EQUIPMENT-NAME__
24105 description: vpls-pe object that needs to be updated.
24108 $ref: "#/patchDefinitions/vpls-pe"
24112 summary: delete an existing vpls-pe
24113 description: delete an existing vpls-pe
24114 operationId: deleteNetworkVplsPesVplsPe
24123 description: Response codes found in [response codes](https://wiki.onap.org/).
24125 - name: equipment-name
24129 example: __EQUIPMENT-NAME__
24130 - name: resource-version
24132 description: resource-version for concurrency
24139 summary: returns vpls-pes
24140 description: returns vpls-pes
24141 operationId: getNetworkVplsPes
24147 description: successful operation
24149 $ref: "#/getDefinitions/vpls-pes"
24151 description: Response codes found in [response codes](https://wiki.onap.org/).
24153 - name: equipment-name
24158 - name: prov-status
24163 /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
24167 summary: see node definition for valid relationships
24168 operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
24177 description: Response codes found in [response codes](https://wiki.onap.org/).
24179 - name: multicast-configuration-id
24181 description: Unique id of multicast configuration.
24184 example: __MULTICAST-CONFIGURATION-ID__
24187 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkMulticastConfigurationsMulticastConfiguration.json)
24190 $ref: "#/definitions/relationship"
24194 summary: delete an existing relationship
24195 description: delete an existing relationship
24196 operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
24205 description: Response codes found in [response codes](https://wiki.onap.org/).
24207 - name: multicast-configuration-id
24209 description: Unique id of multicast configuration.
24212 example: __MULTICAST-CONFIGURATION-ID__
24213 /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}:
24217 summary: returns multicast-configuration
24218 description: returns multicast-configuration
24219 operationId: getNetworkMulticastConfigurationsMulticastConfiguration
24225 description: successful operation
24227 $ref: "#/getDefinitions/multicast-configuration"
24229 description: Response codes found in [response codes](https://wiki.onap.org/).
24231 - name: multicast-configuration-id
24233 description: Unique id of multicast configuration.
24236 example: __MULTICAST-CONFIGURATION-ID__
24240 summary: create or update an existing multicast-configuration
24242 Create or update an existing multicast-configuration.
24244 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24245 operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration
24254 description: Response codes found in [response codes](https://wiki.onap.org/).
24256 - name: multicast-configuration-id
24258 description: Unique id of multicast configuration.
24261 example: __MULTICAST-CONFIGURATION-ID__
24264 description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkMulticastConfigurationsMulticastConfiguration.json)
24267 $ref: "#/definitions/multicast-configuration"
24271 summary: update an existing multicast-configuration
24273 Update an existing multicast-configuration
24275 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24276 The PUT operation will entirely replace an existing object.
24277 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24279 Other differences between PUT and PATCH are:
24281 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24282 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24283 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24284 operationId: UpdateNetworkMulticastConfigurationsMulticastConfiguration
24293 description: Response codes found in [response codes](https://wiki.onap.org/).
24295 - name: multicast-configuration-id
24297 description: Unique id of multicast configuration.
24300 example: __MULTICAST-CONFIGURATION-ID__
24303 description: multicast-configuration object that needs to be updated.
24306 $ref: "#/patchDefinitions/multicast-configuration"
24310 summary: delete an existing multicast-configuration
24311 description: delete an existing multicast-configuration
24312 operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration
24321 description: Response codes found in [response codes](https://wiki.onap.org/).
24323 - name: multicast-configuration-id
24325 description: Unique id of multicast configuration.
24328 example: __MULTICAST-CONFIGURATION-ID__
24329 - name: resource-version
24331 description: resource-version for concurrency
24334 /network/multicast-configurations:
24338 summary: returns multicast-configurations
24339 description: returns multicast-configurations
24340 operationId: getNetworkMulticastConfigurations
24346 description: successful operation
24348 $ref: "#/getDefinitions/multicast-configurations"
24350 description: Response codes found in [response codes](https://wiki.onap.org/).
24352 - name: multicast-configuration-id
24357 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship:
24361 summary: see node definition for valid relationships
24362 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
24371 description: Response codes found in [response codes](https://wiki.onap.org/).
24375 description: Unique id of VNF. This is unique across the graph.
24378 example: __VNF-ID__
24379 - name: interface-id
24381 description: Unique ID of the interface
24384 example: __INTERFACE-ID__
24387 description: See mis-na-virtualization-platform.yang
24391 example: __CVLAN-TAG__
24394 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
24397 $ref: "#/definitions/relationship"
24401 summary: delete an existing relationship
24402 description: delete an existing relationship
24403 operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
24412 description: Response codes found in [response codes](https://wiki.onap.org/).
24416 description: Unique id of VNF. This is unique across the graph.
24419 example: __VNF-ID__
24420 - name: interface-id
24422 description: Unique ID of the interface
24425 example: __INTERFACE-ID__
24428 description: See mis-na-virtualization-platform.yang
24432 example: __CVLAN-TAG__
24433 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
24437 summary: returns cvlan-tag-entry
24438 description: returns cvlan-tag-entry
24439 operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
24445 description: successful operation
24447 $ref: "#/getDefinitions/cvlan-tag-entry"
24449 description: Response codes found in [response codes](https://wiki.onap.org/).
24453 description: Unique id of VNF. This is unique across the graph.
24456 example: __VNF-ID__
24457 - name: interface-id
24459 description: Unique ID of the interface
24462 example: __INTERFACE-ID__
24465 description: See mis-na-virtualization-platform.yang
24469 example: __CVLAN-TAG__
24473 summary: create or update an existing cvlan-tag-entry
24475 Create or update an existing cvlan-tag-entry.
24477 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24478 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
24487 description: Response codes found in [response codes](https://wiki.onap.org/).
24491 description: Unique id of VNF. This is unique across the graph.
24494 example: __VNF-ID__
24495 - name: interface-id
24497 description: Unique ID of the interface
24500 example: __INTERFACE-ID__
24503 description: See mis-na-virtualization-platform.yang
24507 example: __CVLAN-TAG__
24510 description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
24513 $ref: "#/definitions/cvlan-tag-entry"
24517 summary: update an existing cvlan-tag-entry
24519 Update an existing cvlan-tag-entry
24521 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24522 The PUT operation will entirely replace an existing object.
24523 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24525 Other differences between PUT and PATCH are:
24527 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24528 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24529 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24530 operationId: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
24539 description: Response codes found in [response codes](https://wiki.onap.org/).
24543 description: Unique id of VNF. This is unique across the graph.
24546 example: __VNF-ID__
24547 - name: interface-id
24549 description: Unique ID of the interface
24552 example: __INTERFACE-ID__
24555 description: See mis-na-virtualization-platform.yang
24559 example: __CVLAN-TAG__
24562 description: cvlan-tag-entry object that needs to be updated.
24565 $ref: "#/patchDefinitions/cvlan-tag-entry"
24569 summary: delete an existing cvlan-tag-entry
24570 description: delete an existing cvlan-tag-entry
24571 operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
24580 description: Response codes found in [response codes](https://wiki.onap.org/).
24584 description: Unique id of VNF. This is unique across the graph.
24587 example: __VNF-ID__
24588 - name: interface-id
24590 description: Unique ID of the interface
24593 example: __INTERFACE-ID__
24596 description: See mis-na-virtualization-platform.yang
24600 example: __CVLAN-TAG__
24601 - name: resource-version
24603 description: resource-version for concurrency
24606 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags:
24610 summary: returns cvlan-tags
24611 description: returns cvlan-tags
24612 operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags
24618 description: successful operation
24620 $ref: "#/getDefinitions/cvlan-tags"
24622 description: Response codes found in [response codes](https://wiki.onap.org/).
24626 description: Unique id of VNF. This is unique across the graph.
24629 example: __VNF-ID__
24630 - name: interface-id
24632 description: Unique ID of the interface
24635 example: __INTERFACE-ID__
24642 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
24646 summary: see node definition for valid relationships
24647 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
24656 description: Response codes found in [response codes](https://wiki.onap.org/).
24660 description: Unique id of VNF. This is unique across the graph.
24663 example: __VNF-ID__
24664 - name: interface-id
24666 description: Unique ID of the interface
24669 example: __INTERFACE-ID__
24672 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVcePortGroupsPortGroup.json)
24675 $ref: "#/definitions/relationship"
24679 summary: delete an existing relationship
24680 description: delete an existing relationship
24681 operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
24690 description: Response codes found in [response codes](https://wiki.onap.org/).
24694 description: Unique id of VNF. This is unique across the graph.
24697 example: __VNF-ID__
24698 - name: interface-id
24700 description: Unique ID of the interface
24703 example: __INTERFACE-ID__
24704 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
24708 summary: returns port-group
24709 description: returns port-group
24710 operationId: getNetworkVcesVcePortGroupsPortGroup
24716 description: successful operation
24718 $ref: "#/getDefinitions/port-group"
24720 description: Response codes found in [response codes](https://wiki.onap.org/).
24724 description: Unique id of VNF. This is unique across the graph.
24727 example: __VNF-ID__
24728 - name: interface-id
24730 description: Unique ID of the interface
24733 example: __INTERFACE-ID__
24737 summary: create or update an existing port-group
24739 Create or update an existing port-group.
24741 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24742 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
24751 description: Response codes found in [response codes](https://wiki.onap.org/).
24755 description: Unique id of VNF. This is unique across the graph.
24758 example: __VNF-ID__
24759 - name: interface-id
24761 description: Unique ID of the interface
24764 example: __INTERFACE-ID__
24767 description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVcePortGroupsPortGroup.json)
24770 $ref: "#/definitions/port-group"
24774 summary: update an existing port-group
24776 Update an existing port-group
24778 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24779 The PUT operation will entirely replace an existing object.
24780 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24782 Other differences between PUT and PATCH are:
24784 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24785 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24786 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24787 operationId: UpdateNetworkVcesVcePortGroupsPortGroup
24796 description: Response codes found in [response codes](https://wiki.onap.org/).
24800 description: Unique id of VNF. This is unique across the graph.
24803 example: __VNF-ID__
24804 - name: interface-id
24806 description: Unique ID of the interface
24809 example: __INTERFACE-ID__
24812 description: port-group object that needs to be updated.
24815 $ref: "#/patchDefinitions/port-group"
24819 summary: delete an existing port-group
24820 description: delete an existing port-group
24821 operationId: deleteNetworkVcesVcePortGroupsPortGroup
24830 description: Response codes found in [response codes](https://wiki.onap.org/).
24834 description: Unique id of VNF. This is unique across the graph.
24837 example: __VNF-ID__
24838 - name: interface-id
24840 description: Unique ID of the interface
24843 example: __INTERFACE-ID__
24844 - name: resource-version
24846 description: resource-version for concurrency
24849 /network/vces/vce/{vnf-id}/port-groups:
24853 summary: returns port-groups
24854 description: returns port-groups
24855 operationId: getNetworkVcesVcePortGroups
24861 description: successful operation
24863 $ref: "#/getDefinitions/port-groups"
24865 description: Response codes found in [response codes](https://wiki.onap.org/).
24869 description: Unique id of VNF. This is unique across the graph.
24872 example: __VNF-ID__
24873 - name: interface-id
24878 - name: port-group-id
24883 - name: switch-name
24888 - name: heat-stack-id
24893 /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
24897 summary: see node definition for valid relationships
24898 operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship
24907 description: Response codes found in [response codes](https://wiki.onap.org/).
24911 description: Unique id of VNF. This is unique across the graph.
24914 example: __VNF-ID__
24917 description: Unique ID for the license group the resource belongs to, should be uuid.
24920 example: __GROUP-UUID__
24921 - name: resource-uuid
24923 description: Unique ID of a license resource.
24926 example: __RESOURCE-UUID__
24929 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVceLicensesLicense.json)
24932 $ref: "#/definitions/relationship"
24936 summary: delete an existing relationship
24937 description: delete an existing relationship
24938 operationId: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship
24947 description: Response codes found in [response codes](https://wiki.onap.org/).
24951 description: Unique id of VNF. This is unique across the graph.
24954 example: __VNF-ID__
24957 description: Unique ID for the license group the resource belongs to, should be uuid.
24960 example: __GROUP-UUID__
24961 - name: resource-uuid
24963 description: Unique ID of a license resource.
24966 example: __RESOURCE-UUID__
24967 /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
24971 summary: returns license
24972 description: returns license
24973 operationId: getNetworkVcesVceLicensesLicense
24979 description: successful operation
24981 $ref: "#/getDefinitions/license"
24983 description: Response codes found in [response codes](https://wiki.onap.org/).
24987 description: Unique id of VNF. This is unique across the graph.
24990 example: __VNF-ID__
24993 description: Unique ID for the license group the resource belongs to, should be uuid.
24996 example: __GROUP-UUID__
24997 - name: resource-uuid
24999 description: Unique ID of a license resource.
25002 example: __RESOURCE-UUID__
25006 summary: create or update an existing license
25008 Create or update an existing license.
25010 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25011 operationId: createOrUpdateNetworkVcesVceLicensesLicense
25020 description: Response codes found in [response codes](https://wiki.onap.org/).
25024 description: Unique id of VNF. This is unique across the graph.
25027 example: __VNF-ID__
25030 description: Unique ID for the license group the resource belongs to, should be uuid.
25033 example: __GROUP-UUID__
25034 - name: resource-uuid
25036 description: Unique ID of a license resource.
25039 example: __RESOURCE-UUID__
25042 description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVceLicensesLicense.json)
25045 $ref: "#/definitions/license"
25049 summary: update an existing license
25051 Update an existing license
25053 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25054 The PUT operation will entirely replace an existing object.
25055 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25057 Other differences between PUT and PATCH are:
25059 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25060 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25061 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25062 operationId: UpdateNetworkVcesVceLicensesLicense
25071 description: Response codes found in [response codes](https://wiki.onap.org/).
25075 description: Unique id of VNF. This is unique across the graph.
25078 example: __VNF-ID__
25081 description: Unique ID for the license group the resource belongs to, should be uuid.
25084 example: __GROUP-UUID__
25085 - name: resource-uuid
25087 description: Unique ID of a license resource.
25090 example: __RESOURCE-UUID__
25093 description: license object that needs to be updated.
25096 $ref: "#/patchDefinitions/license"
25100 summary: delete an existing license
25101 description: delete an existing license
25102 operationId: deleteNetworkVcesVceLicensesLicense
25111 description: Response codes found in [response codes](https://wiki.onap.org/).
25115 description: Unique id of VNF. This is unique across the graph.
25118 example: __VNF-ID__
25121 description: Unique ID for the license group the resource belongs to, should be uuid.
25124 example: __GROUP-UUID__
25125 - name: resource-uuid
25127 description: Unique ID of a license resource.
25130 example: __RESOURCE-UUID__
25131 - name: resource-version
25133 description: resource-version for concurrency
25136 /network/vces/vce/{vnf-id}/licenses:
25140 summary: returns licenses
25141 description: returns licenses
25142 operationId: getNetworkVcesVceLicenses
25148 description: successful operation
25150 $ref: "#/getDefinitions/licenses"
25152 description: Response codes found in [response codes](https://wiki.onap.org/).
25156 description: Unique id of VNF. This is unique across the graph.
25159 example: __VNF-ID__
25165 - name: resource-uuid
25170 /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
25174 summary: see node definition for valid relationships
25175 operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
25184 description: Response codes found in [response codes](https://wiki.onap.org/).
25188 description: Unique id of VNF. This is unique across the graph.
25191 example: __VNF-ID__
25194 description: Unique ID for the entitlement group the resource comes from, should be uuid.
25197 example: __GROUP-UUID__
25198 - name: resource-uuid
25200 description: Unique ID of an entitlement resource.
25203 example: __RESOURCE-UUID__
25206 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVceEntitlementsEntitlement.json)
25209 $ref: "#/definitions/relationship"
25213 summary: delete an existing relationship
25214 description: delete an existing relationship
25215 operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
25224 description: Response codes found in [response codes](https://wiki.onap.org/).
25228 description: Unique id of VNF. This is unique across the graph.
25231 example: __VNF-ID__
25234 description: Unique ID for the entitlement group the resource comes from, should be uuid.
25237 example: __GROUP-UUID__
25238 - name: resource-uuid
25240 description: Unique ID of an entitlement resource.
25243 example: __RESOURCE-UUID__
25244 /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
25248 summary: returns entitlement
25249 description: returns entitlement
25250 operationId: getNetworkVcesVceEntitlementsEntitlement
25256 description: successful operation
25258 $ref: "#/getDefinitions/entitlement"
25260 description: Response codes found in [response codes](https://wiki.onap.org/).
25264 description: Unique id of VNF. This is unique across the graph.
25267 example: __VNF-ID__
25270 description: Unique ID for the entitlement group the resource comes from, should be uuid.
25273 example: __GROUP-UUID__
25274 - name: resource-uuid
25276 description: Unique ID of an entitlement resource.
25279 example: __RESOURCE-UUID__
25283 summary: create or update an existing entitlement
25285 Create or update an existing entitlement.
25287 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25288 operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement
25297 description: Response codes found in [response codes](https://wiki.onap.org/).
25301 description: Unique id of VNF. This is unique across the graph.
25304 example: __VNF-ID__
25307 description: Unique ID for the entitlement group the resource comes from, should be uuid.
25310 example: __GROUP-UUID__
25311 - name: resource-uuid
25313 description: Unique ID of an entitlement resource.
25316 example: __RESOURCE-UUID__
25319 description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVceEntitlementsEntitlement.json)
25322 $ref: "#/definitions/entitlement"
25326 summary: update an existing entitlement
25328 Update an existing entitlement
25330 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25331 The PUT operation will entirely replace an existing object.
25332 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25334 Other differences between PUT and PATCH are:
25336 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25337 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25338 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25339 operationId: UpdateNetworkVcesVceEntitlementsEntitlement
25348 description: Response codes found in [response codes](https://wiki.onap.org/).
25352 description: Unique id of VNF. This is unique across the graph.
25355 example: __VNF-ID__
25358 description: Unique ID for the entitlement group the resource comes from, should be uuid.
25361 example: __GROUP-UUID__
25362 - name: resource-uuid
25364 description: Unique ID of an entitlement resource.
25367 example: __RESOURCE-UUID__
25370 description: entitlement object that needs to be updated.
25373 $ref: "#/patchDefinitions/entitlement"
25377 summary: delete an existing entitlement
25378 description: delete an existing entitlement
25379 operationId: deleteNetworkVcesVceEntitlementsEntitlement
25388 description: Response codes found in [response codes](https://wiki.onap.org/).
25392 description: Unique id of VNF. This is unique across the graph.
25395 example: __VNF-ID__
25398 description: Unique ID for the entitlement group the resource comes from, should be uuid.
25401 example: __GROUP-UUID__
25402 - name: resource-uuid
25404 description: Unique ID of an entitlement resource.
25407 example: __RESOURCE-UUID__
25408 - name: resource-version
25410 description: resource-version for concurrency
25413 /network/vces/vce/{vnf-id}/entitlements:
25417 summary: returns entitlements
25418 description: returns entitlements
25419 operationId: getNetworkVcesVceEntitlements
25425 description: successful operation
25427 $ref: "#/getDefinitions/entitlements"
25429 description: Response codes found in [response codes](https://wiki.onap.org/).
25433 description: Unique id of VNF. This is unique across the graph.
25436 example: __VNF-ID__
25442 - name: resource-uuid
25447 /network/vces/vce/{vnf-id}/relationship-list/relationship:
25451 summary: see node definition for valid relationships
25452 operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship
25461 description: Response codes found in [response codes](https://wiki.onap.org/).
25465 description: Unique id of VNF. This is unique across the graph.
25468 example: __VNF-ID__
25471 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVce.json)
25474 $ref: "#/definitions/relationship"
25478 summary: delete an existing relationship
25479 description: delete an existing relationship
25480 operationId: deleteNetworkVcesVceRelationshipListRelationship
25489 description: Response codes found in [response codes](https://wiki.onap.org/).
25493 description: Unique id of VNF. This is unique across the graph.
25496 example: __VNF-ID__
25497 /network/vces/vce/{vnf-id}:
25501 summary: returns vce
25502 description: returns vce
25503 operationId: getNetworkVcesVce
25509 description: successful operation
25511 $ref: "#/getDefinitions/vce"
25513 description: Response codes found in [response codes](https://wiki.onap.org/).
25517 description: Unique id of VNF. This is unique across the graph.
25520 example: __VNF-ID__
25524 summary: create or update an existing vce
25526 Create or update an existing vce.
25528 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25529 operationId: createOrUpdateNetworkVcesVce
25538 description: Response codes found in [response codes](https://wiki.onap.org/).
25542 description: Unique id of VNF. This is unique across the graph.
25545 example: __VNF-ID__
25548 description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVce.json)
25551 $ref: "#/definitions/vce"
25555 summary: update an existing vce
25557 Update an existing vce
25559 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25560 The PUT operation will entirely replace an existing object.
25561 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25563 Other differences between PUT and PATCH are:
25565 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25566 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25567 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25568 operationId: UpdateNetworkVcesVce
25577 description: Response codes found in [response codes](https://wiki.onap.org/).
25581 description: Unique id of VNF. This is unique across the graph.
25584 example: __VNF-ID__
25587 description: vce object that needs to be updated.
25590 $ref: "#/patchDefinitions/vce"
25594 summary: delete an existing vce
25595 description: delete an existing vce
25596 operationId: deleteNetworkVcesVce
25605 description: Response codes found in [response codes](https://wiki.onap.org/).
25609 description: Unique id of VNF. This is unique across the graph.
25612 example: __VNF-ID__
25613 - name: resource-version
25615 description: resource-version for concurrency
25622 summary: returns vces
25623 description: returns vces
25624 operationId: getNetworkVces
25630 description: successful operation
25632 $ref: "#/getDefinitions/vces"
25634 description: Response codes found in [response codes](https://wiki.onap.org/).
25661 - name: regional-resource-zone
25666 - name: prov-status
25671 - name: heat-stack-id
25681 /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
25685 summary: see node definition for valid relationships
25686 operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship
25695 description: Response codes found in [response codes](https://wiki.onap.org/).
25699 description: Unique ID of vnfc.
25702 example: __VNFC-NAME__
25705 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVnfcsVnfc.json)
25708 $ref: "#/definitions/relationship"
25712 summary: delete an existing relationship
25713 description: delete an existing relationship
25714 operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship
25723 description: Response codes found in [response codes](https://wiki.onap.org/).
25727 description: Unique ID of vnfc.
25730 example: __VNFC-NAME__
25731 /network/vnfcs/vnfc/{vnfc-name}:
25735 summary: returns vnfc
25736 description: returns vnfc
25737 operationId: getNetworkVnfcsVnfc
25743 description: successful operation
25745 $ref: "#/getDefinitions/vnfc"
25747 description: Response codes found in [response codes](https://wiki.onap.org/).
25751 description: Unique ID of vnfc.
25754 example: __VNFC-NAME__
25758 summary: create or update an existing vnfc
25760 Create or update an existing vnfc.
25762 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25763 operationId: createOrUpdateNetworkVnfcsVnfc
25772 description: Response codes found in [response codes](https://wiki.onap.org/).
25776 description: Unique ID of vnfc.
25779 example: __VNFC-NAME__
25782 description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVnfcsVnfc.json)
25785 $ref: "#/definitions/vnfc"
25789 summary: update an existing vnfc
25791 Update an existing vnfc
25793 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25794 The PUT operation will entirely replace an existing object.
25795 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25797 Other differences between PUT and PATCH are:
25799 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25800 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25801 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25802 operationId: UpdateNetworkVnfcsVnfc
25811 description: Response codes found in [response codes](https://wiki.onap.org/).
25815 description: Unique ID of vnfc.
25818 example: __VNFC-NAME__
25821 description: vnfc object that needs to be updated.
25824 $ref: "#/patchDefinitions/vnfc"
25828 summary: delete an existing vnfc
25829 description: delete an existing vnfc
25830 operationId: deleteNetworkVnfcsVnfc
25839 description: Response codes found in [response codes](https://wiki.onap.org/).
25843 description: Unique ID of vnfc.
25846 example: __VNFC-NAME__
25847 - name: resource-version
25849 description: resource-version for concurrency
25856 summary: returns vnfcs
25857 description: returns vnfcs
25858 operationId: getNetworkVnfcs
25864 description: successful operation
25866 $ref: "#/getDefinitions/vnfcs"
25868 description: Response codes found in [response codes](https://wiki.onap.org/).
25875 - name: vnfc-function-code
25885 - name: prov-status
25890 - name: ipaddress-v4-oam-vip
25900 - name: is-closed-loop-disabled
25905 - name: group-notation
25910 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
25914 summary: see node definition for valid relationships
25915 operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
25924 description: Response codes found in [response codes](https://wiki.onap.org/).
25928 description: Network ID, should be uuid. Unique across A&AI.
25931 example: __NETWORK-ID__
25934 description: Subnet ID, should be UUID.
25937 example: __SUBNET-ID__
25940 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
25943 $ref: "#/definitions/relationship"
25947 summary: delete an existing relationship
25948 description: delete an existing relationship
25949 operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
25958 description: Response codes found in [response codes](https://wiki.onap.org/).
25962 description: Network ID, should be uuid. Unique across A&AI.
25965 example: __NETWORK-ID__
25968 description: Subnet ID, should be UUID.
25971 example: __SUBNET-ID__
25972 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}:
25976 summary: returns subnet
25977 description: returns subnet
25978 operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet
25984 description: successful operation
25986 $ref: "#/getDefinitions/subnet"
25988 description: Response codes found in [response codes](https://wiki.onap.org/).
25992 description: Network ID, should be uuid. Unique across A&AI.
25995 example: __NETWORK-ID__
25998 description: Subnet ID, should be UUID.
26001 example: __SUBNET-ID__
26005 summary: create or update an existing subnet
26007 Create or update an existing subnet.
26009 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26010 operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet
26019 description: Response codes found in [response codes](https://wiki.onap.org/).
26023 description: Network ID, should be uuid. Unique across A&AI.
26026 example: __NETWORK-ID__
26029 description: Subnet ID, should be UUID.
26032 example: __SUBNET-ID__
26035 description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
26038 $ref: "#/definitions/subnet"
26042 summary: update an existing subnet
26044 Update an existing subnet
26046 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26047 The PUT operation will entirely replace an existing object.
26048 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26050 Other differences between PUT and PATCH are:
26052 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26053 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26054 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26055 operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet
26064 description: Response codes found in [response codes](https://wiki.onap.org/).
26068 description: Network ID, should be uuid. Unique across A&AI.
26071 example: __NETWORK-ID__
26074 description: Subnet ID, should be UUID.
26077 example: __SUBNET-ID__
26080 description: subnet object that needs to be updated.
26083 $ref: "#/patchDefinitions/subnet"
26087 summary: delete an existing subnet
26088 description: delete an existing subnet
26089 operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet
26098 description: Response codes found in [response codes](https://wiki.onap.org/).
26102 description: Network ID, should be uuid. Unique across A&AI.
26105 example: __NETWORK-ID__
26108 description: Subnet ID, should be UUID.
26111 example: __SUBNET-ID__
26112 - name: resource-version
26114 description: resource-version for concurrency
26117 /network/l3-networks/l3-network/{network-id}/subnets:
26121 summary: returns subnets
26122 description: returns subnets
26123 operationId: getNetworkL3NetworksL3NetworkSubnets
26129 description: successful operation
26131 $ref: "#/getDefinitions/subnets"
26133 description: Response codes found in [response codes](https://wiki.onap.org/).
26137 description: Network ID, should be uuid. Unique across A&AI.
26140 example: __NETWORK-ID__
26146 - name: subnet-name
26151 /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship:
26155 summary: see node definition for valid relationships
26156 operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
26165 description: Response codes found in [response codes](https://wiki.onap.org/).
26169 description: Network ID, should be uuid. Unique across A&AI.
26172 example: __NETWORK-ID__
26173 - name: vlan-id-inner
26179 example: __VLAN-ID-INNER__
26182 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
26185 $ref: "#/definitions/relationship"
26189 summary: delete an existing relationship
26190 description: delete an existing relationship
26191 operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
26200 description: Response codes found in [response codes](https://wiki.onap.org/).
26204 description: Network ID, should be uuid. Unique across A&AI.
26207 example: __NETWORK-ID__
26208 - name: vlan-id-inner
26214 example: __VLAN-ID-INNER__
26215 /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}:
26219 summary: returns ctag-assignment
26220 description: returns ctag-assignment
26221 operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
26227 description: successful operation
26229 $ref: "#/getDefinitions/ctag-assignment"
26231 description: Response codes found in [response codes](https://wiki.onap.org/).
26235 description: Network ID, should be uuid. Unique across A&AI.
26238 example: __NETWORK-ID__
26239 - name: vlan-id-inner
26245 example: __VLAN-ID-INNER__
26249 summary: create or update an existing ctag-assignment
26251 Create or update an existing ctag-assignment.
26253 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26254 operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
26263 description: Response codes found in [response codes](https://wiki.onap.org/).
26267 description: Network ID, should be uuid. Unique across A&AI.
26270 example: __NETWORK-ID__
26271 - name: vlan-id-inner
26277 example: __VLAN-ID-INNER__
26280 description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
26283 $ref: "#/definitions/ctag-assignment"
26287 summary: update an existing ctag-assignment
26289 Update an existing ctag-assignment
26291 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26292 The PUT operation will entirely replace an existing object.
26293 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26295 Other differences between PUT and PATCH are:
26297 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26298 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26299 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26300 operationId: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
26309 description: Response codes found in [response codes](https://wiki.onap.org/).
26313 description: Network ID, should be uuid. Unique across A&AI.
26316 example: __NETWORK-ID__
26317 - name: vlan-id-inner
26323 example: __VLAN-ID-INNER__
26326 description: ctag-assignment object that needs to be updated.
26329 $ref: "#/patchDefinitions/ctag-assignment"
26333 summary: delete an existing ctag-assignment
26334 description: delete an existing ctag-assignment
26335 operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
26344 description: Response codes found in [response codes](https://wiki.onap.org/).
26348 description: Network ID, should be uuid. Unique across A&AI.
26351 example: __NETWORK-ID__
26352 - name: vlan-id-inner
26358 example: __VLAN-ID-INNER__
26359 - name: resource-version
26361 description: resource-version for concurrency
26364 /network/l3-networks/l3-network/{network-id}/ctag-assignments:
26368 summary: returns ctag-assignments
26369 description: returns ctag-assignments
26370 operationId: getNetworkL3NetworksL3NetworkCtagAssignments
26376 description: successful operation
26378 $ref: "#/getDefinitions/ctag-assignments"
26380 description: Response codes found in [response codes](https://wiki.onap.org/).
26384 description: Network ID, should be uuid. Unique across A&AI.
26387 example: __NETWORK-ID__
26388 - name: vlan-id-inner
26394 /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship:
26398 summary: see node definition for valid relationships
26399 operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
26408 description: Response codes found in [response codes](https://wiki.onap.org/).
26412 description: Network ID, should be uuid. Unique across A&AI.
26415 example: __NETWORK-ID__
26416 - name: segmentation-id
26418 description: Route Table Reference id, UUID assigned to this instance.
26421 example: __SEGMENTATION-ID__
26424 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
26427 $ref: "#/definitions/relationship"
26431 summary: delete an existing relationship
26432 description: delete an existing relationship
26433 operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
26442 description: Response codes found in [response codes](https://wiki.onap.org/).
26446 description: Network ID, should be uuid. Unique across A&AI.
26449 example: __NETWORK-ID__
26450 - name: segmentation-id
26452 description: Route Table Reference id, UUID assigned to this instance.
26455 example: __SEGMENTATION-ID__
26456 /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}:
26460 summary: returns segmentation-assignment
26461 description: returns segmentation-assignment
26462 operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
26468 description: successful operation
26470 $ref: "#/getDefinitions/segmentation-assignment"
26472 description: Response codes found in [response codes](https://wiki.onap.org/).
26476 description: Network ID, should be uuid. Unique across A&AI.
26479 example: __NETWORK-ID__
26480 - name: segmentation-id
26482 description: Route Table Reference id, UUID assigned to this instance.
26485 example: __SEGMENTATION-ID__
26489 summary: create or update an existing segmentation-assignment
26491 Create or update an existing segmentation-assignment.
26493 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26494 operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
26503 description: Response codes found in [response codes](https://wiki.onap.org/).
26507 description: Network ID, should be uuid. Unique across A&AI.
26510 example: __NETWORK-ID__
26511 - name: segmentation-id
26513 description: Route Table Reference id, UUID assigned to this instance.
26516 example: __SEGMENTATION-ID__
26519 description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
26522 $ref: "#/definitions/segmentation-assignment"
26526 summary: update an existing segmentation-assignment
26528 Update an existing segmentation-assignment
26530 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26531 The PUT operation will entirely replace an existing object.
26532 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26534 Other differences between PUT and PATCH are:
26536 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26537 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26538 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26539 operationId: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
26548 description: Response codes found in [response codes](https://wiki.onap.org/).
26552 description: Network ID, should be uuid. Unique across A&AI.
26555 example: __NETWORK-ID__
26556 - name: segmentation-id
26558 description: Route Table Reference id, UUID assigned to this instance.
26561 example: __SEGMENTATION-ID__
26564 description: segmentation-assignment object that needs to be updated.
26567 $ref: "#/patchDefinitions/segmentation-assignment"
26571 summary: delete an existing segmentation-assignment
26572 description: delete an existing segmentation-assignment
26573 operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
26582 description: Response codes found in [response codes](https://wiki.onap.org/).
26586 description: Network ID, should be uuid. Unique across A&AI.
26589 example: __NETWORK-ID__
26590 - name: segmentation-id
26592 description: Route Table Reference id, UUID assigned to this instance.
26595 example: __SEGMENTATION-ID__
26596 - name: resource-version
26598 description: resource-version for concurrency
26601 /network/l3-networks/l3-network/{network-id}/segmentation-assignments:
26605 summary: returns segmentation-assignments
26606 description: returns segmentation-assignments
26607 operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments
26613 description: successful operation
26615 $ref: "#/getDefinitions/segmentation-assignments"
26617 description: Response codes found in [response codes](https://wiki.onap.org/).
26621 description: Network ID, should be uuid. Unique across A&AI.
26624 example: __NETWORK-ID__
26625 - name: segmentation-id
26630 /network/l3-networks/l3-network/{network-id}/relationship-list/relationship:
26634 summary: see node definition for valid relationships
26635 operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship
26644 description: Response codes found in [response codes](https://wiki.onap.org/).
26648 description: Network ID, should be uuid. Unique across A&AI.
26651 example: __NETWORK-ID__
26654 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3Network.json)
26657 $ref: "#/definitions/relationship"
26661 summary: delete an existing relationship
26662 description: delete an existing relationship
26663 operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship
26672 description: Response codes found in [response codes](https://wiki.onap.org/).
26676 description: Network ID, should be uuid. Unique across A&AI.
26679 example: __NETWORK-ID__
26680 /network/l3-networks/l3-network/{network-id}:
26684 summary: returns l3-network
26685 description: returns l3-network
26686 operationId: getNetworkL3NetworksL3Network
26692 description: successful operation
26694 $ref: "#/getDefinitions/l3-network"
26696 description: Response codes found in [response codes](https://wiki.onap.org/).
26700 description: Network ID, should be uuid. Unique across A&AI.
26703 example: __NETWORK-ID__
26707 summary: create or update an existing l3-network
26709 Create or update an existing l3-network.
26711 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26712 operationId: createOrUpdateNetworkL3NetworksL3Network
26721 description: Response codes found in [response codes](https://wiki.onap.org/).
26725 description: Network ID, should be uuid. Unique across A&AI.
26728 example: __NETWORK-ID__
26731 description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3Network.json)
26734 $ref: "#/definitions/l3-network"
26738 summary: update an existing l3-network
26740 Update an existing l3-network
26742 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26743 The PUT operation will entirely replace an existing object.
26744 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26746 Other differences between PUT and PATCH are:
26748 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26749 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26750 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26751 operationId: UpdateNetworkL3NetworksL3Network
26760 description: Response codes found in [response codes](https://wiki.onap.org/).
26764 description: Network ID, should be uuid. Unique across A&AI.
26767 example: __NETWORK-ID__
26770 description: l3-network object that needs to be updated.
26773 $ref: "#/patchDefinitions/l3-network"
26777 summary: delete an existing l3-network
26778 description: delete an existing l3-network
26779 operationId: deleteNetworkL3NetworksL3Network
26788 description: Response codes found in [response codes](https://wiki.onap.org/).
26792 description: Network ID, should be uuid. Unique across A&AI.
26795 example: __NETWORK-ID__
26796 - name: resource-version
26798 description: resource-version for concurrency
26801 /network/l3-networks:
26805 summary: returns l3-networks
26806 description: returns l3-networks
26807 operationId: getNetworkL3Networks
26813 description: successful operation
26815 $ref: "#/getDefinitions/l3-networks"
26817 description: Response codes found in [response codes](https://wiki.onap.org/).
26824 - name: network-name
26829 - name: network-role
26839 - name: heat-stack-id
26844 - name: contrail-network-fqdn
26849 - name: persona-model-id
26854 - name: persona-model-version
26859 - name: widget-model-id
26864 - name: widget-model-version
26869 /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship:
26873 summary: see node definition for valid relationships
26874 operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
26883 description: Response codes found in [response codes](https://wiki.onap.org/).
26885 - name: network-policy-id
26887 description: UUID representing unique key to this instance
26890 example: __NETWORK-POLICY-ID__
26893 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNetworkPoliciesNetworkPolicy.json)
26896 $ref: "#/definitions/relationship"
26900 summary: delete an existing relationship
26901 description: delete an existing relationship
26902 operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
26911 description: Response codes found in [response codes](https://wiki.onap.org/).
26913 - name: network-policy-id
26915 description: UUID representing unique key to this instance
26918 example: __NETWORK-POLICY-ID__
26919 /network/network-policies/network-policy/{network-policy-id}:
26923 summary: returns network-policy
26924 description: returns network-policy
26925 operationId: getNetworkNetworkPoliciesNetworkPolicy
26931 description: successful operation
26933 $ref: "#/getDefinitions/network-policy"
26935 description: Response codes found in [response codes](https://wiki.onap.org/).
26937 - name: network-policy-id
26939 description: UUID representing unique key to this instance
26942 example: __NETWORK-POLICY-ID__
26946 summary: create or update an existing network-policy
26948 Create or update an existing network-policy.
26950 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26951 operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy
26960 description: Response codes found in [response codes](https://wiki.onap.org/).
26962 - name: network-policy-id
26964 description: UUID representing unique key to this instance
26967 example: __NETWORK-POLICY-ID__
26970 description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNetworkPoliciesNetworkPolicy.json)
26973 $ref: "#/definitions/network-policy"
26977 summary: update an existing network-policy
26979 Update an existing network-policy
26981 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26982 The PUT operation will entirely replace an existing object.
26983 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26985 Other differences between PUT and PATCH are:
26987 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26988 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26989 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26990 operationId: UpdateNetworkNetworkPoliciesNetworkPolicy
26999 description: Response codes found in [response codes](https://wiki.onap.org/).
27001 - name: network-policy-id
27003 description: UUID representing unique key to this instance
27006 example: __NETWORK-POLICY-ID__
27009 description: network-policy object that needs to be updated.
27012 $ref: "#/patchDefinitions/network-policy"
27016 summary: delete an existing network-policy
27017 description: delete an existing network-policy
27018 operationId: deleteNetworkNetworkPoliciesNetworkPolicy
27027 description: Response codes found in [response codes](https://wiki.onap.org/).
27029 - name: network-policy-id
27031 description: UUID representing unique key to this instance
27034 example: __NETWORK-POLICY-ID__
27035 - name: resource-version
27037 description: resource-version for concurrency
27040 /network/network-policies:
27044 summary: returns network-policies
27045 description: returns network-policies
27046 operationId: getNetworkNetworkPolicies
27052 description: successful operation
27054 $ref: "#/getDefinitions/network-policies"
27056 description: Response codes found in [response codes](https://wiki.onap.org/).
27058 - name: network-policy-id
27063 - name: network-policy-fqdn
27068 /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship:
27072 summary: see node definition for valid relationships
27073 operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship
27082 description: Response codes found in [response codes](https://wiki.onap.org/).
27086 description: Unique id of VNF. This is unique across the graph.
27089 example: __VNF-ID__
27092 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnf.json)
27095 $ref: "#/definitions/relationship"
27099 summary: delete an existing relationship
27100 description: delete an existing relationship
27101 operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship
27110 description: Response codes found in [response codes](https://wiki.onap.org/).
27114 description: Unique id of VNF. This is unique across the graph.
27117 example: __VNF-ID__
27118 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
27122 summary: see node definition for valid relationships
27123 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
27132 description: Response codes found in [response codes](https://wiki.onap.org/).
27136 description: Unique id of VNF. This is unique across the graph.
27139 example: __VNF-ID__
27140 - name: interface-name
27142 description: Name given to the interface
27145 example: __INTERFACE-NAME__
27146 - name: vlan-interface
27148 description: String that identifies the interface
27151 example: __VLAN-INTERFACE__
27154 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
27157 $ref: "#/definitions/relationship"
27161 summary: delete an existing relationship
27162 description: delete an existing relationship
27163 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
27172 description: Response codes found in [response codes](https://wiki.onap.org/).
27176 description: Unique id of VNF. This is unique across the graph.
27179 example: __VNF-ID__
27180 - name: interface-name
27182 description: Name given to the interface
27185 example: __INTERFACE-NAME__
27186 - name: vlan-interface
27188 description: String that identifies the interface
27191 example: __VLAN-INTERFACE__
27192 /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:
27196 summary: see node definition for valid relationships
27197 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
27206 description: Response codes found in [response codes](https://wiki.onap.org/).
27210 description: Unique id of VNF. This is unique across the graph.
27213 example: __VNF-ID__
27214 - name: interface-name
27216 description: Name given to the interface
27219 example: __INTERFACE-NAME__
27220 - name: vlan-interface
27222 description: String that identifies the interface
27225 example: __VLAN-INTERFACE__
27226 - name: l3-interface-ipv4-address
27228 description: IP address
27231 example: __L3-INTERFACE-IPV4-ADDRESS__
27234 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
27237 $ref: "#/definitions/relationship"
27241 summary: delete an existing relationship
27242 description: delete an existing relationship
27243 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
27252 description: Response codes found in [response codes](https://wiki.onap.org/).
27256 description: Unique id of VNF. This is unique across the graph.
27259 example: __VNF-ID__
27260 - name: interface-name
27262 description: Name given to the interface
27265 example: __INTERFACE-NAME__
27266 - name: vlan-interface
27268 description: String that identifies the interface
27271 example: __VLAN-INTERFACE__
27272 - name: l3-interface-ipv4-address
27274 description: IP address
27277 example: __L3-INTERFACE-IPV4-ADDRESS__
27278 /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}:
27282 summary: returns l3-interface-ipv4-address-list
27283 description: returns l3-interface-ipv4-address-list
27284 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27290 description: successful operation
27292 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
27294 description: Response codes found in [response codes](https://wiki.onap.org/).
27298 description: Unique id of VNF. This is unique across the graph.
27301 example: __VNF-ID__
27302 - name: interface-name
27304 description: Name given to the interface
27307 example: __INTERFACE-NAME__
27308 - name: vlan-interface
27310 description: String that identifies the interface
27313 example: __VLAN-INTERFACE__
27314 - name: l3-interface-ipv4-address
27316 description: IP address
27319 example: __L3-INTERFACE-IPV4-ADDRESS__
27323 summary: create or update an existing l3-interface-ipv4-address-list
27325 Create or update an existing l3-interface-ipv4-address-list.
27327 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27328 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27337 description: Response codes found in [response codes](https://wiki.onap.org/).
27341 description: Unique id of VNF. This is unique across the graph.
27344 example: __VNF-ID__
27345 - name: interface-name
27347 description: Name given to the interface
27350 example: __INTERFACE-NAME__
27351 - name: vlan-interface
27353 description: String that identifies the interface
27356 example: __VLAN-INTERFACE__
27357 - name: l3-interface-ipv4-address
27359 description: IP address
27362 example: __L3-INTERFACE-IPV4-ADDRESS__
27365 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
27368 $ref: "#/definitions/l3-interface-ipv4-address-list"
27372 summary: update an existing l3-interface-ipv4-address-list
27374 Update an existing l3-interface-ipv4-address-list
27376 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27377 The PUT operation will entirely replace an existing object.
27378 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27380 Other differences between PUT and PATCH are:
27382 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27383 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27384 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27385 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27394 description: Response codes found in [response codes](https://wiki.onap.org/).
27398 description: Unique id of VNF. This is unique across the graph.
27401 example: __VNF-ID__
27402 - name: interface-name
27404 description: Name given to the interface
27407 example: __INTERFACE-NAME__
27408 - name: vlan-interface
27410 description: String that identifies the interface
27413 example: __VLAN-INTERFACE__
27414 - name: l3-interface-ipv4-address
27416 description: IP address
27419 example: __L3-INTERFACE-IPV4-ADDRESS__
27422 description: l3-interface-ipv4-address-list object that needs to be updated.
27425 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
27429 summary: delete an existing l3-interface-ipv4-address-list
27430 description: delete an existing l3-interface-ipv4-address-list
27431 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27440 description: Response codes found in [response codes](https://wiki.onap.org/).
27444 description: Unique id of VNF. This is unique across the graph.
27447 example: __VNF-ID__
27448 - name: interface-name
27450 description: Name given to the interface
27453 example: __INTERFACE-NAME__
27454 - name: vlan-interface
27456 description: String that identifies the interface
27459 example: __VLAN-INTERFACE__
27460 - name: l3-interface-ipv4-address
27462 description: IP address
27465 example: __L3-INTERFACE-IPV4-ADDRESS__
27466 - name: resource-version
27468 description: resource-version for concurrency
27471 /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:
27475 summary: see node definition for valid relationships
27476 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
27485 description: Response codes found in [response codes](https://wiki.onap.org/).
27489 description: Unique id of VNF. This is unique across the graph.
27492 example: __VNF-ID__
27493 - name: interface-name
27495 description: Name given to the interface
27498 example: __INTERFACE-NAME__
27499 - name: vlan-interface
27501 description: String that identifies the interface
27504 example: __VLAN-INTERFACE__
27505 - name: l3-interface-ipv6-address
27507 description: IP address
27510 example: __L3-INTERFACE-IPV6-ADDRESS__
27513 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
27516 $ref: "#/definitions/relationship"
27520 summary: delete an existing relationship
27521 description: delete an existing relationship
27522 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
27531 description: Response codes found in [response codes](https://wiki.onap.org/).
27535 description: Unique id of VNF. This is unique across the graph.
27538 example: __VNF-ID__
27539 - name: interface-name
27541 description: Name given to the interface
27544 example: __INTERFACE-NAME__
27545 - name: vlan-interface
27547 description: String that identifies the interface
27550 example: __VLAN-INTERFACE__
27551 - name: l3-interface-ipv6-address
27553 description: IP address
27556 example: __L3-INTERFACE-IPV6-ADDRESS__
27557 /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}:
27561 summary: returns l3-interface-ipv6-address-list
27562 description: returns l3-interface-ipv6-address-list
27563 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27569 description: successful operation
27571 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
27573 description: Response codes found in [response codes](https://wiki.onap.org/).
27577 description: Unique id of VNF. This is unique across the graph.
27580 example: __VNF-ID__
27581 - name: interface-name
27583 description: Name given to the interface
27586 example: __INTERFACE-NAME__
27587 - name: vlan-interface
27589 description: String that identifies the interface
27592 example: __VLAN-INTERFACE__
27593 - name: l3-interface-ipv6-address
27595 description: IP address
27598 example: __L3-INTERFACE-IPV6-ADDRESS__
27602 summary: create or update an existing l3-interface-ipv6-address-list
27604 Create or update an existing l3-interface-ipv6-address-list.
27606 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27607 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27616 description: Response codes found in [response codes](https://wiki.onap.org/).
27620 description: Unique id of VNF. This is unique across the graph.
27623 example: __VNF-ID__
27624 - name: interface-name
27626 description: Name given to the interface
27629 example: __INTERFACE-NAME__
27630 - name: vlan-interface
27632 description: String that identifies the interface
27635 example: __VLAN-INTERFACE__
27636 - name: l3-interface-ipv6-address
27638 description: IP address
27641 example: __L3-INTERFACE-IPV6-ADDRESS__
27644 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
27647 $ref: "#/definitions/l3-interface-ipv6-address-list"
27651 summary: update an existing l3-interface-ipv6-address-list
27653 Update an existing l3-interface-ipv6-address-list
27655 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27656 The PUT operation will entirely replace an existing object.
27657 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27659 Other differences between PUT and PATCH are:
27661 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27662 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27663 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27664 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27673 description: Response codes found in [response codes](https://wiki.onap.org/).
27677 description: Unique id of VNF. This is unique across the graph.
27680 example: __VNF-ID__
27681 - name: interface-name
27683 description: Name given to the interface
27686 example: __INTERFACE-NAME__
27687 - name: vlan-interface
27689 description: String that identifies the interface
27692 example: __VLAN-INTERFACE__
27693 - name: l3-interface-ipv6-address
27695 description: IP address
27698 example: __L3-INTERFACE-IPV6-ADDRESS__
27701 description: l3-interface-ipv6-address-list object that needs to be updated.
27704 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
27708 summary: delete an existing l3-interface-ipv6-address-list
27709 description: delete an existing l3-interface-ipv6-address-list
27710 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27719 description: Response codes found in [response codes](https://wiki.onap.org/).
27723 description: Unique id of VNF. This is unique across the graph.
27726 example: __VNF-ID__
27727 - name: interface-name
27729 description: Name given to the interface
27732 example: __INTERFACE-NAME__
27733 - name: vlan-interface
27735 description: String that identifies the interface
27738 example: __VLAN-INTERFACE__
27739 - name: l3-interface-ipv6-address
27741 description: IP address
27744 example: __L3-INTERFACE-IPV6-ADDRESS__
27745 - name: resource-version
27747 description: resource-version for concurrency
27750 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
27754 summary: returns vlan
27755 description: returns vlan
27756 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
27762 description: successful operation
27764 $ref: "#/getDefinitions/vlan"
27766 description: Response codes found in [response codes](https://wiki.onap.org/).
27770 description: Unique id of VNF. This is unique across the graph.
27773 example: __VNF-ID__
27774 - name: interface-name
27776 description: Name given to the interface
27779 example: __INTERFACE-NAME__
27780 - name: vlan-interface
27782 description: String that identifies the interface
27785 example: __VLAN-INTERFACE__
27789 summary: create or update an existing vlan
27791 Create or update an existing vlan.
27793 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27794 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
27803 description: Response codes found in [response codes](https://wiki.onap.org/).
27807 description: Unique id of VNF. This is unique across the graph.
27810 example: __VNF-ID__
27811 - name: interface-name
27813 description: Name given to the interface
27816 example: __INTERFACE-NAME__
27817 - name: vlan-interface
27819 description: String that identifies the interface
27822 example: __VLAN-INTERFACE__
27825 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
27828 $ref: "#/definitions/vlan"
27832 summary: update an existing vlan
27834 Update an existing vlan
27836 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27837 The PUT operation will entirely replace an existing object.
27838 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27840 Other differences between PUT and PATCH are:
27842 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27843 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27844 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27845 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
27854 description: Response codes found in [response codes](https://wiki.onap.org/).
27858 description: Unique id of VNF. This is unique across the graph.
27861 example: __VNF-ID__
27862 - name: interface-name
27864 description: Name given to the interface
27867 example: __INTERFACE-NAME__
27868 - name: vlan-interface
27870 description: String that identifies the interface
27873 example: __VLAN-INTERFACE__
27876 description: vlan object that needs to be updated.
27879 $ref: "#/patchDefinitions/vlan"
27883 summary: delete an existing vlan
27884 description: delete an existing vlan
27885 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
27894 description: Response codes found in [response codes](https://wiki.onap.org/).
27898 description: Unique id of VNF. This is unique across the graph.
27901 example: __VNF-ID__
27902 - name: interface-name
27904 description: Name given to the interface
27907 example: __INTERFACE-NAME__
27908 - name: vlan-interface
27910 description: String that identifies the interface
27913 example: __VLAN-INTERFACE__
27914 - name: resource-version
27916 description: resource-version for concurrency
27919 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans:
27923 summary: returns vlans
27924 description: returns vlans
27925 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans
27931 description: successful operation
27933 $ref: "#/getDefinitions/vlans"
27935 description: Response codes found in [response codes](https://wiki.onap.org/).
27939 description: Unique id of VNF. This is unique across the graph.
27942 example: __VNF-ID__
27943 - name: interface-name
27945 description: Name given to the interface
27948 example: __INTERFACE-NAME__
27949 - name: vlan-interface
27954 - name: vlan-id-inner
27965 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
27969 summary: see node definition for valid relationships
27970 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
27979 description: Response codes found in [response codes](https://wiki.onap.org/).
27983 description: Unique id of VNF. This is unique across the graph.
27986 example: __VNF-ID__
27987 - name: interface-name
27989 description: Name given to the interface
27992 example: __INTERFACE-NAME__
27995 description: PCI ID used to identify the sriov-vf
27998 example: __PCI-ID__
28001 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
28004 $ref: "#/definitions/relationship"
28008 summary: delete an existing relationship
28009 description: delete an existing relationship
28010 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
28019 description: Response codes found in [response codes](https://wiki.onap.org/).
28023 description: Unique id of VNF. This is unique across the graph.
28026 example: __VNF-ID__
28027 - name: interface-name
28029 description: Name given to the interface
28032 example: __INTERFACE-NAME__
28035 description: PCI ID used to identify the sriov-vf
28038 example: __PCI-ID__
28039 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
28043 summary: returns sriov-vf
28044 description: returns sriov-vf
28045 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
28051 description: successful operation
28053 $ref: "#/getDefinitions/sriov-vf"
28055 description: Response codes found in [response codes](https://wiki.onap.org/).
28059 description: Unique id of VNF. This is unique across the graph.
28062 example: __VNF-ID__
28063 - name: interface-name
28065 description: Name given to the interface
28068 example: __INTERFACE-NAME__
28071 description: PCI ID used to identify the sriov-vf
28074 example: __PCI-ID__
28078 summary: create or update an existing sriov-vf
28080 Create or update an existing sriov-vf.
28082 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28083 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
28092 description: Response codes found in [response codes](https://wiki.onap.org/).
28096 description: Unique id of VNF. This is unique across the graph.
28099 example: __VNF-ID__
28100 - name: interface-name
28102 description: Name given to the interface
28105 example: __INTERFACE-NAME__
28108 description: PCI ID used to identify the sriov-vf
28111 example: __PCI-ID__
28114 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
28117 $ref: "#/definitions/sriov-vf"
28121 summary: update an existing sriov-vf
28123 Update an existing sriov-vf
28125 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28126 The PUT operation will entirely replace an existing object.
28127 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28129 Other differences between PUT and PATCH are:
28131 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28132 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28133 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28134 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
28143 description: Response codes found in [response codes](https://wiki.onap.org/).
28147 description: Unique id of VNF. This is unique across the graph.
28150 example: __VNF-ID__
28151 - name: interface-name
28153 description: Name given to the interface
28156 example: __INTERFACE-NAME__
28159 description: PCI ID used to identify the sriov-vf
28162 example: __PCI-ID__
28165 description: sriov-vf object that needs to be updated.
28168 $ref: "#/patchDefinitions/sriov-vf"
28172 summary: delete an existing sriov-vf
28173 description: delete an existing sriov-vf
28174 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
28183 description: Response codes found in [response codes](https://wiki.onap.org/).
28187 description: Unique id of VNF. This is unique across the graph.
28190 example: __VNF-ID__
28191 - name: interface-name
28193 description: Name given to the interface
28196 example: __INTERFACE-NAME__
28199 description: PCI ID used to identify the sriov-vf
28202 example: __PCI-ID__
28203 - name: resource-version
28205 description: resource-version for concurrency
28208 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
28212 summary: returns sriov-vfs
28213 description: returns sriov-vfs
28214 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs
28220 description: successful operation
28222 $ref: "#/getDefinitions/sriov-vfs"
28224 description: Response codes found in [response codes](https://wiki.onap.org/).
28228 description: Unique id of VNF. This is unique across the graph.
28231 example: __VNF-ID__
28232 - name: interface-name
28234 description: Name given to the interface
28237 example: __INTERFACE-NAME__
28243 - name: vf-vlan-filter
28248 - name: vf-mac-filter
28253 - name: vf-vlan-strip
28258 - name: neutron-network-id
28263 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
28267 summary: see node definition for valid relationships
28268 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
28277 description: Response codes found in [response codes](https://wiki.onap.org/).
28281 description: Unique id of VNF. This is unique across the graph.
28284 example: __VNF-ID__
28285 - name: interface-name
28287 description: Name given to the interface
28290 example: __INTERFACE-NAME__
28293 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
28296 $ref: "#/definitions/relationship"
28300 summary: delete an existing relationship
28301 description: delete an existing relationship
28302 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
28311 description: Response codes found in [response codes](https://wiki.onap.org/).
28315 description: Unique id of VNF. This is unique across the graph.
28318 example: __VNF-ID__
28319 - name: interface-name
28321 description: Name given to the interface
28324 example: __INTERFACE-NAME__
28325 /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:
28329 summary: see node definition for valid relationships
28330 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
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-name
28349 description: Name given to the interface
28352 example: __INTERFACE-NAME__
28353 - name: l3-interface-ipv4-address
28355 description: IP address
28358 example: __L3-INTERFACE-IPV4-ADDRESS__
28361 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
28364 $ref: "#/definitions/relationship"
28368 summary: delete an existing relationship
28369 description: delete an existing relationship
28370 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
28379 description: Response codes found in [response codes](https://wiki.onap.org/).
28383 description: Unique id of VNF. This is unique across the graph.
28386 example: __VNF-ID__
28387 - name: interface-name
28389 description: Name given to the interface
28392 example: __INTERFACE-NAME__
28393 - name: l3-interface-ipv4-address
28395 description: IP address
28398 example: __L3-INTERFACE-IPV4-ADDRESS__
28399 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
28403 summary: returns l3-interface-ipv4-address-list
28404 description: returns l3-interface-ipv4-address-list
28405 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
28411 description: successful operation
28413 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
28415 description: Response codes found in [response codes](https://wiki.onap.org/).
28419 description: Unique id of VNF. This is unique across the graph.
28422 example: __VNF-ID__
28423 - name: interface-name
28425 description: Name given to the interface
28428 example: __INTERFACE-NAME__
28429 - name: l3-interface-ipv4-address
28431 description: IP address
28434 example: __L3-INTERFACE-IPV4-ADDRESS__
28438 summary: create or update an existing l3-interface-ipv4-address-list
28440 Create or update an existing l3-interface-ipv4-address-list.
28442 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28443 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
28452 description: Response codes found in [response codes](https://wiki.onap.org/).
28456 description: Unique id of VNF. This is unique across the graph.
28459 example: __VNF-ID__
28460 - name: interface-name
28462 description: Name given to the interface
28465 example: __INTERFACE-NAME__
28466 - name: l3-interface-ipv4-address
28468 description: IP address
28471 example: __L3-INTERFACE-IPV4-ADDRESS__
28474 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
28477 $ref: "#/definitions/l3-interface-ipv4-address-list"
28481 summary: update an existing l3-interface-ipv4-address-list
28483 Update an existing l3-interface-ipv4-address-list
28485 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28486 The PUT operation will entirely replace an existing object.
28487 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28489 Other differences between PUT and PATCH are:
28491 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28492 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28493 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28494 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
28503 description: Response codes found in [response codes](https://wiki.onap.org/).
28507 description: Unique id of VNF. This is unique across the graph.
28510 example: __VNF-ID__
28511 - name: interface-name
28513 description: Name given to the interface
28516 example: __INTERFACE-NAME__
28517 - name: l3-interface-ipv4-address
28519 description: IP address
28522 example: __L3-INTERFACE-IPV4-ADDRESS__
28525 description: l3-interface-ipv4-address-list object that needs to be updated.
28528 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
28532 summary: delete an existing l3-interface-ipv4-address-list
28533 description: delete an existing l3-interface-ipv4-address-list
28534 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
28543 description: Response codes found in [response codes](https://wiki.onap.org/).
28547 description: Unique id of VNF. This is unique across the graph.
28550 example: __VNF-ID__
28551 - name: interface-name
28553 description: Name given to the interface
28556 example: __INTERFACE-NAME__
28557 - name: l3-interface-ipv4-address
28559 description: IP address
28562 example: __L3-INTERFACE-IPV4-ADDRESS__
28563 - name: resource-version
28565 description: resource-version for concurrency
28568 /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:
28572 summary: see node definition for valid relationships
28573 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
28582 description: Response codes found in [response codes](https://wiki.onap.org/).
28586 description: Unique id of VNF. This is unique across the graph.
28589 example: __VNF-ID__
28590 - name: interface-name
28592 description: Name given to the interface
28595 example: __INTERFACE-NAME__
28596 - name: l3-interface-ipv6-address
28598 description: IP address
28601 example: __L3-INTERFACE-IPV6-ADDRESS__
28604 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
28607 $ref: "#/definitions/relationship"
28611 summary: delete an existing relationship
28612 description: delete an existing relationship
28613 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
28622 description: Response codes found in [response codes](https://wiki.onap.org/).
28626 description: Unique id of VNF. This is unique across the graph.
28629 example: __VNF-ID__
28630 - name: interface-name
28632 description: Name given to the interface
28635 example: __INTERFACE-NAME__
28636 - name: l3-interface-ipv6-address
28638 description: IP address
28641 example: __L3-INTERFACE-IPV6-ADDRESS__
28642 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
28646 summary: returns l3-interface-ipv6-address-list
28647 description: returns l3-interface-ipv6-address-list
28648 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
28654 description: successful operation
28656 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
28658 description: Response codes found in [response codes](https://wiki.onap.org/).
28662 description: Unique id of VNF. This is unique across the graph.
28665 example: __VNF-ID__
28666 - name: interface-name
28668 description: Name given to the interface
28671 example: __INTERFACE-NAME__
28672 - name: l3-interface-ipv6-address
28674 description: IP address
28677 example: __L3-INTERFACE-IPV6-ADDRESS__
28681 summary: create or update an existing l3-interface-ipv6-address-list
28683 Create or update an existing l3-interface-ipv6-address-list.
28685 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28686 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
28695 description: Response codes found in [response codes](https://wiki.onap.org/).
28699 description: Unique id of VNF. This is unique across the graph.
28702 example: __VNF-ID__
28703 - name: interface-name
28705 description: Name given to the interface
28708 example: __INTERFACE-NAME__
28709 - name: l3-interface-ipv6-address
28711 description: IP address
28714 example: __L3-INTERFACE-IPV6-ADDRESS__
28717 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
28720 $ref: "#/definitions/l3-interface-ipv6-address-list"
28724 summary: update an existing l3-interface-ipv6-address-list
28726 Update an existing l3-interface-ipv6-address-list
28728 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28729 The PUT operation will entirely replace an existing object.
28730 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28732 Other differences between PUT and PATCH are:
28734 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28735 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28736 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28737 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
28746 description: Response codes found in [response codes](https://wiki.onap.org/).
28750 description: Unique id of VNF. This is unique across the graph.
28753 example: __VNF-ID__
28754 - name: interface-name
28756 description: Name given to the interface
28759 example: __INTERFACE-NAME__
28760 - name: l3-interface-ipv6-address
28762 description: IP address
28765 example: __L3-INTERFACE-IPV6-ADDRESS__
28768 description: l3-interface-ipv6-address-list object that needs to be updated.
28771 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
28775 summary: delete an existing l3-interface-ipv6-address-list
28776 description: delete an existing l3-interface-ipv6-address-list
28777 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
28786 description: Response codes found in [response codes](https://wiki.onap.org/).
28790 description: Unique id of VNF. This is unique across the graph.
28793 example: __VNF-ID__
28794 - name: interface-name
28796 description: Name given to the interface
28799 example: __INTERFACE-NAME__
28800 - name: l3-interface-ipv6-address
28802 description: IP address
28805 example: __L3-INTERFACE-IPV6-ADDRESS__
28806 - name: resource-version
28808 description: resource-version for concurrency
28811 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}:
28815 summary: returns l-interface
28816 description: returns l-interface
28817 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface
28823 description: successful operation
28825 $ref: "#/getDefinitions/l-interface"
28827 description: Response codes found in [response codes](https://wiki.onap.org/).
28831 description: Unique id of VNF. This is unique across the graph.
28834 example: __VNF-ID__
28835 - name: interface-name
28837 description: Name given to the interface
28840 example: __INTERFACE-NAME__
28844 summary: create or update an existing l-interface
28846 Create or update an existing l-interface.
28848 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28849 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
28858 description: Response codes found in [response codes](https://wiki.onap.org/).
28862 description: Unique id of VNF. This is unique across the graph.
28865 example: __VNF-ID__
28866 - name: interface-name
28868 description: Name given to the interface
28871 example: __INTERFACE-NAME__
28874 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
28877 $ref: "#/definitions/l-interface"
28881 summary: update an existing l-interface
28883 Update an existing l-interface
28885 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28886 The PUT operation will entirely replace an existing object.
28887 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28889 Other differences between PUT and PATCH are:
28891 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28892 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28893 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28894 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
28903 description: Response codes found in [response codes](https://wiki.onap.org/).
28907 description: Unique id of VNF. This is unique across the graph.
28910 example: __VNF-ID__
28911 - name: interface-name
28913 description: Name given to the interface
28916 example: __INTERFACE-NAME__
28919 description: l-interface object that needs to be updated.
28922 $ref: "#/patchDefinitions/l-interface"
28926 summary: delete an existing l-interface
28927 description: delete an existing l-interface
28928 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface
28937 description: Response codes found in [response codes](https://wiki.onap.org/).
28941 description: Unique id of VNF. This is unique across the graph.
28944 example: __VNF-ID__
28945 - name: interface-name
28947 description: Name given to the interface
28950 example: __INTERFACE-NAME__
28951 - name: resource-version
28953 description: resource-version for concurrency
28956 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces:
28960 summary: returns l-interfaces
28961 description: returns l-interfaces
28962 operationId: getNetworkGenericVnfsGenericVnfLInterfaces
28968 description: successful operation
28970 $ref: "#/getDefinitions/l-interfaces"
28972 description: Response codes found in [response codes](https://wiki.onap.org/).
28976 description: Unique id of VNF. This is unique across the graph.
28979 example: __VNF-ID__
28980 - name: interface-name
28985 - name: interface-id
28995 - name: network-name
29000 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
29004 summary: see node definition for valid relationships
29005 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
29014 description: Response codes found in [response codes](https://wiki.onap.org/).
29018 description: Unique id of VNF. This is unique across the graph.
29021 example: __VNF-ID__
29022 - name: interface-name
29024 description: Name that identifies the link aggregate interface
29027 example: __INTERFACE-NAME__
29030 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
29033 $ref: "#/definitions/relationship"
29037 summary: delete an existing relationship
29038 description: delete an existing relationship
29039 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
29048 description: Response codes found in [response codes](https://wiki.onap.org/).
29052 description: Unique id of VNF. This is unique across the graph.
29055 example: __VNF-ID__
29056 - name: interface-name
29058 description: Name that identifies the link aggregate interface
29061 example: __INTERFACE-NAME__
29062 /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:
29066 summary: see node definition for valid relationships
29067 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
29076 description: Response codes found in [response codes](https://wiki.onap.org/).
29080 description: Unique id of VNF. This is unique across the graph.
29083 example: __VNF-ID__
29084 - name: interface-name
29086 description: Name that identifies the link aggregate interface
29089 example: __INTERFACE-NAME__
29090 - name: interface-name
29092 description: Name given to the interface
29095 example: __INTERFACE-NAME__
29096 - name: vlan-interface
29098 description: String that identifies the interface
29101 example: __VLAN-INTERFACE__
29104 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
29107 $ref: "#/definitions/relationship"
29111 summary: delete an existing relationship
29112 description: delete an existing relationship
29113 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
29122 description: Response codes found in [response codes](https://wiki.onap.org/).
29126 description: Unique id of VNF. This is unique across the graph.
29129 example: __VNF-ID__
29130 - name: interface-name
29132 description: Name that identifies the link aggregate interface
29135 example: __INTERFACE-NAME__
29136 - name: interface-name
29138 description: Name given to the interface
29141 example: __INTERFACE-NAME__
29142 - name: vlan-interface
29144 description: String that identifies the interface
29147 example: __VLAN-INTERFACE__
29148 /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:
29152 summary: see node definition for valid relationships
29153 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
29162 description: Response codes found in [response codes](https://wiki.onap.org/).
29166 description: Unique id of VNF. This is unique across the graph.
29169 example: __VNF-ID__
29170 - name: interface-name
29172 description: Name that identifies the link aggregate interface
29175 example: __INTERFACE-NAME__
29176 - name: interface-name
29178 description: Name given to the interface
29181 example: __INTERFACE-NAME__
29182 - name: vlan-interface
29184 description: String that identifies the interface
29187 example: __VLAN-INTERFACE__
29188 - name: l3-interface-ipv4-address
29190 description: IP address
29193 example: __L3-INTERFACE-IPV4-ADDRESS__
29196 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
29199 $ref: "#/definitions/relationship"
29203 summary: delete an existing relationship
29204 description: delete an existing relationship
29205 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
29214 description: Response codes found in [response codes](https://wiki.onap.org/).
29218 description: Unique id of VNF. This is unique across the graph.
29221 example: __VNF-ID__
29222 - name: interface-name
29224 description: Name that identifies the link aggregate interface
29227 example: __INTERFACE-NAME__
29228 - name: interface-name
29230 description: Name given to the interface
29233 example: __INTERFACE-NAME__
29234 - name: vlan-interface
29236 description: String that identifies the interface
29239 example: __VLAN-INTERFACE__
29240 - name: l3-interface-ipv4-address
29242 description: IP address
29245 example: __L3-INTERFACE-IPV4-ADDRESS__
29246 /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}:
29250 summary: returns l3-interface-ipv4-address-list
29251 description: returns l3-interface-ipv4-address-list
29252 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
29258 description: successful operation
29260 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
29262 description: Response codes found in [response codes](https://wiki.onap.org/).
29266 description: Unique id of VNF. This is unique across the graph.
29269 example: __VNF-ID__
29270 - name: interface-name
29272 description: Name that identifies the link aggregate interface
29275 example: __INTERFACE-NAME__
29276 - name: interface-name
29278 description: Name given to the interface
29281 example: __INTERFACE-NAME__
29282 - name: vlan-interface
29284 description: String that identifies the interface
29287 example: __VLAN-INTERFACE__
29288 - name: l3-interface-ipv4-address
29290 description: IP address
29293 example: __L3-INTERFACE-IPV4-ADDRESS__
29297 summary: create or update an existing l3-interface-ipv4-address-list
29299 Create or update an existing l3-interface-ipv4-address-list.
29301 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29302 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
29311 description: Response codes found in [response codes](https://wiki.onap.org/).
29315 description: Unique id of VNF. This is unique across the graph.
29318 example: __VNF-ID__
29319 - name: interface-name
29321 description: Name that identifies the link aggregate interface
29324 example: __INTERFACE-NAME__
29325 - name: interface-name
29327 description: Name given to the interface
29330 example: __INTERFACE-NAME__
29331 - name: vlan-interface
29333 description: String that identifies the interface
29336 example: __VLAN-INTERFACE__
29337 - name: l3-interface-ipv4-address
29339 description: IP address
29342 example: __L3-INTERFACE-IPV4-ADDRESS__
29345 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
29348 $ref: "#/definitions/l3-interface-ipv4-address-list"
29352 summary: update an existing l3-interface-ipv4-address-list
29354 Update an existing l3-interface-ipv4-address-list
29356 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29357 The PUT operation will entirely replace an existing object.
29358 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29360 Other differences between PUT and PATCH are:
29362 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29363 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29364 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29365 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
29374 description: Response codes found in [response codes](https://wiki.onap.org/).
29378 description: Unique id of VNF. This is unique across the graph.
29381 example: __VNF-ID__
29382 - name: interface-name
29384 description: Name that identifies the link aggregate interface
29387 example: __INTERFACE-NAME__
29388 - name: interface-name
29390 description: Name given to the interface
29393 example: __INTERFACE-NAME__
29394 - name: vlan-interface
29396 description: String that identifies the interface
29399 example: __VLAN-INTERFACE__
29400 - name: l3-interface-ipv4-address
29402 description: IP address
29405 example: __L3-INTERFACE-IPV4-ADDRESS__
29408 description: l3-interface-ipv4-address-list object that needs to be updated.
29411 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
29415 summary: delete an existing l3-interface-ipv4-address-list
29416 description: delete an existing l3-interface-ipv4-address-list
29417 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
29426 description: Response codes found in [response codes](https://wiki.onap.org/).
29430 description: Unique id of VNF. This is unique across the graph.
29433 example: __VNF-ID__
29434 - name: interface-name
29436 description: Name that identifies the link aggregate interface
29439 example: __INTERFACE-NAME__
29440 - name: interface-name
29442 description: Name given to the interface
29445 example: __INTERFACE-NAME__
29446 - name: vlan-interface
29448 description: String that identifies the interface
29451 example: __VLAN-INTERFACE__
29452 - name: l3-interface-ipv4-address
29454 description: IP address
29457 example: __L3-INTERFACE-IPV4-ADDRESS__
29458 - name: resource-version
29460 description: resource-version for concurrency
29463 /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:
29467 summary: see node definition for valid relationships
29468 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
29477 description: Response codes found in [response codes](https://wiki.onap.org/).
29481 description: Unique id of VNF. This is unique across the graph.
29484 example: __VNF-ID__
29485 - name: interface-name
29487 description: Name that identifies the link aggregate interface
29490 example: __INTERFACE-NAME__
29491 - name: interface-name
29493 description: Name given to the interface
29496 example: __INTERFACE-NAME__
29497 - name: vlan-interface
29499 description: String that identifies the interface
29502 example: __VLAN-INTERFACE__
29503 - name: l3-interface-ipv6-address
29505 description: IP address
29508 example: __L3-INTERFACE-IPV6-ADDRESS__
29511 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
29514 $ref: "#/definitions/relationship"
29518 summary: delete an existing relationship
29519 description: delete an existing relationship
29520 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
29529 description: Response codes found in [response codes](https://wiki.onap.org/).
29533 description: Unique id of VNF. This is unique across the graph.
29536 example: __VNF-ID__
29537 - name: interface-name
29539 description: Name that identifies the link aggregate interface
29542 example: __INTERFACE-NAME__
29543 - name: interface-name
29545 description: Name given to the interface
29548 example: __INTERFACE-NAME__
29549 - name: vlan-interface
29551 description: String that identifies the interface
29554 example: __VLAN-INTERFACE__
29555 - name: l3-interface-ipv6-address
29557 description: IP address
29560 example: __L3-INTERFACE-IPV6-ADDRESS__
29561 /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}:
29565 summary: returns l3-interface-ipv6-address-list
29566 description: returns l3-interface-ipv6-address-list
29567 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
29573 description: successful operation
29575 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
29577 description: Response codes found in [response codes](https://wiki.onap.org/).
29581 description: Unique id of VNF. This is unique across the graph.
29584 example: __VNF-ID__
29585 - name: interface-name
29587 description: Name that identifies the link aggregate interface
29590 example: __INTERFACE-NAME__
29591 - name: interface-name
29593 description: Name given to the interface
29596 example: __INTERFACE-NAME__
29597 - name: vlan-interface
29599 description: String that identifies the interface
29602 example: __VLAN-INTERFACE__
29603 - name: l3-interface-ipv6-address
29605 description: IP address
29608 example: __L3-INTERFACE-IPV6-ADDRESS__
29612 summary: create or update an existing l3-interface-ipv6-address-list
29614 Create or update an existing l3-interface-ipv6-address-list.
29616 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29617 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
29626 description: Response codes found in [response codes](https://wiki.onap.org/).
29630 description: Unique id of VNF. This is unique across the graph.
29633 example: __VNF-ID__
29634 - name: interface-name
29636 description: Name that identifies the link aggregate interface
29639 example: __INTERFACE-NAME__
29640 - name: interface-name
29642 description: Name given to the interface
29645 example: __INTERFACE-NAME__
29646 - name: vlan-interface
29648 description: String that identifies the interface
29651 example: __VLAN-INTERFACE__
29652 - name: l3-interface-ipv6-address
29654 description: IP address
29657 example: __L3-INTERFACE-IPV6-ADDRESS__
29660 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
29663 $ref: "#/definitions/l3-interface-ipv6-address-list"
29667 summary: update an existing l3-interface-ipv6-address-list
29669 Update an existing l3-interface-ipv6-address-list
29671 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29672 The PUT operation will entirely replace an existing object.
29673 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29675 Other differences between PUT and PATCH are:
29677 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29678 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29679 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29680 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
29689 description: Response codes found in [response codes](https://wiki.onap.org/).
29693 description: Unique id of VNF. This is unique across the graph.
29696 example: __VNF-ID__
29697 - name: interface-name
29699 description: Name that identifies the link aggregate interface
29702 example: __INTERFACE-NAME__
29703 - name: interface-name
29705 description: Name given to the interface
29708 example: __INTERFACE-NAME__
29709 - name: vlan-interface
29711 description: String that identifies the interface
29714 example: __VLAN-INTERFACE__
29715 - name: l3-interface-ipv6-address
29717 description: IP address
29720 example: __L3-INTERFACE-IPV6-ADDRESS__
29723 description: l3-interface-ipv6-address-list object that needs to be updated.
29726 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
29730 summary: delete an existing l3-interface-ipv6-address-list
29731 description: delete an existing l3-interface-ipv6-address-list
29732 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
29741 description: Response codes found in [response codes](https://wiki.onap.org/).
29745 description: Unique id of VNF. This is unique across the graph.
29748 example: __VNF-ID__
29749 - name: interface-name
29751 description: Name that identifies the link aggregate interface
29754 example: __INTERFACE-NAME__
29755 - name: interface-name
29757 description: Name given to the interface
29760 example: __INTERFACE-NAME__
29761 - name: vlan-interface
29763 description: String that identifies the interface
29766 example: __VLAN-INTERFACE__
29767 - name: l3-interface-ipv6-address
29769 description: IP address
29772 example: __L3-INTERFACE-IPV6-ADDRESS__
29773 - name: resource-version
29775 description: resource-version for concurrency
29778 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
29782 summary: returns vlan
29783 description: returns vlan
29784 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
29790 description: successful operation
29792 $ref: "#/getDefinitions/vlan"
29794 description: Response codes found in [response codes](https://wiki.onap.org/).
29798 description: Unique id of VNF. This is unique across the graph.
29801 example: __VNF-ID__
29802 - name: interface-name
29804 description: Name that identifies the link aggregate interface
29807 example: __INTERFACE-NAME__
29808 - name: interface-name
29810 description: Name given to the interface
29813 example: __INTERFACE-NAME__
29814 - name: vlan-interface
29816 description: String that identifies the interface
29819 example: __VLAN-INTERFACE__
29823 summary: create or update an existing vlan
29825 Create or update an existing vlan.
29827 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29828 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
29837 description: Response codes found in [response codes](https://wiki.onap.org/).
29841 description: Unique id of VNF. This is unique across the graph.
29844 example: __VNF-ID__
29845 - name: interface-name
29847 description: Name that identifies the link aggregate interface
29850 example: __INTERFACE-NAME__
29851 - name: interface-name
29853 description: Name given to the interface
29856 example: __INTERFACE-NAME__
29857 - name: vlan-interface
29859 description: String that identifies the interface
29862 example: __VLAN-INTERFACE__
29865 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
29868 $ref: "#/definitions/vlan"
29872 summary: update an existing vlan
29874 Update an existing vlan
29876 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29877 The PUT operation will entirely replace an existing object.
29878 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29880 Other differences between PUT and PATCH are:
29882 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29883 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29884 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29885 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
29894 description: Response codes found in [response codes](https://wiki.onap.org/).
29898 description: Unique id of VNF. This is unique across the graph.
29901 example: __VNF-ID__
29902 - name: interface-name
29904 description: Name that identifies the link aggregate interface
29907 example: __INTERFACE-NAME__
29908 - name: interface-name
29910 description: Name given to the interface
29913 example: __INTERFACE-NAME__
29914 - name: vlan-interface
29916 description: String that identifies the interface
29919 example: __VLAN-INTERFACE__
29922 description: vlan object that needs to be updated.
29925 $ref: "#/patchDefinitions/vlan"
29929 summary: delete an existing vlan
29930 description: delete an existing vlan
29931 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
29940 description: Response codes found in [response codes](https://wiki.onap.org/).
29944 description: Unique id of VNF. This is unique across the graph.
29947 example: __VNF-ID__
29948 - name: interface-name
29950 description: Name that identifies the link aggregate interface
29953 example: __INTERFACE-NAME__
29954 - name: interface-name
29956 description: Name given to the interface
29959 example: __INTERFACE-NAME__
29960 - name: vlan-interface
29962 description: String that identifies the interface
29965 example: __VLAN-INTERFACE__
29966 - name: resource-version
29968 description: resource-version for concurrency
29971 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
29975 summary: returns vlans
29976 description: returns vlans
29977 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
29983 description: successful operation
29985 $ref: "#/getDefinitions/vlans"
29987 description: Response codes found in [response codes](https://wiki.onap.org/).
29991 description: Unique id of VNF. This is unique across the graph.
29994 example: __VNF-ID__
29995 - name: interface-name
29997 description: Name that identifies the link aggregate interface
30000 example: __INTERFACE-NAME__
30001 - name: interface-name
30003 description: Name given to the interface
30006 example: __INTERFACE-NAME__
30007 - name: vlan-interface
30012 - name: vlan-id-inner
30023 /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:
30027 summary: see node definition for valid relationships
30028 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
30037 description: Response codes found in [response codes](https://wiki.onap.org/).
30041 description: Unique id of VNF. This is unique across the graph.
30044 example: __VNF-ID__
30045 - name: interface-name
30047 description: Name that identifies the link aggregate interface
30050 example: __INTERFACE-NAME__
30051 - name: interface-name
30053 description: Name given to the interface
30056 example: __INTERFACE-NAME__
30059 description: PCI ID used to identify the sriov-vf
30062 example: __PCI-ID__
30065 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
30068 $ref: "#/definitions/relationship"
30072 summary: delete an existing relationship
30073 description: delete an existing relationship
30074 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
30083 description: Response codes found in [response codes](https://wiki.onap.org/).
30087 description: Unique id of VNF. This is unique across the graph.
30090 example: __VNF-ID__
30091 - name: interface-name
30093 description: Name that identifies the link aggregate interface
30096 example: __INTERFACE-NAME__
30097 - name: interface-name
30099 description: Name given to the interface
30102 example: __INTERFACE-NAME__
30105 description: PCI ID used to identify the sriov-vf
30108 example: __PCI-ID__
30109 /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}:
30113 summary: returns sriov-vf
30114 description: returns sriov-vf
30115 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
30121 description: successful operation
30123 $ref: "#/getDefinitions/sriov-vf"
30125 description: Response codes found in [response codes](https://wiki.onap.org/).
30129 description: Unique id of VNF. This is unique across the graph.
30132 example: __VNF-ID__
30133 - name: interface-name
30135 description: Name that identifies the link aggregate interface
30138 example: __INTERFACE-NAME__
30139 - name: interface-name
30141 description: Name given to the interface
30144 example: __INTERFACE-NAME__
30147 description: PCI ID used to identify the sriov-vf
30150 example: __PCI-ID__
30154 summary: create or update an existing sriov-vf
30156 Create or update an existing sriov-vf.
30158 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30159 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
30168 description: Response codes found in [response codes](https://wiki.onap.org/).
30172 description: Unique id of VNF. This is unique across the graph.
30175 example: __VNF-ID__
30176 - name: interface-name
30178 description: Name that identifies the link aggregate interface
30181 example: __INTERFACE-NAME__
30182 - name: interface-name
30184 description: Name given to the interface
30187 example: __INTERFACE-NAME__
30190 description: PCI ID used to identify the sriov-vf
30193 example: __PCI-ID__
30196 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
30199 $ref: "#/definitions/sriov-vf"
30203 summary: update an existing sriov-vf
30205 Update an existing sriov-vf
30207 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30208 The PUT operation will entirely replace an existing object.
30209 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30211 Other differences between PUT and PATCH are:
30213 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30214 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30215 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30216 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
30225 description: Response codes found in [response codes](https://wiki.onap.org/).
30229 description: Unique id of VNF. This is unique across the graph.
30232 example: __VNF-ID__
30233 - name: interface-name
30235 description: Name that identifies the link aggregate interface
30238 example: __INTERFACE-NAME__
30239 - name: interface-name
30241 description: Name given to the interface
30244 example: __INTERFACE-NAME__
30247 description: PCI ID used to identify the sriov-vf
30250 example: __PCI-ID__
30253 description: sriov-vf object that needs to be updated.
30256 $ref: "#/patchDefinitions/sriov-vf"
30260 summary: delete an existing sriov-vf
30261 description: delete an existing sriov-vf
30262 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
30271 description: Response codes found in [response codes](https://wiki.onap.org/).
30275 description: Unique id of VNF. This is unique across the graph.
30278 example: __VNF-ID__
30279 - name: interface-name
30281 description: Name that identifies the link aggregate interface
30284 example: __INTERFACE-NAME__
30285 - name: interface-name
30287 description: Name given to the interface
30290 example: __INTERFACE-NAME__
30293 description: PCI ID used to identify the sriov-vf
30296 example: __PCI-ID__
30297 - name: resource-version
30299 description: resource-version for concurrency
30302 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
30306 summary: returns sriov-vfs
30307 description: returns sriov-vfs
30308 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
30314 description: successful operation
30316 $ref: "#/getDefinitions/sriov-vfs"
30318 description: Response codes found in [response codes](https://wiki.onap.org/).
30322 description: Unique id of VNF. This is unique across the graph.
30325 example: __VNF-ID__
30326 - name: interface-name
30328 description: Name that identifies the link aggregate interface
30331 example: __INTERFACE-NAME__
30332 - name: interface-name
30334 description: Name given to the interface
30337 example: __INTERFACE-NAME__
30343 - name: vf-vlan-filter
30348 - name: vf-mac-filter
30353 - name: vf-vlan-strip
30358 - name: neutron-network-id
30363 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
30367 summary: see node definition for valid relationships
30368 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
30377 description: Response codes found in [response codes](https://wiki.onap.org/).
30381 description: Unique id of VNF. This is unique across the graph.
30384 example: __VNF-ID__
30385 - name: interface-name
30387 description: Name that identifies the link aggregate interface
30390 example: __INTERFACE-NAME__
30391 - name: interface-name
30393 description: Name given to the interface
30396 example: __INTERFACE-NAME__
30399 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
30402 $ref: "#/definitions/relationship"
30406 summary: delete an existing relationship
30407 description: delete an existing relationship
30408 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
30417 description: Response codes found in [response codes](https://wiki.onap.org/).
30421 description: Unique id of VNF. This is unique across the graph.
30424 example: __VNF-ID__
30425 - name: interface-name
30427 description: Name that identifies the link aggregate interface
30430 example: __INTERFACE-NAME__
30431 - name: interface-name
30433 description: Name given to the interface
30436 example: __INTERFACE-NAME__
30437 /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:
30441 summary: see node definition for valid relationships
30442 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
30451 description: Response codes found in [response codes](https://wiki.onap.org/).
30455 description: Unique id of VNF. This is unique across the graph.
30458 example: __VNF-ID__
30459 - name: interface-name
30461 description: Name that identifies the link aggregate interface
30464 example: __INTERFACE-NAME__
30465 - name: interface-name
30467 description: Name given to the interface
30470 example: __INTERFACE-NAME__
30471 - name: l3-interface-ipv4-address
30473 description: IP address
30476 example: __L3-INTERFACE-IPV4-ADDRESS__
30479 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
30482 $ref: "#/definitions/relationship"
30486 summary: delete an existing relationship
30487 description: delete an existing relationship
30488 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
30497 description: Response codes found in [response codes](https://wiki.onap.org/).
30501 description: Unique id of VNF. This is unique across the graph.
30504 example: __VNF-ID__
30505 - name: interface-name
30507 description: Name that identifies the link aggregate interface
30510 example: __INTERFACE-NAME__
30511 - name: interface-name
30513 description: Name given to the interface
30516 example: __INTERFACE-NAME__
30517 - name: l3-interface-ipv4-address
30519 description: IP address
30522 example: __L3-INTERFACE-IPV4-ADDRESS__
30523 /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}:
30527 summary: returns l3-interface-ipv4-address-list
30528 description: returns l3-interface-ipv4-address-list
30529 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
30535 description: successful operation
30537 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
30539 description: Response codes found in [response codes](https://wiki.onap.org/).
30543 description: Unique id of VNF. This is unique across the graph.
30546 example: __VNF-ID__
30547 - name: interface-name
30549 description: Name that identifies the link aggregate interface
30552 example: __INTERFACE-NAME__
30553 - name: interface-name
30555 description: Name given to the interface
30558 example: __INTERFACE-NAME__
30559 - name: l3-interface-ipv4-address
30561 description: IP address
30564 example: __L3-INTERFACE-IPV4-ADDRESS__
30568 summary: create or update an existing l3-interface-ipv4-address-list
30570 Create or update an existing l3-interface-ipv4-address-list.
30572 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30573 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
30582 description: Response codes found in [response codes](https://wiki.onap.org/).
30586 description: Unique id of VNF. This is unique across the graph.
30589 example: __VNF-ID__
30590 - name: interface-name
30592 description: Name that identifies the link aggregate interface
30595 example: __INTERFACE-NAME__
30596 - name: interface-name
30598 description: Name given to the interface
30601 example: __INTERFACE-NAME__
30602 - name: l3-interface-ipv4-address
30604 description: IP address
30607 example: __L3-INTERFACE-IPV4-ADDRESS__
30610 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
30613 $ref: "#/definitions/l3-interface-ipv4-address-list"
30617 summary: update an existing l3-interface-ipv4-address-list
30619 Update an existing l3-interface-ipv4-address-list
30621 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30622 The PUT operation will entirely replace an existing object.
30623 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30625 Other differences between PUT and PATCH are:
30627 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30628 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30629 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30630 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
30639 description: Response codes found in [response codes](https://wiki.onap.org/).
30643 description: Unique id of VNF. This is unique across the graph.
30646 example: __VNF-ID__
30647 - name: interface-name
30649 description: Name that identifies the link aggregate interface
30652 example: __INTERFACE-NAME__
30653 - name: interface-name
30655 description: Name given to the interface
30658 example: __INTERFACE-NAME__
30659 - name: l3-interface-ipv4-address
30661 description: IP address
30664 example: __L3-INTERFACE-IPV4-ADDRESS__
30667 description: l3-interface-ipv4-address-list object that needs to be updated.
30670 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
30674 summary: delete an existing l3-interface-ipv4-address-list
30675 description: delete an existing l3-interface-ipv4-address-list
30676 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
30685 description: Response codes found in [response codes](https://wiki.onap.org/).
30689 description: Unique id of VNF. This is unique across the graph.
30692 example: __VNF-ID__
30693 - name: interface-name
30695 description: Name that identifies the link aggregate interface
30698 example: __INTERFACE-NAME__
30699 - name: interface-name
30701 description: Name given to the interface
30704 example: __INTERFACE-NAME__
30705 - name: l3-interface-ipv4-address
30707 description: IP address
30710 example: __L3-INTERFACE-IPV4-ADDRESS__
30711 - name: resource-version
30713 description: resource-version for concurrency
30716 /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:
30720 summary: see node definition for valid relationships
30721 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
30730 description: Response codes found in [response codes](https://wiki.onap.org/).
30734 description: Unique id of VNF. This is unique across the graph.
30737 example: __VNF-ID__
30738 - name: interface-name
30740 description: Name that identifies the link aggregate interface
30743 example: __INTERFACE-NAME__
30744 - name: interface-name
30746 description: Name given to the interface
30749 example: __INTERFACE-NAME__
30750 - name: l3-interface-ipv6-address
30752 description: IP address
30755 example: __L3-INTERFACE-IPV6-ADDRESS__
30758 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
30761 $ref: "#/definitions/relationship"
30765 summary: delete an existing relationship
30766 description: delete an existing relationship
30767 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
30776 description: Response codes found in [response codes](https://wiki.onap.org/).
30780 description: Unique id of VNF. This is unique across the graph.
30783 example: __VNF-ID__
30784 - name: interface-name
30786 description: Name that identifies the link aggregate interface
30789 example: __INTERFACE-NAME__
30790 - name: interface-name
30792 description: Name given to the interface
30795 example: __INTERFACE-NAME__
30796 - name: l3-interface-ipv6-address
30798 description: IP address
30801 example: __L3-INTERFACE-IPV6-ADDRESS__
30802 /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}:
30806 summary: returns l3-interface-ipv6-address-list
30807 description: returns l3-interface-ipv6-address-list
30808 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
30814 description: successful operation
30816 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
30818 description: Response codes found in [response codes](https://wiki.onap.org/).
30822 description: Unique id of VNF. This is unique across the graph.
30825 example: __VNF-ID__
30826 - name: interface-name
30828 description: Name that identifies the link aggregate interface
30831 example: __INTERFACE-NAME__
30832 - name: interface-name
30834 description: Name given to the interface
30837 example: __INTERFACE-NAME__
30838 - name: l3-interface-ipv6-address
30840 description: IP address
30843 example: __L3-INTERFACE-IPV6-ADDRESS__
30847 summary: create or update an existing l3-interface-ipv6-address-list
30849 Create or update an existing l3-interface-ipv6-address-list.
30851 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30852 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
30861 description: Response codes found in [response codes](https://wiki.onap.org/).
30865 description: Unique id of VNF. This is unique across the graph.
30868 example: __VNF-ID__
30869 - name: interface-name
30871 description: Name that identifies the link aggregate interface
30874 example: __INTERFACE-NAME__
30875 - name: interface-name
30877 description: Name given to the interface
30880 example: __INTERFACE-NAME__
30881 - name: l3-interface-ipv6-address
30883 description: IP address
30886 example: __L3-INTERFACE-IPV6-ADDRESS__
30889 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
30892 $ref: "#/definitions/l3-interface-ipv6-address-list"
30896 summary: update an existing l3-interface-ipv6-address-list
30898 Update an existing l3-interface-ipv6-address-list
30900 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30901 The PUT operation will entirely replace an existing object.
30902 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30904 Other differences between PUT and PATCH are:
30906 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30907 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30908 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30909 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
30918 description: Response codes found in [response codes](https://wiki.onap.org/).
30922 description: Unique id of VNF. This is unique across the graph.
30925 example: __VNF-ID__
30926 - name: interface-name
30928 description: Name that identifies the link aggregate interface
30931 example: __INTERFACE-NAME__
30932 - name: interface-name
30934 description: Name given to the interface
30937 example: __INTERFACE-NAME__
30938 - name: l3-interface-ipv6-address
30940 description: IP address
30943 example: __L3-INTERFACE-IPV6-ADDRESS__
30946 description: l3-interface-ipv6-address-list object that needs to be updated.
30949 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
30953 summary: delete an existing l3-interface-ipv6-address-list
30954 description: delete an existing l3-interface-ipv6-address-list
30955 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
30964 description: Response codes found in [response codes](https://wiki.onap.org/).
30968 description: Unique id of VNF. This is unique across the graph.
30971 example: __VNF-ID__
30972 - name: interface-name
30974 description: Name that identifies the link aggregate interface
30977 example: __INTERFACE-NAME__
30978 - name: interface-name
30980 description: Name given to the interface
30983 example: __INTERFACE-NAME__
30984 - name: l3-interface-ipv6-address
30986 description: IP address
30989 example: __L3-INTERFACE-IPV6-ADDRESS__
30990 - name: resource-version
30992 description: resource-version for concurrency
30995 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
30999 summary: returns l-interface
31000 description: returns l-interface
31001 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
31007 description: successful operation
31009 $ref: "#/getDefinitions/l-interface"
31011 description: Response codes found in [response codes](https://wiki.onap.org/).
31015 description: Unique id of VNF. This is unique across the graph.
31018 example: __VNF-ID__
31019 - name: interface-name
31021 description: Name that identifies the link aggregate interface
31024 example: __INTERFACE-NAME__
31025 - name: interface-name
31027 description: Name given to the interface
31030 example: __INTERFACE-NAME__
31034 summary: create or update an existing l-interface
31036 Create or update an existing l-interface.
31038 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31039 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
31048 description: Response codes found in [response codes](https://wiki.onap.org/).
31052 description: Unique id of VNF. This is unique across the graph.
31055 example: __VNF-ID__
31056 - name: interface-name
31058 description: Name that identifies the link aggregate interface
31061 example: __INTERFACE-NAME__
31062 - name: interface-name
31064 description: Name given to the interface
31067 example: __INTERFACE-NAME__
31070 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
31073 $ref: "#/definitions/l-interface"
31077 summary: update an existing l-interface
31079 Update an existing l-interface
31081 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31082 The PUT operation will entirely replace an existing object.
31083 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31085 Other differences between PUT and PATCH are:
31087 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31088 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31089 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31090 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
31099 description: Response codes found in [response codes](https://wiki.onap.org/).
31103 description: Unique id of VNF. This is unique across the graph.
31106 example: __VNF-ID__
31107 - name: interface-name
31109 description: Name that identifies the link aggregate interface
31112 example: __INTERFACE-NAME__
31113 - name: interface-name
31115 description: Name given to the interface
31118 example: __INTERFACE-NAME__
31121 description: l-interface object that needs to be updated.
31124 $ref: "#/patchDefinitions/l-interface"
31128 summary: delete an existing l-interface
31129 description: delete an existing l-interface
31130 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
31139 description: Response codes found in [response codes](https://wiki.onap.org/).
31143 description: Unique id of VNF. This is unique across the graph.
31146 example: __VNF-ID__
31147 - name: interface-name
31149 description: Name that identifies the link aggregate interface
31152 example: __INTERFACE-NAME__
31153 - name: interface-name
31155 description: Name given to the interface
31158 example: __INTERFACE-NAME__
31159 - name: resource-version
31161 description: resource-version for concurrency
31164 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
31168 summary: returns l-interfaces
31169 description: returns l-interfaces
31170 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces
31176 description: successful operation
31178 $ref: "#/getDefinitions/l-interfaces"
31180 description: Response codes found in [response codes](https://wiki.onap.org/).
31184 description: Unique id of VNF. This is unique across the graph.
31187 example: __VNF-ID__
31188 - name: interface-name
31190 description: Name that identifies the link aggregate interface
31193 example: __INTERFACE-NAME__
31194 - name: interface-name
31199 - name: interface-id
31209 - name: network-name
31214 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}:
31218 summary: returns lag-interface
31219 description: returns lag-interface
31220 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
31226 description: successful operation
31228 $ref: "#/getDefinitions/lag-interface"
31230 description: Response codes found in [response codes](https://wiki.onap.org/).
31234 description: Unique id of VNF. This is unique across the graph.
31237 example: __VNF-ID__
31238 - name: interface-name
31240 description: Name that identifies the link aggregate interface
31243 example: __INTERFACE-NAME__
31247 summary: create or update an existing lag-interface
31249 Create or update an existing lag-interface.
31251 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31252 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
31261 description: Response codes found in [response codes](https://wiki.onap.org/).
31265 description: Unique id of VNF. This is unique across the graph.
31268 example: __VNF-ID__
31269 - name: interface-name
31271 description: Name that identifies the link aggregate interface
31274 example: __INTERFACE-NAME__
31277 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
31280 $ref: "#/definitions/lag-interface"
31284 summary: update an existing lag-interface
31286 Update an existing lag-interface
31288 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31289 The PUT operation will entirely replace an existing object.
31290 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31292 Other differences between PUT and PATCH are:
31294 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31295 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31296 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31297 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
31306 description: Response codes found in [response codes](https://wiki.onap.org/).
31310 description: Unique id of VNF. This is unique across the graph.
31313 example: __VNF-ID__
31314 - name: interface-name
31316 description: Name that identifies the link aggregate interface
31319 example: __INTERFACE-NAME__
31322 description: lag-interface object that needs to be updated.
31325 $ref: "#/patchDefinitions/lag-interface"
31329 summary: delete an existing lag-interface
31330 description: delete an existing lag-interface
31331 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
31340 description: Response codes found in [response codes](https://wiki.onap.org/).
31344 description: Unique id of VNF. This is unique across the graph.
31347 example: __VNF-ID__
31348 - name: interface-name
31350 description: Name that identifies the link aggregate interface
31353 example: __INTERFACE-NAME__
31354 - name: resource-version
31356 description: resource-version for concurrency
31359 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces:
31363 summary: returns lag-interfaces
31364 description: returns lag-interfaces
31365 operationId: getNetworkGenericVnfsGenericVnfLagInterfaces
31371 description: successful operation
31373 $ref: "#/getDefinitions/lag-interfaces"
31375 description: Response codes found in [response codes](https://wiki.onap.org/).
31379 description: Unique id of VNF. This is unique across the graph.
31382 example: __VNF-ID__
31383 - name: interface-name
31388 - name: interface-id
31393 - name: interface-role
31398 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship:
31402 summary: see node definition for valid relationships
31403 operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
31412 description: Response codes found in [response codes](https://wiki.onap.org/).
31416 description: Unique id of VNF. This is unique across the graph.
31419 example: __VNF-ID__
31420 - name: vf-module-id
31422 description: Unique ID of vf-module.
31425 example: __VF-MODULE-ID__
31428 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
31431 $ref: "#/definitions/relationship"
31435 summary: delete an existing relationship
31436 description: delete an existing relationship
31437 operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
31446 description: Response codes found in [response codes](https://wiki.onap.org/).
31450 description: Unique id of VNF. This is unique across the graph.
31453 example: __VNF-ID__
31454 - name: vf-module-id
31456 description: Unique ID of vf-module.
31459 example: __VF-MODULE-ID__
31460 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}:
31464 summary: returns vf-module
31465 description: returns vf-module
31466 operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule
31472 description: successful operation
31474 $ref: "#/getDefinitions/vf-module"
31476 description: Response codes found in [response codes](https://wiki.onap.org/).
31480 description: Unique id of VNF. This is unique across the graph.
31483 example: __VNF-ID__
31484 - name: vf-module-id
31486 description: Unique ID of vf-module.
31489 example: __VF-MODULE-ID__
31493 summary: create or update an existing vf-module
31495 Create or update an existing vf-module.
31497 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31498 operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
31507 description: Response codes found in [response codes](https://wiki.onap.org/).
31511 description: Unique id of VNF. This is unique across the graph.
31514 example: __VNF-ID__
31515 - name: vf-module-id
31517 description: Unique ID of vf-module.
31520 example: __VF-MODULE-ID__
31523 description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
31526 $ref: "#/definitions/vf-module"
31530 summary: update an existing vf-module
31532 Update an existing vf-module
31534 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31535 The PUT operation will entirely replace an existing object.
31536 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31538 Other differences between PUT and PATCH are:
31540 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31541 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31542 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31543 operationId: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
31552 description: Response codes found in [response codes](https://wiki.onap.org/).
31556 description: Unique id of VNF. This is unique across the graph.
31559 example: __VNF-ID__
31560 - name: vf-module-id
31562 description: Unique ID of vf-module.
31565 example: __VF-MODULE-ID__
31568 description: vf-module object that needs to be updated.
31571 $ref: "#/patchDefinitions/vf-module"
31575 summary: delete an existing vf-module
31576 description: delete an existing vf-module
31577 operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule
31586 description: Response codes found in [response codes](https://wiki.onap.org/).
31590 description: Unique id of VNF. This is unique across the graph.
31593 example: __VNF-ID__
31594 - name: vf-module-id
31596 description: Unique ID of vf-module.
31599 example: __VF-MODULE-ID__
31600 - name: resource-version
31602 description: resource-version for concurrency
31605 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules:
31609 summary: returns vf-modules
31610 description: returns vf-modules
31611 operationId: getNetworkGenericVnfsGenericVnfVfModules
31617 description: successful operation
31619 $ref: "#/getDefinitions/vf-modules"
31621 description: Response codes found in [response codes](https://wiki.onap.org/).
31625 description: Unique id of VNF. This is unique across the graph.
31628 example: __VNF-ID__
31629 - name: vf-module-id
31634 - name: vf-module-name
31639 - name: heat-stack-id
31644 - name: persona-model-id
31649 - name: persona-model-version
31654 - name: widget-model-id
31659 - name: widget-model-version
31664 - name: contrail-service-instance-fqdn
31669 /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
31673 summary: see node definition for valid relationships
31674 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
31683 description: Response codes found in [response codes](https://wiki.onap.org/).
31687 description: Unique id of VNF. This is unique across the graph.
31690 example: __VNF-ID__
31693 description: Unique ID for the license group the resource belongs to, should be uuid.
31696 example: __GROUP-UUID__
31697 - name: resource-uuid
31699 description: Unique ID of a license resource.
31702 example: __RESOURCE-UUID__
31705 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLicensesLicense.json)
31708 $ref: "#/definitions/relationship"
31712 summary: delete an existing relationship
31713 description: delete an existing relationship
31714 operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
31723 description: Response codes found in [response codes](https://wiki.onap.org/).
31727 description: Unique id of VNF. This is unique across the graph.
31730 example: __VNF-ID__
31733 description: Unique ID for the license group the resource belongs to, should be uuid.
31736 example: __GROUP-UUID__
31737 - name: resource-uuid
31739 description: Unique ID of a license resource.
31742 example: __RESOURCE-UUID__
31743 /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
31747 summary: returns license
31748 description: returns license
31749 operationId: getNetworkGenericVnfsGenericVnfLicensesLicense
31755 description: successful operation
31757 $ref: "#/getDefinitions/license"
31759 description: Response codes found in [response codes](https://wiki.onap.org/).
31763 description: Unique id of VNF. This is unique across the graph.
31766 example: __VNF-ID__
31769 description: Unique ID for the license group the resource belongs to, should be uuid.
31772 example: __GROUP-UUID__
31773 - name: resource-uuid
31775 description: Unique ID of a license resource.
31778 example: __RESOURCE-UUID__
31782 summary: create or update an existing license
31784 Create or update an existing license.
31786 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31787 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense
31796 description: Response codes found in [response codes](https://wiki.onap.org/).
31800 description: Unique id of VNF. This is unique across the graph.
31803 example: __VNF-ID__
31806 description: Unique ID for the license group the resource belongs to, should be uuid.
31809 example: __GROUP-UUID__
31810 - name: resource-uuid
31812 description: Unique ID of a license resource.
31815 example: __RESOURCE-UUID__
31818 description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLicensesLicense.json)
31821 $ref: "#/definitions/license"
31825 summary: update an existing license
31827 Update an existing license
31829 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31830 The PUT operation will entirely replace an existing object.
31831 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31833 Other differences between PUT and PATCH are:
31835 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31836 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31837 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31838 operationId: UpdateNetworkGenericVnfsGenericVnfLicensesLicense
31847 description: Response codes found in [response codes](https://wiki.onap.org/).
31851 description: Unique id of VNF. This is unique across the graph.
31854 example: __VNF-ID__
31857 description: Unique ID for the license group the resource belongs to, should be uuid.
31860 example: __GROUP-UUID__
31861 - name: resource-uuid
31863 description: Unique ID of a license resource.
31866 example: __RESOURCE-UUID__
31869 description: license object that needs to be updated.
31872 $ref: "#/patchDefinitions/license"
31876 summary: delete an existing license
31877 description: delete an existing license
31878 operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicense
31887 description: Response codes found in [response codes](https://wiki.onap.org/).
31891 description: Unique id of VNF. This is unique across the graph.
31894 example: __VNF-ID__
31897 description: Unique ID for the license group the resource belongs to, should be uuid.
31900 example: __GROUP-UUID__
31901 - name: resource-uuid
31903 description: Unique ID of a license resource.
31906 example: __RESOURCE-UUID__
31907 - name: resource-version
31909 description: resource-version for concurrency
31912 /network/generic-vnfs/generic-vnf/{vnf-id}/licenses:
31916 summary: returns licenses
31917 description: returns licenses
31918 operationId: getNetworkGenericVnfsGenericVnfLicenses
31924 description: successful operation
31926 $ref: "#/getDefinitions/licenses"
31928 description: Response codes found in [response codes](https://wiki.onap.org/).
31932 description: Unique id of VNF. This is unique across the graph.
31935 example: __VNF-ID__
31941 - name: resource-uuid
31946 /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
31950 summary: see node definition for valid relationships
31951 operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
31960 description: Response codes found in [response codes](https://wiki.onap.org/).
31964 description: Unique id of VNF. This is unique across the graph.
31967 example: __VNF-ID__
31970 description: Unique ID for the entitlement group the resource comes from, should be uuid.
31973 example: __GROUP-UUID__
31974 - name: resource-uuid
31976 description: Unique ID of an entitlement resource.
31979 example: __RESOURCE-UUID__
31982 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
31985 $ref: "#/definitions/relationship"
31989 summary: delete an existing relationship
31990 description: delete an existing relationship
31991 operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
32000 description: Response codes found in [response codes](https://wiki.onap.org/).
32004 description: Unique id of VNF. This is unique across the graph.
32007 example: __VNF-ID__
32010 description: Unique ID for the entitlement group the resource comes from, should be uuid.
32013 example: __GROUP-UUID__
32014 - name: resource-uuid
32016 description: Unique ID of an entitlement resource.
32019 example: __RESOURCE-UUID__
32020 /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
32024 summary: returns entitlement
32025 description: returns entitlement
32026 operationId: getNetworkGenericVnfsGenericVnfEntitlementsEntitlement
32032 description: successful operation
32034 $ref: "#/getDefinitions/entitlement"
32036 description: Response codes found in [response codes](https://wiki.onap.org/).
32040 description: Unique id of VNF. This is unique across the graph.
32043 example: __VNF-ID__
32046 description: Unique ID for the entitlement group the resource comes from, should be uuid.
32049 example: __GROUP-UUID__
32050 - name: resource-uuid
32052 description: Unique ID of an entitlement resource.
32055 example: __RESOURCE-UUID__
32059 summary: create or update an existing entitlement
32061 Create or update an existing entitlement.
32063 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32064 operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
32073 description: Response codes found in [response codes](https://wiki.onap.org/).
32077 description: Unique id of VNF. This is unique across the graph.
32080 example: __VNF-ID__
32083 description: Unique ID for the entitlement group the resource comes from, should be uuid.
32086 example: __GROUP-UUID__
32087 - name: resource-uuid
32089 description: Unique ID of an entitlement resource.
32092 example: __RESOURCE-UUID__
32095 description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
32098 $ref: "#/definitions/entitlement"
32102 summary: update an existing entitlement
32104 Update an existing entitlement
32106 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32107 The PUT operation will entirely replace an existing object.
32108 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32110 Other differences between PUT and PATCH are:
32112 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32113 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32114 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32115 operationId: UpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
32124 description: Response codes found in [response codes](https://wiki.onap.org/).
32128 description: Unique id of VNF. This is unique across the graph.
32131 example: __VNF-ID__
32134 description: Unique ID for the entitlement group the resource comes from, should be uuid.
32137 example: __GROUP-UUID__
32138 - name: resource-uuid
32140 description: Unique ID of an entitlement resource.
32143 example: __RESOURCE-UUID__
32146 description: entitlement object that needs to be updated.
32149 $ref: "#/patchDefinitions/entitlement"
32153 summary: delete an existing entitlement
32154 description: delete an existing entitlement
32155 operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlement
32164 description: Response codes found in [response codes](https://wiki.onap.org/).
32168 description: Unique id of VNF. This is unique across the graph.
32171 example: __VNF-ID__
32174 description: Unique ID for the entitlement group the resource comes from, should be uuid.
32177 example: __GROUP-UUID__
32178 - name: resource-uuid
32180 description: Unique ID of an entitlement resource.
32183 example: __RESOURCE-UUID__
32184 - name: resource-version
32186 description: resource-version for concurrency
32189 /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements:
32193 summary: returns entitlements
32194 description: returns entitlements
32195 operationId: getNetworkGenericVnfsGenericVnfEntitlements
32201 description: successful operation
32203 $ref: "#/getDefinitions/entitlements"
32205 description: Response codes found in [response codes](https://wiki.onap.org/).
32209 description: Unique id of VNF. This is unique across the graph.
32212 example: __VNF-ID__
32218 - name: resource-uuid
32223 /network/generic-vnfs/generic-vnf/{vnf-id}:
32227 summary: returns generic-vnf
32228 description: returns generic-vnf
32229 operationId: getNetworkGenericVnfsGenericVnf
32235 description: successful operation
32237 $ref: "#/getDefinitions/generic-vnf"
32239 description: Response codes found in [response codes](https://wiki.onap.org/).
32243 description: Unique id of VNF. This is unique across the graph.
32246 example: __VNF-ID__
32250 summary: create or update an existing generic-vnf
32252 Create or update an existing generic-vnf.
32254 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32255 operationId: createOrUpdateNetworkGenericVnfsGenericVnf
32264 description: Response codes found in [response codes](https://wiki.onap.org/).
32268 description: Unique id of VNF. This is unique across the graph.
32271 example: __VNF-ID__
32274 description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnf.json)
32277 $ref: "#/definitions/generic-vnf"
32281 summary: update an existing generic-vnf
32283 Update an existing generic-vnf
32285 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32286 The PUT operation will entirely replace an existing object.
32287 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32289 Other differences between PUT and PATCH are:
32291 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32292 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32293 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32294 operationId: UpdateNetworkGenericVnfsGenericVnf
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__
32313 description: generic-vnf object that needs to be updated.
32316 $ref: "#/patchDefinitions/generic-vnf"
32320 summary: delete an existing generic-vnf
32321 description: delete an existing generic-vnf
32322 operationId: deleteNetworkGenericVnfsGenericVnf
32331 description: Response codes found in [response codes](https://wiki.onap.org/).
32335 description: Unique id of VNF. This is unique across the graph.
32338 example: __VNF-ID__
32339 - name: resource-version
32341 description: resource-version for concurrency
32344 /network/generic-vnfs:
32348 summary: returns generic-vnfs
32349 description: returns generic-vnfs
32350 operationId: getNetworkGenericVnfs
32356 description: successful operation
32358 $ref: "#/getDefinitions/generic-vnfs"
32360 description: Response codes found in [response codes](https://wiki.onap.org/).
32387 - name: regional-resource-zone
32392 - name: prov-status
32397 - name: heat-stack-id
32407 - name: is-closed-loop-disabled
32412 - name: persona-model-id
32417 - name: persona-model-version
32422 - name: widget-model-id
32427 - name: widget-model-version
32432 /network/lag-links/lag-link/{link-name}/relationship-list/relationship:
32436 summary: see node definition for valid relationships
32437 operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship
32446 description: Response codes found in [response codes](https://wiki.onap.org/).
32450 description: Alphabetical concatenation of lag-interface names
32453 example: __LINK-NAME__
32456 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkLagLinksLagLink.json)
32459 $ref: "#/definitions/relationship"
32463 summary: delete an existing relationship
32464 description: delete an existing relationship
32465 operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship
32474 description: Response codes found in [response codes](https://wiki.onap.org/).
32478 description: Alphabetical concatenation of lag-interface names
32481 example: __LINK-NAME__
32482 /network/lag-links/lag-link/{link-name}:
32486 summary: returns lag-link
32487 description: returns lag-link
32488 operationId: getNetworkLagLinksLagLink
32494 description: successful operation
32496 $ref: "#/getDefinitions/lag-link"
32498 description: Response codes found in [response codes](https://wiki.onap.org/).
32502 description: Alphabetical concatenation of lag-interface names
32505 example: __LINK-NAME__
32509 summary: create or update an existing lag-link
32511 Create or update an existing lag-link.
32513 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32514 operationId: createOrUpdateNetworkLagLinksLagLink
32523 description: Response codes found in [response codes](https://wiki.onap.org/).
32527 description: Alphabetical concatenation of lag-interface names
32530 example: __LINK-NAME__
32533 description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkLagLinksLagLink.json)
32536 $ref: "#/definitions/lag-link"
32540 summary: update an existing lag-link
32542 Update an existing lag-link
32544 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32545 The PUT operation will entirely replace an existing object.
32546 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32548 Other differences between PUT and PATCH are:
32550 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32551 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32552 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32553 operationId: UpdateNetworkLagLinksLagLink
32562 description: Response codes found in [response codes](https://wiki.onap.org/).
32566 description: Alphabetical concatenation of lag-interface names
32569 example: __LINK-NAME__
32572 description: lag-link object that needs to be updated.
32575 $ref: "#/patchDefinitions/lag-link"
32579 summary: delete an existing lag-link
32580 description: delete an existing lag-link
32581 operationId: deleteNetworkLagLinksLagLink
32590 description: Response codes found in [response codes](https://wiki.onap.org/).
32594 description: Alphabetical concatenation of lag-interface names
32597 example: __LINK-NAME__
32598 - name: resource-version
32600 description: resource-version for concurrency
32603 /network/lag-links:
32607 summary: returns lag-links
32608 description: returns lag-links
32609 operationId: getNetworkLagLinks
32615 description: successful operation
32617 $ref: "#/getDefinitions/lag-links"
32619 description: Response codes found in [response codes](https://wiki.onap.org/).
32626 /network/newvces/newvce/{vnf-id2}/relationship-list/relationship:
32630 summary: see node definition for valid relationships
32631 operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship
32640 description: Response codes found in [response codes](https://wiki.onap.org/).
32644 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32647 example: __VNF-ID2__
32650 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvce.json)
32653 $ref: "#/definitions/relationship"
32657 summary: delete an existing relationship
32658 description: delete an existing relationship
32659 operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship
32668 description: Response codes found in [response codes](https://wiki.onap.org/).
32672 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32675 example: __VNF-ID2__
32676 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
32680 summary: see node definition for valid relationships
32681 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
32690 description: Response codes found in [response codes](https://wiki.onap.org/).
32694 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32697 example: __VNF-ID2__
32698 - name: interface-name
32700 description: Name given to the interface
32703 example: __INTERFACE-NAME__
32704 - name: vlan-interface
32706 description: String that identifies the interface
32709 example: __VLAN-INTERFACE__
32712 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
32715 $ref: "#/definitions/relationship"
32719 summary: delete an existing relationship
32720 description: delete an existing relationship
32721 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
32730 description: Response codes found in [response codes](https://wiki.onap.org/).
32734 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32737 example: __VNF-ID2__
32738 - name: interface-name
32740 description: Name given to the interface
32743 example: __INTERFACE-NAME__
32744 - name: vlan-interface
32746 description: String that identifies the interface
32749 example: __VLAN-INTERFACE__
32750 /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:
32754 summary: see node definition for valid relationships
32755 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
32764 description: Response codes found in [response codes](https://wiki.onap.org/).
32768 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32771 example: __VNF-ID2__
32772 - name: interface-name
32774 description: Name given to the interface
32777 example: __INTERFACE-NAME__
32778 - name: vlan-interface
32780 description: String that identifies the interface
32783 example: __VLAN-INTERFACE__
32784 - name: l3-interface-ipv4-address
32786 description: IP address
32789 example: __L3-INTERFACE-IPV4-ADDRESS__
32792 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
32795 $ref: "#/definitions/relationship"
32799 summary: delete an existing relationship
32800 description: delete an existing relationship
32801 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
32810 description: Response codes found in [response codes](https://wiki.onap.org/).
32814 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32817 example: __VNF-ID2__
32818 - name: interface-name
32820 description: Name given to the interface
32823 example: __INTERFACE-NAME__
32824 - name: vlan-interface
32826 description: String that identifies the interface
32829 example: __VLAN-INTERFACE__
32830 - name: l3-interface-ipv4-address
32832 description: IP address
32835 example: __L3-INTERFACE-IPV4-ADDRESS__
32836 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
32840 summary: returns l3-interface-ipv4-address-list
32841 description: returns l3-interface-ipv4-address-list
32842 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
32848 description: successful operation
32850 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
32852 description: Response codes found in [response codes](https://wiki.onap.org/).
32856 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32859 example: __VNF-ID2__
32860 - name: interface-name
32862 description: Name given to the interface
32865 example: __INTERFACE-NAME__
32866 - name: vlan-interface
32868 description: String that identifies the interface
32871 example: __VLAN-INTERFACE__
32872 - name: l3-interface-ipv4-address
32874 description: IP address
32877 example: __L3-INTERFACE-IPV4-ADDRESS__
32881 summary: create or update an existing l3-interface-ipv4-address-list
32883 Create or update an existing l3-interface-ipv4-address-list.
32885 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32886 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
32895 description: Response codes found in [response codes](https://wiki.onap.org/).
32899 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32902 example: __VNF-ID2__
32903 - name: interface-name
32905 description: Name given to the interface
32908 example: __INTERFACE-NAME__
32909 - name: vlan-interface
32911 description: String that identifies the interface
32914 example: __VLAN-INTERFACE__
32915 - name: l3-interface-ipv4-address
32917 description: IP address
32920 example: __L3-INTERFACE-IPV4-ADDRESS__
32923 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
32926 $ref: "#/definitions/l3-interface-ipv4-address-list"
32930 summary: update an existing l3-interface-ipv4-address-list
32932 Update an existing l3-interface-ipv4-address-list
32934 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32935 The PUT operation will entirely replace an existing object.
32936 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32938 Other differences between PUT and PATCH are:
32940 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32941 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32942 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32943 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
32952 description: Response codes found in [response codes](https://wiki.onap.org/).
32956 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
32959 example: __VNF-ID2__
32960 - name: interface-name
32962 description: Name given to the interface
32965 example: __INTERFACE-NAME__
32966 - name: vlan-interface
32968 description: String that identifies the interface
32971 example: __VLAN-INTERFACE__
32972 - name: l3-interface-ipv4-address
32974 description: IP address
32977 example: __L3-INTERFACE-IPV4-ADDRESS__
32980 description: l3-interface-ipv4-address-list object that needs to be updated.
32983 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
32987 summary: delete an existing l3-interface-ipv4-address-list
32988 description: delete an existing l3-interface-ipv4-address-list
32989 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
32998 description: Response codes found in [response codes](https://wiki.onap.org/).
33002 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33005 example: __VNF-ID2__
33006 - name: interface-name
33008 description: Name given to the interface
33011 example: __INTERFACE-NAME__
33012 - name: vlan-interface
33014 description: String that identifies the interface
33017 example: __VLAN-INTERFACE__
33018 - name: l3-interface-ipv4-address
33020 description: IP address
33023 example: __L3-INTERFACE-IPV4-ADDRESS__
33024 - name: resource-version
33026 description: resource-version for concurrency
33029 /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:
33033 summary: see node definition for valid relationships
33034 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
33043 description: Response codes found in [response codes](https://wiki.onap.org/).
33047 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33050 example: __VNF-ID2__
33051 - name: interface-name
33053 description: Name given to the interface
33056 example: __INTERFACE-NAME__
33057 - name: vlan-interface
33059 description: String that identifies the interface
33062 example: __VLAN-INTERFACE__
33063 - name: l3-interface-ipv6-address
33065 description: IP address
33068 example: __L3-INTERFACE-IPV6-ADDRESS__
33071 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
33074 $ref: "#/definitions/relationship"
33078 summary: delete an existing relationship
33079 description: delete an existing relationship
33080 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
33089 description: Response codes found in [response codes](https://wiki.onap.org/).
33093 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33096 example: __VNF-ID2__
33097 - name: interface-name
33099 description: Name given to the interface
33102 example: __INTERFACE-NAME__
33103 - name: vlan-interface
33105 description: String that identifies the interface
33108 example: __VLAN-INTERFACE__
33109 - name: l3-interface-ipv6-address
33111 description: IP address
33114 example: __L3-INTERFACE-IPV6-ADDRESS__
33115 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
33119 summary: returns l3-interface-ipv6-address-list
33120 description: returns l3-interface-ipv6-address-list
33121 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33127 description: successful operation
33129 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
33131 description: Response codes found in [response codes](https://wiki.onap.org/).
33135 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33138 example: __VNF-ID2__
33139 - name: interface-name
33141 description: Name given to the interface
33144 example: __INTERFACE-NAME__
33145 - name: vlan-interface
33147 description: String that identifies the interface
33150 example: __VLAN-INTERFACE__
33151 - name: l3-interface-ipv6-address
33153 description: IP address
33156 example: __L3-INTERFACE-IPV6-ADDRESS__
33160 summary: create or update an existing l3-interface-ipv6-address-list
33162 Create or update an existing l3-interface-ipv6-address-list.
33164 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33165 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33174 description: Response codes found in [response codes](https://wiki.onap.org/).
33178 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33181 example: __VNF-ID2__
33182 - name: interface-name
33184 description: Name given to the interface
33187 example: __INTERFACE-NAME__
33188 - name: vlan-interface
33190 description: String that identifies the interface
33193 example: __VLAN-INTERFACE__
33194 - name: l3-interface-ipv6-address
33196 description: IP address
33199 example: __L3-INTERFACE-IPV6-ADDRESS__
33202 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
33205 $ref: "#/definitions/l3-interface-ipv6-address-list"
33209 summary: update an existing l3-interface-ipv6-address-list
33211 Update an existing l3-interface-ipv6-address-list
33213 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33214 The PUT operation will entirely replace an existing object.
33215 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33217 Other differences between PUT and PATCH are:
33219 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33220 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33221 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33222 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33231 description: Response codes found in [response codes](https://wiki.onap.org/).
33235 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33238 example: __VNF-ID2__
33239 - name: interface-name
33241 description: Name given to the interface
33244 example: __INTERFACE-NAME__
33245 - name: vlan-interface
33247 description: String that identifies the interface
33250 example: __VLAN-INTERFACE__
33251 - name: l3-interface-ipv6-address
33253 description: IP address
33256 example: __L3-INTERFACE-IPV6-ADDRESS__
33259 description: l3-interface-ipv6-address-list object that needs to be updated.
33262 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
33266 summary: delete an existing l3-interface-ipv6-address-list
33267 description: delete an existing l3-interface-ipv6-address-list
33268 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33277 description: Response codes found in [response codes](https://wiki.onap.org/).
33281 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33284 example: __VNF-ID2__
33285 - name: interface-name
33287 description: Name given to the interface
33290 example: __INTERFACE-NAME__
33291 - name: vlan-interface
33293 description: String that identifies the interface
33296 example: __VLAN-INTERFACE__
33297 - name: l3-interface-ipv6-address
33299 description: IP address
33302 example: __L3-INTERFACE-IPV6-ADDRESS__
33303 - name: resource-version
33305 description: resource-version for concurrency
33308 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
33312 summary: returns vlan
33313 description: returns vlan
33314 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
33320 description: successful operation
33322 $ref: "#/getDefinitions/vlan"
33324 description: Response codes found in [response codes](https://wiki.onap.org/).
33328 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33331 example: __VNF-ID2__
33332 - name: interface-name
33334 description: Name given to the interface
33337 example: __INTERFACE-NAME__
33338 - name: vlan-interface
33340 description: String that identifies the interface
33343 example: __VLAN-INTERFACE__
33347 summary: create or update an existing vlan
33349 Create or update an existing vlan.
33351 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33352 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
33361 description: Response codes found in [response codes](https://wiki.onap.org/).
33365 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33368 example: __VNF-ID2__
33369 - name: interface-name
33371 description: Name given to the interface
33374 example: __INTERFACE-NAME__
33375 - name: vlan-interface
33377 description: String that identifies the interface
33380 example: __VLAN-INTERFACE__
33383 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
33386 $ref: "#/definitions/vlan"
33390 summary: update an existing vlan
33392 Update an existing vlan
33394 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33395 The PUT operation will entirely replace an existing object.
33396 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33398 Other differences between PUT and PATCH are:
33400 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33401 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33402 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33403 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
33412 description: Response codes found in [response codes](https://wiki.onap.org/).
33416 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33419 example: __VNF-ID2__
33420 - name: interface-name
33422 description: Name given to the interface
33425 example: __INTERFACE-NAME__
33426 - name: vlan-interface
33428 description: String that identifies the interface
33431 example: __VLAN-INTERFACE__
33434 description: vlan object that needs to be updated.
33437 $ref: "#/patchDefinitions/vlan"
33441 summary: delete an existing vlan
33442 description: delete an existing vlan
33443 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
33452 description: Response codes found in [response codes](https://wiki.onap.org/).
33456 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33459 example: __VNF-ID2__
33460 - name: interface-name
33462 description: Name given to the interface
33465 example: __INTERFACE-NAME__
33466 - name: vlan-interface
33468 description: String that identifies the interface
33471 example: __VLAN-INTERFACE__
33472 - name: resource-version
33474 description: resource-version for concurrency
33477 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans:
33481 summary: returns vlans
33482 description: returns vlans
33483 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans
33489 description: successful operation
33491 $ref: "#/getDefinitions/vlans"
33493 description: Response codes found in [response codes](https://wiki.onap.org/).
33497 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33500 example: __VNF-ID2__
33501 - name: interface-name
33503 description: Name given to the interface
33506 example: __INTERFACE-NAME__
33507 - name: vlan-interface
33512 - name: vlan-id-inner
33523 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
33527 summary: see node definition for valid relationships
33528 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
33537 description: Response codes found in [response codes](https://wiki.onap.org/).
33541 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33544 example: __VNF-ID2__
33545 - name: interface-name
33547 description: Name given to the interface
33550 example: __INTERFACE-NAME__
33553 description: PCI ID used to identify the sriov-vf
33556 example: __PCI-ID__
33559 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
33562 $ref: "#/definitions/relationship"
33566 summary: delete an existing relationship
33567 description: delete an existing relationship
33568 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
33577 description: Response codes found in [response codes](https://wiki.onap.org/).
33581 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33584 example: __VNF-ID2__
33585 - name: interface-name
33587 description: Name given to the interface
33590 example: __INTERFACE-NAME__
33593 description: PCI ID used to identify the sriov-vf
33596 example: __PCI-ID__
33597 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
33601 summary: returns sriov-vf
33602 description: returns sriov-vf
33603 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
33609 description: successful operation
33611 $ref: "#/getDefinitions/sriov-vf"
33613 description: Response codes found in [response codes](https://wiki.onap.org/).
33617 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33620 example: __VNF-ID2__
33621 - name: interface-name
33623 description: Name given to the interface
33626 example: __INTERFACE-NAME__
33629 description: PCI ID used to identify the sriov-vf
33632 example: __PCI-ID__
33636 summary: create or update an existing sriov-vf
33638 Create or update an existing sriov-vf.
33640 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33641 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
33650 description: Response codes found in [response codes](https://wiki.onap.org/).
33654 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33657 example: __VNF-ID2__
33658 - name: interface-name
33660 description: Name given to the interface
33663 example: __INTERFACE-NAME__
33666 description: PCI ID used to identify the sriov-vf
33669 example: __PCI-ID__
33672 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
33675 $ref: "#/definitions/sriov-vf"
33679 summary: update an existing sriov-vf
33681 Update an existing sriov-vf
33683 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33684 The PUT operation will entirely replace an existing object.
33685 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33687 Other differences between PUT and PATCH are:
33689 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33690 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33691 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33692 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
33701 description: Response codes found in [response codes](https://wiki.onap.org/).
33705 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33708 example: __VNF-ID2__
33709 - name: interface-name
33711 description: Name given to the interface
33714 example: __INTERFACE-NAME__
33717 description: PCI ID used to identify the sriov-vf
33720 example: __PCI-ID__
33723 description: sriov-vf object that needs to be updated.
33726 $ref: "#/patchDefinitions/sriov-vf"
33730 summary: delete an existing sriov-vf
33731 description: delete an existing sriov-vf
33732 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
33741 description: Response codes found in [response codes](https://wiki.onap.org/).
33745 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33748 example: __VNF-ID2__
33749 - name: interface-name
33751 description: Name given to the interface
33754 example: __INTERFACE-NAME__
33757 description: PCI ID used to identify the sriov-vf
33760 example: __PCI-ID__
33761 - name: resource-version
33763 description: resource-version for concurrency
33766 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
33770 summary: returns sriov-vfs
33771 description: returns sriov-vfs
33772 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs
33778 description: successful operation
33780 $ref: "#/getDefinitions/sriov-vfs"
33782 description: Response codes found in [response codes](https://wiki.onap.org/).
33786 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33789 example: __VNF-ID2__
33790 - name: interface-name
33792 description: Name given to the interface
33795 example: __INTERFACE-NAME__
33801 - name: vf-vlan-filter
33806 - name: vf-mac-filter
33811 - name: vf-vlan-strip
33816 - name: neutron-network-id
33821 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
33825 summary: see node definition for valid relationships
33826 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
33835 description: Response codes found in [response codes](https://wiki.onap.org/).
33839 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33842 example: __VNF-ID2__
33843 - name: interface-name
33845 description: Name given to the interface
33848 example: __INTERFACE-NAME__
33851 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterface.json)
33854 $ref: "#/definitions/relationship"
33858 summary: delete an existing relationship
33859 description: delete an existing relationship
33860 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
33869 description: Response codes found in [response codes](https://wiki.onap.org/).
33873 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33876 example: __VNF-ID2__
33877 - name: interface-name
33879 description: Name given to the interface
33882 example: __INTERFACE-NAME__
33883 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
33887 summary: see node definition for valid relationships
33888 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
33897 description: Response codes found in [response codes](https://wiki.onap.org/).
33901 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33904 example: __VNF-ID2__
33905 - name: interface-name
33907 description: Name given to the interface
33910 example: __INTERFACE-NAME__
33911 - name: l3-interface-ipv4-address
33913 description: IP address
33916 example: __L3-INTERFACE-IPV4-ADDRESS__
33919 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
33922 $ref: "#/definitions/relationship"
33926 summary: delete an existing relationship
33927 description: delete an existing relationship
33928 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
33937 description: Response codes found in [response codes](https://wiki.onap.org/).
33941 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33944 example: __VNF-ID2__
33945 - name: interface-name
33947 description: Name given to the interface
33950 example: __INTERFACE-NAME__
33951 - name: l3-interface-ipv4-address
33953 description: IP address
33956 example: __L3-INTERFACE-IPV4-ADDRESS__
33957 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
33961 summary: returns l3-interface-ipv4-address-list
33962 description: returns l3-interface-ipv4-address-list
33963 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
33969 description: successful operation
33971 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
33973 description: Response codes found in [response codes](https://wiki.onap.org/).
33977 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
33980 example: __VNF-ID2__
33981 - name: interface-name
33983 description: Name given to the interface
33986 example: __INTERFACE-NAME__
33987 - name: l3-interface-ipv4-address
33989 description: IP address
33992 example: __L3-INTERFACE-IPV4-ADDRESS__
33996 summary: create or update an existing l3-interface-ipv4-address-list
33998 Create or update an existing l3-interface-ipv4-address-list.
34000 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34001 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34010 description: Response codes found in [response codes](https://wiki.onap.org/).
34014 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34017 example: __VNF-ID2__
34018 - name: interface-name
34020 description: Name given to the interface
34023 example: __INTERFACE-NAME__
34024 - name: l3-interface-ipv4-address
34026 description: IP address
34029 example: __L3-INTERFACE-IPV4-ADDRESS__
34032 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
34035 $ref: "#/definitions/l3-interface-ipv4-address-list"
34039 summary: update an existing l3-interface-ipv4-address-list
34041 Update an existing l3-interface-ipv4-address-list
34043 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34044 The PUT operation will entirely replace an existing object.
34045 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34047 Other differences between PUT and PATCH are:
34049 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34050 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34051 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34052 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34061 description: Response codes found in [response codes](https://wiki.onap.org/).
34065 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34068 example: __VNF-ID2__
34069 - name: interface-name
34071 description: Name given to the interface
34074 example: __INTERFACE-NAME__
34075 - name: l3-interface-ipv4-address
34077 description: IP address
34080 example: __L3-INTERFACE-IPV4-ADDRESS__
34083 description: l3-interface-ipv4-address-list object that needs to be updated.
34086 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
34090 summary: delete an existing l3-interface-ipv4-address-list
34091 description: delete an existing l3-interface-ipv4-address-list
34092 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
34101 description: Response codes found in [response codes](https://wiki.onap.org/).
34105 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34108 example: __VNF-ID2__
34109 - name: interface-name
34111 description: Name given to the interface
34114 example: __INTERFACE-NAME__
34115 - name: l3-interface-ipv4-address
34117 description: IP address
34120 example: __L3-INTERFACE-IPV4-ADDRESS__
34121 - name: resource-version
34123 description: resource-version for concurrency
34126 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
34130 summary: see node definition for valid relationships
34131 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
34140 description: Response codes found in [response codes](https://wiki.onap.org/).
34144 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34147 example: __VNF-ID2__
34148 - name: interface-name
34150 description: Name given to the interface
34153 example: __INTERFACE-NAME__
34154 - name: l3-interface-ipv6-address
34156 description: IP address
34159 example: __L3-INTERFACE-IPV6-ADDRESS__
34162 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
34165 $ref: "#/definitions/relationship"
34169 summary: delete an existing relationship
34170 description: delete an existing relationship
34171 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
34180 description: Response codes found in [response codes](https://wiki.onap.org/).
34184 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34187 example: __VNF-ID2__
34188 - name: interface-name
34190 description: Name given to the interface
34193 example: __INTERFACE-NAME__
34194 - name: l3-interface-ipv6-address
34196 description: IP address
34199 example: __L3-INTERFACE-IPV6-ADDRESS__
34200 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
34204 summary: returns l3-interface-ipv6-address-list
34205 description: returns l3-interface-ipv6-address-list
34206 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
34212 description: successful operation
34214 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
34216 description: Response codes found in [response codes](https://wiki.onap.org/).
34220 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34223 example: __VNF-ID2__
34224 - name: interface-name
34226 description: Name given to the interface
34229 example: __INTERFACE-NAME__
34230 - name: l3-interface-ipv6-address
34232 description: IP address
34235 example: __L3-INTERFACE-IPV6-ADDRESS__
34239 summary: create or update an existing l3-interface-ipv6-address-list
34241 Create or update an existing l3-interface-ipv6-address-list.
34243 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34244 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
34253 description: Response codes found in [response codes](https://wiki.onap.org/).
34257 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34260 example: __VNF-ID2__
34261 - name: interface-name
34263 description: Name given to the interface
34266 example: __INTERFACE-NAME__
34267 - name: l3-interface-ipv6-address
34269 description: IP address
34272 example: __L3-INTERFACE-IPV6-ADDRESS__
34275 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
34278 $ref: "#/definitions/l3-interface-ipv6-address-list"
34282 summary: update an existing l3-interface-ipv6-address-list
34284 Update an existing l3-interface-ipv6-address-list
34286 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34287 The PUT operation will entirely replace an existing object.
34288 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34290 Other differences between PUT and PATCH are:
34292 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34293 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34294 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34295 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
34304 description: Response codes found in [response codes](https://wiki.onap.org/).
34308 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34311 example: __VNF-ID2__
34312 - name: interface-name
34314 description: Name given to the interface
34317 example: __INTERFACE-NAME__
34318 - name: l3-interface-ipv6-address
34320 description: IP address
34323 example: __L3-INTERFACE-IPV6-ADDRESS__
34326 description: l3-interface-ipv6-address-list object that needs to be updated.
34329 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
34333 summary: delete an existing l3-interface-ipv6-address-list
34334 description: delete an existing l3-interface-ipv6-address-list
34335 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
34344 description: Response codes found in [response codes](https://wiki.onap.org/).
34348 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34351 example: __VNF-ID2__
34352 - name: interface-name
34354 description: Name given to the interface
34357 example: __INTERFACE-NAME__
34358 - name: l3-interface-ipv6-address
34360 description: IP address
34363 example: __L3-INTERFACE-IPV6-ADDRESS__
34364 - name: resource-version
34366 description: resource-version for concurrency
34369 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}:
34373 summary: returns l-interface
34374 description: returns l-interface
34375 operationId: getNetworkNewvcesNewvceLInterfacesLInterface
34381 description: successful operation
34383 $ref: "#/getDefinitions/l-interface"
34385 description: Response codes found in [response codes](https://wiki.onap.org/).
34389 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34392 example: __VNF-ID2__
34393 - name: interface-name
34395 description: Name given to the interface
34398 example: __INTERFACE-NAME__
34402 summary: create or update an existing l-interface
34404 Create or update an existing l-interface.
34406 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34407 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface
34416 description: Response codes found in [response codes](https://wiki.onap.org/).
34420 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34423 example: __VNF-ID2__
34424 - name: interface-name
34426 description: Name given to the interface
34429 example: __INTERFACE-NAME__
34432 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterface.json)
34435 $ref: "#/definitions/l-interface"
34439 summary: update an existing l-interface
34441 Update an existing l-interface
34443 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34444 The PUT operation will entirely replace an existing object.
34445 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34447 Other differences between PUT and PATCH are:
34449 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34450 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34451 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34452 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterface
34461 description: Response codes found in [response codes](https://wiki.onap.org/).
34465 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34468 example: __VNF-ID2__
34469 - name: interface-name
34471 description: Name given to the interface
34474 example: __INTERFACE-NAME__
34477 description: l-interface object that needs to be updated.
34480 $ref: "#/patchDefinitions/l-interface"
34484 summary: delete an existing l-interface
34485 description: delete an existing l-interface
34486 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface
34495 description: Response codes found in [response codes](https://wiki.onap.org/).
34499 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34502 example: __VNF-ID2__
34503 - name: interface-name
34505 description: Name given to the interface
34508 example: __INTERFACE-NAME__
34509 - name: resource-version
34511 description: resource-version for concurrency
34514 /network/newvces/newvce/{vnf-id2}/l-interfaces:
34518 summary: returns l-interfaces
34519 description: returns l-interfaces
34520 operationId: getNetworkNewvcesNewvceLInterfaces
34526 description: successful operation
34528 $ref: "#/getDefinitions/l-interfaces"
34530 description: Response codes found in [response codes](https://wiki.onap.org/).
34534 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34537 example: __VNF-ID2__
34538 - name: interface-name
34543 - name: interface-id
34553 - name: network-name
34558 /network/newvces/newvce/{vnf-id2}:
34562 summary: returns newvce
34563 description: returns newvce
34564 operationId: getNetworkNewvcesNewvce
34570 description: successful operation
34572 $ref: "#/getDefinitions/newvce"
34574 description: Response codes found in [response codes](https://wiki.onap.org/).
34578 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34581 example: __VNF-ID2__
34585 summary: create or update an existing newvce
34587 Create or update an existing newvce.
34589 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34590 operationId: createOrUpdateNetworkNewvcesNewvce
34599 description: Response codes found in [response codes](https://wiki.onap.org/).
34603 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34606 example: __VNF-ID2__
34609 description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvce.json)
34612 $ref: "#/definitions/newvce"
34616 summary: update an existing newvce
34618 Update an existing newvce
34620 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34621 The PUT operation will entirely replace an existing object.
34622 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34624 Other differences between PUT and PATCH are:
34626 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34627 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34628 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34629 operationId: UpdateNetworkNewvcesNewvce
34638 description: Response codes found in [response codes](https://wiki.onap.org/).
34642 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34645 example: __VNF-ID2__
34648 description: newvce object that needs to be updated.
34651 $ref: "#/patchDefinitions/newvce"
34655 summary: delete an existing newvce
34656 description: delete an existing newvce
34657 operationId: deleteNetworkNewvcesNewvce
34666 description: Response codes found in [response codes](https://wiki.onap.org/).
34670 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34673 example: __VNF-ID2__
34674 - name: resource-version
34676 description: resource-version for concurrency
34683 summary: returns newvces
34684 description: returns newvces
34685 operationId: getNetworkNewvces
34691 description: successful operation
34693 $ref: "#/getDefinitions/newvces"
34695 description: Response codes found in [response codes](https://wiki.onap.org/).
34717 - name: prov-status
34722 - name: heat-stack-id
34727 /network/pnfs/pnf/{pnf-name}/relationship-list/relationship:
34731 summary: see node definition for valid relationships
34732 operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship
34741 description: Response codes found in [response codes](https://wiki.onap.org/).
34745 description: unique name of Physical Network Function.
34748 example: __PNF-NAME__
34751 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnf.json)
34754 $ref: "#/definitions/relationship"
34758 summary: delete an existing relationship
34759 description: delete an existing relationship
34760 operationId: deleteNetworkPnfsPnfRelationshipListRelationship
34769 description: Response codes found in [response codes](https://wiki.onap.org/).
34773 description: unique name of Physical Network Function.
34776 example: __PNF-NAME__
34777 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
34781 summary: see node definition for valid relationships
34782 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
34791 description: Response codes found in [response codes](https://wiki.onap.org/).
34795 description: unique name of Physical Network Function.
34798 example: __PNF-NAME__
34799 - name: interface-name
34801 description: Name that identifies the physical interface
34804 example: __INTERFACE-NAME__
34807 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterface.json)
34810 $ref: "#/definitions/relationship"
34814 summary: delete an existing relationship
34815 description: delete an existing relationship
34816 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
34825 description: Response codes found in [response codes](https://wiki.onap.org/).
34829 description: unique name of Physical Network Function.
34832 example: __PNF-NAME__
34833 - name: interface-name
34835 description: Name that identifies the physical interface
34838 example: __INTERFACE-NAME__
34839 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
34843 summary: see node definition for valid relationships
34844 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
34853 description: Response codes found in [response codes](https://wiki.onap.org/).
34857 description: unique name of Physical Network Function.
34860 example: __PNF-NAME__
34861 - name: interface-name
34863 description: Name that identifies the physical interface
34866 example: __INTERFACE-NAME__
34867 - name: interface-name
34869 description: Name given to the interface
34872 example: __INTERFACE-NAME__
34873 - name: vlan-interface
34875 description: String that identifies the interface
34878 example: __VLAN-INTERFACE__
34881 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
34884 $ref: "#/definitions/relationship"
34888 summary: delete an existing relationship
34889 description: delete an existing relationship
34890 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
34899 description: Response codes found in [response codes](https://wiki.onap.org/).
34903 description: unique name of Physical Network Function.
34906 example: __PNF-NAME__
34907 - name: interface-name
34909 description: Name that identifies the physical interface
34912 example: __INTERFACE-NAME__
34913 - name: interface-name
34915 description: Name given to the interface
34918 example: __INTERFACE-NAME__
34919 - name: vlan-interface
34921 description: String that identifies the interface
34924 example: __VLAN-INTERFACE__
34925 /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:
34929 summary: see node definition for valid relationships
34930 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
34939 description: Response codes found in [response codes](https://wiki.onap.org/).
34943 description: unique name of Physical Network Function.
34946 example: __PNF-NAME__
34947 - name: interface-name
34949 description: Name that identifies the physical interface
34952 example: __INTERFACE-NAME__
34953 - name: interface-name
34955 description: Name given to the interface
34958 example: __INTERFACE-NAME__
34959 - name: vlan-interface
34961 description: String that identifies the interface
34964 example: __VLAN-INTERFACE__
34965 - name: l3-interface-ipv4-address
34967 description: IP address
34970 example: __L3-INTERFACE-IPV4-ADDRESS__
34973 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
34976 $ref: "#/definitions/relationship"
34980 summary: delete an existing relationship
34981 description: delete an existing relationship
34982 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
34991 description: Response codes found in [response codes](https://wiki.onap.org/).
34995 description: unique name of Physical Network Function.
34998 example: __PNF-NAME__
34999 - name: interface-name
35001 description: Name that identifies the physical interface
35004 example: __INTERFACE-NAME__
35005 - name: interface-name
35007 description: Name given to the interface
35010 example: __INTERFACE-NAME__
35011 - name: vlan-interface
35013 description: String that identifies the interface
35016 example: __VLAN-INTERFACE__
35017 - name: l3-interface-ipv4-address
35019 description: IP address
35022 example: __L3-INTERFACE-IPV4-ADDRESS__
35023 /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}:
35027 summary: returns l3-interface-ipv4-address-list
35028 description: returns l3-interface-ipv4-address-list
35029 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35035 description: successful operation
35037 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
35039 description: Response codes found in [response codes](https://wiki.onap.org/).
35043 description: unique name of Physical Network Function.
35046 example: __PNF-NAME__
35047 - name: interface-name
35049 description: Name that identifies the physical interface
35052 example: __INTERFACE-NAME__
35053 - name: interface-name
35055 description: Name given to the interface
35058 example: __INTERFACE-NAME__
35059 - name: vlan-interface
35061 description: String that identifies the interface
35064 example: __VLAN-INTERFACE__
35065 - name: l3-interface-ipv4-address
35067 description: IP address
35070 example: __L3-INTERFACE-IPV4-ADDRESS__
35074 summary: create or update an existing l3-interface-ipv4-address-list
35076 Create or update an existing l3-interface-ipv4-address-list.
35078 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35079 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35088 description: Response codes found in [response codes](https://wiki.onap.org/).
35092 description: unique name of Physical Network Function.
35095 example: __PNF-NAME__
35096 - name: interface-name
35098 description: Name that identifies the physical interface
35101 example: __INTERFACE-NAME__
35102 - name: interface-name
35104 description: Name given to the interface
35107 example: __INTERFACE-NAME__
35108 - name: vlan-interface
35110 description: String that identifies the interface
35113 example: __VLAN-INTERFACE__
35114 - name: l3-interface-ipv4-address
35116 description: IP address
35119 example: __L3-INTERFACE-IPV4-ADDRESS__
35122 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
35125 $ref: "#/definitions/l3-interface-ipv4-address-list"
35129 summary: update an existing l3-interface-ipv4-address-list
35131 Update an existing l3-interface-ipv4-address-list
35133 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35134 The PUT operation will entirely replace an existing object.
35135 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35137 Other differences between PUT and PATCH are:
35139 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35140 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35141 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35142 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35151 description: Response codes found in [response codes](https://wiki.onap.org/).
35155 description: unique name of Physical Network Function.
35158 example: __PNF-NAME__
35159 - name: interface-name
35161 description: Name that identifies the physical interface
35164 example: __INTERFACE-NAME__
35165 - name: interface-name
35167 description: Name given to the interface
35170 example: __INTERFACE-NAME__
35171 - name: vlan-interface
35173 description: String that identifies the interface
35176 example: __VLAN-INTERFACE__
35177 - name: l3-interface-ipv4-address
35179 description: IP address
35182 example: __L3-INTERFACE-IPV4-ADDRESS__
35185 description: l3-interface-ipv4-address-list object that needs to be updated.
35188 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
35192 summary: delete an existing l3-interface-ipv4-address-list
35193 description: delete an existing l3-interface-ipv4-address-list
35194 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35203 description: Response codes found in [response codes](https://wiki.onap.org/).
35207 description: unique name of Physical Network Function.
35210 example: __PNF-NAME__
35211 - name: interface-name
35213 description: Name that identifies the physical interface
35216 example: __INTERFACE-NAME__
35217 - name: interface-name
35219 description: Name given to the interface
35222 example: __INTERFACE-NAME__
35223 - name: vlan-interface
35225 description: String that identifies the interface
35228 example: __VLAN-INTERFACE__
35229 - name: l3-interface-ipv4-address
35231 description: IP address
35234 example: __L3-INTERFACE-IPV4-ADDRESS__
35235 - name: resource-version
35237 description: resource-version for concurrency
35240 /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:
35244 summary: see node definition for valid relationships
35245 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
35254 description: Response codes found in [response codes](https://wiki.onap.org/).
35258 description: unique name of Physical Network Function.
35261 example: __PNF-NAME__
35262 - name: interface-name
35264 description: Name that identifies the physical interface
35267 example: __INTERFACE-NAME__
35268 - name: interface-name
35270 description: Name given to the interface
35273 example: __INTERFACE-NAME__
35274 - name: vlan-interface
35276 description: String that identifies the interface
35279 example: __VLAN-INTERFACE__
35280 - name: l3-interface-ipv6-address
35282 description: IP address
35285 example: __L3-INTERFACE-IPV6-ADDRESS__
35288 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
35291 $ref: "#/definitions/relationship"
35295 summary: delete an existing relationship
35296 description: delete an existing relationship
35297 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
35306 description: Response codes found in [response codes](https://wiki.onap.org/).
35310 description: unique name of Physical Network Function.
35313 example: __PNF-NAME__
35314 - name: interface-name
35316 description: Name that identifies the physical interface
35319 example: __INTERFACE-NAME__
35320 - name: interface-name
35322 description: Name given to the interface
35325 example: __INTERFACE-NAME__
35326 - name: vlan-interface
35328 description: String that identifies the interface
35331 example: __VLAN-INTERFACE__
35332 - name: l3-interface-ipv6-address
35334 description: IP address
35337 example: __L3-INTERFACE-IPV6-ADDRESS__
35338 /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}:
35342 summary: returns l3-interface-ipv6-address-list
35343 description: returns l3-interface-ipv6-address-list
35344 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35350 description: successful operation
35352 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
35354 description: Response codes found in [response codes](https://wiki.onap.org/).
35358 description: unique name of Physical Network Function.
35361 example: __PNF-NAME__
35362 - name: interface-name
35364 description: Name that identifies the physical interface
35367 example: __INTERFACE-NAME__
35368 - name: interface-name
35370 description: Name given to the interface
35373 example: __INTERFACE-NAME__
35374 - name: vlan-interface
35376 description: String that identifies the interface
35379 example: __VLAN-INTERFACE__
35380 - name: l3-interface-ipv6-address
35382 description: IP address
35385 example: __L3-INTERFACE-IPV6-ADDRESS__
35389 summary: create or update an existing l3-interface-ipv6-address-list
35391 Create or update an existing l3-interface-ipv6-address-list.
35393 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35394 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35403 description: Response codes found in [response codes](https://wiki.onap.org/).
35407 description: unique name of Physical Network Function.
35410 example: __PNF-NAME__
35411 - name: interface-name
35413 description: Name that identifies the physical interface
35416 example: __INTERFACE-NAME__
35417 - name: interface-name
35419 description: Name given to the interface
35422 example: __INTERFACE-NAME__
35423 - name: vlan-interface
35425 description: String that identifies the interface
35428 example: __VLAN-INTERFACE__
35429 - name: l3-interface-ipv6-address
35431 description: IP address
35434 example: __L3-INTERFACE-IPV6-ADDRESS__
35437 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
35440 $ref: "#/definitions/l3-interface-ipv6-address-list"
35444 summary: update an existing l3-interface-ipv6-address-list
35446 Update an existing l3-interface-ipv6-address-list
35448 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35449 The PUT operation will entirely replace an existing object.
35450 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35452 Other differences between PUT and PATCH are:
35454 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35455 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35456 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35457 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35466 description: Response codes found in [response codes](https://wiki.onap.org/).
35470 description: unique name of Physical Network Function.
35473 example: __PNF-NAME__
35474 - name: interface-name
35476 description: Name that identifies the physical interface
35479 example: __INTERFACE-NAME__
35480 - name: interface-name
35482 description: Name given to the interface
35485 example: __INTERFACE-NAME__
35486 - name: vlan-interface
35488 description: String that identifies the interface
35491 example: __VLAN-INTERFACE__
35492 - name: l3-interface-ipv6-address
35494 description: IP address
35497 example: __L3-INTERFACE-IPV6-ADDRESS__
35500 description: l3-interface-ipv6-address-list object that needs to be updated.
35503 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
35507 summary: delete an existing l3-interface-ipv6-address-list
35508 description: delete an existing l3-interface-ipv6-address-list
35509 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35518 description: Response codes found in [response codes](https://wiki.onap.org/).
35522 description: unique name of Physical Network Function.
35525 example: __PNF-NAME__
35526 - name: interface-name
35528 description: Name that identifies the physical interface
35531 example: __INTERFACE-NAME__
35532 - name: interface-name
35534 description: Name given to the interface
35537 example: __INTERFACE-NAME__
35538 - name: vlan-interface
35540 description: String that identifies the interface
35543 example: __VLAN-INTERFACE__
35544 - name: l3-interface-ipv6-address
35546 description: IP address
35549 example: __L3-INTERFACE-IPV6-ADDRESS__
35550 - name: resource-version
35552 description: resource-version for concurrency
35555 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
35559 summary: returns vlan
35560 description: returns vlan
35561 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
35567 description: successful operation
35569 $ref: "#/getDefinitions/vlan"
35571 description: Response codes found in [response codes](https://wiki.onap.org/).
35575 description: unique name of Physical Network Function.
35578 example: __PNF-NAME__
35579 - name: interface-name
35581 description: Name that identifies the physical interface
35584 example: __INTERFACE-NAME__
35585 - name: interface-name
35587 description: Name given to the interface
35590 example: __INTERFACE-NAME__
35591 - name: vlan-interface
35593 description: String that identifies the interface
35596 example: __VLAN-INTERFACE__
35600 summary: create or update an existing vlan
35602 Create or update an existing vlan.
35604 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35605 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
35614 description: Response codes found in [response codes](https://wiki.onap.org/).
35618 description: unique name of Physical Network Function.
35621 example: __PNF-NAME__
35622 - name: interface-name
35624 description: Name that identifies the physical interface
35627 example: __INTERFACE-NAME__
35628 - name: interface-name
35630 description: Name given to the interface
35633 example: __INTERFACE-NAME__
35634 - name: vlan-interface
35636 description: String that identifies the interface
35639 example: __VLAN-INTERFACE__
35642 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
35645 $ref: "#/definitions/vlan"
35649 summary: update an existing vlan
35651 Update an existing vlan
35653 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35654 The PUT operation will entirely replace an existing object.
35655 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35657 Other differences between PUT and PATCH are:
35659 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35660 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35661 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35662 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
35671 description: Response codes found in [response codes](https://wiki.onap.org/).
35675 description: unique name of Physical Network Function.
35678 example: __PNF-NAME__
35679 - name: interface-name
35681 description: Name that identifies the physical interface
35684 example: __INTERFACE-NAME__
35685 - name: interface-name
35687 description: Name given to the interface
35690 example: __INTERFACE-NAME__
35691 - name: vlan-interface
35693 description: String that identifies the interface
35696 example: __VLAN-INTERFACE__
35699 description: vlan object that needs to be updated.
35702 $ref: "#/patchDefinitions/vlan"
35706 summary: delete an existing vlan
35707 description: delete an existing vlan
35708 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
35717 description: Response codes found in [response codes](https://wiki.onap.org/).
35721 description: unique name of Physical Network Function.
35724 example: __PNF-NAME__
35725 - name: interface-name
35727 description: Name that identifies the physical interface
35730 example: __INTERFACE-NAME__
35731 - name: interface-name
35733 description: Name given to the interface
35736 example: __INTERFACE-NAME__
35737 - name: vlan-interface
35739 description: String that identifies the interface
35742 example: __VLAN-INTERFACE__
35743 - name: resource-version
35745 description: resource-version for concurrency
35748 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
35752 summary: returns vlans
35753 description: returns vlans
35754 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans
35760 description: successful operation
35762 $ref: "#/getDefinitions/vlans"
35764 description: Response codes found in [response codes](https://wiki.onap.org/).
35768 description: unique name of Physical Network Function.
35771 example: __PNF-NAME__
35772 - name: interface-name
35774 description: Name that identifies the physical interface
35777 example: __INTERFACE-NAME__
35778 - name: interface-name
35780 description: Name given to the interface
35783 example: __INTERFACE-NAME__
35784 - name: vlan-interface
35789 - name: vlan-id-inner
35800 /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:
35804 summary: see node definition for valid relationships
35805 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
35814 description: Response codes found in [response codes](https://wiki.onap.org/).
35818 description: unique name of Physical Network Function.
35821 example: __PNF-NAME__
35822 - name: interface-name
35824 description: Name that identifies the physical interface
35827 example: __INTERFACE-NAME__
35828 - name: interface-name
35830 description: Name given to the interface
35833 example: __INTERFACE-NAME__
35836 description: PCI ID used to identify the sriov-vf
35839 example: __PCI-ID__
35842 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
35845 $ref: "#/definitions/relationship"
35849 summary: delete an existing relationship
35850 description: delete an existing relationship
35851 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
35860 description: Response codes found in [response codes](https://wiki.onap.org/).
35864 description: unique name of Physical Network Function.
35867 example: __PNF-NAME__
35868 - name: interface-name
35870 description: Name that identifies the physical interface
35873 example: __INTERFACE-NAME__
35874 - name: interface-name
35876 description: Name given to the interface
35879 example: __INTERFACE-NAME__
35882 description: PCI ID used to identify the sriov-vf
35885 example: __PCI-ID__
35886 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
35890 summary: returns sriov-vf
35891 description: returns sriov-vf
35892 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
35898 description: successful operation
35900 $ref: "#/getDefinitions/sriov-vf"
35902 description: Response codes found in [response codes](https://wiki.onap.org/).
35906 description: unique name of Physical Network Function.
35909 example: __PNF-NAME__
35910 - name: interface-name
35912 description: Name that identifies the physical interface
35915 example: __INTERFACE-NAME__
35916 - name: interface-name
35918 description: Name given to the interface
35921 example: __INTERFACE-NAME__
35924 description: PCI ID used to identify the sriov-vf
35927 example: __PCI-ID__
35931 summary: create or update an existing sriov-vf
35933 Create or update an existing sriov-vf.
35935 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35936 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
35945 description: Response codes found in [response codes](https://wiki.onap.org/).
35949 description: unique name of Physical Network Function.
35952 example: __PNF-NAME__
35953 - name: interface-name
35955 description: Name that identifies the physical interface
35958 example: __INTERFACE-NAME__
35959 - name: interface-name
35961 description: Name given to the interface
35964 example: __INTERFACE-NAME__
35967 description: PCI ID used to identify the sriov-vf
35970 example: __PCI-ID__
35973 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
35976 $ref: "#/definitions/sriov-vf"
35980 summary: update an existing sriov-vf
35982 Update an existing sriov-vf
35984 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35985 The PUT operation will entirely replace an existing object.
35986 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35988 Other differences between PUT and PATCH are:
35990 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35991 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35992 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35993 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
36002 description: Response codes found in [response codes](https://wiki.onap.org/).
36006 description: unique name of Physical Network Function.
36009 example: __PNF-NAME__
36010 - name: interface-name
36012 description: Name that identifies the physical interface
36015 example: __INTERFACE-NAME__
36016 - name: interface-name
36018 description: Name given to the interface
36021 example: __INTERFACE-NAME__
36024 description: PCI ID used to identify the sriov-vf
36027 example: __PCI-ID__
36030 description: sriov-vf object that needs to be updated.
36033 $ref: "#/patchDefinitions/sriov-vf"
36037 summary: delete an existing sriov-vf
36038 description: delete an existing sriov-vf
36039 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
36048 description: Response codes found in [response codes](https://wiki.onap.org/).
36052 description: unique name of Physical Network Function.
36055 example: __PNF-NAME__
36056 - name: interface-name
36058 description: Name that identifies the physical interface
36061 example: __INTERFACE-NAME__
36062 - name: interface-name
36064 description: Name given to the interface
36067 example: __INTERFACE-NAME__
36070 description: PCI ID used to identify the sriov-vf
36073 example: __PCI-ID__
36074 - name: resource-version
36076 description: resource-version for concurrency
36079 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
36083 summary: returns sriov-vfs
36084 description: returns sriov-vfs
36085 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
36091 description: successful operation
36093 $ref: "#/getDefinitions/sriov-vfs"
36095 description: Response codes found in [response codes](https://wiki.onap.org/).
36099 description: unique name of Physical Network Function.
36102 example: __PNF-NAME__
36103 - name: interface-name
36105 description: Name that identifies the physical interface
36108 example: __INTERFACE-NAME__
36109 - name: interface-name
36111 description: Name given to the interface
36114 example: __INTERFACE-NAME__
36120 - name: vf-vlan-filter
36125 - name: vf-mac-filter
36130 - name: vf-vlan-strip
36135 - name: neutron-network-id
36140 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
36144 summary: see node definition for valid relationships
36145 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
36154 description: Response codes found in [response codes](https://wiki.onap.org/).
36158 description: unique name of Physical Network Function.
36161 example: __PNF-NAME__
36162 - name: interface-name
36164 description: Name that identifies the physical interface
36167 example: __INTERFACE-NAME__
36168 - name: interface-name
36170 description: Name given to the interface
36173 example: __INTERFACE-NAME__
36176 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
36179 $ref: "#/definitions/relationship"
36183 summary: delete an existing relationship
36184 description: delete an existing relationship
36185 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
36194 description: Response codes found in [response codes](https://wiki.onap.org/).
36198 description: unique name of Physical Network Function.
36201 example: __PNF-NAME__
36202 - name: interface-name
36204 description: Name that identifies the physical interface
36207 example: __INTERFACE-NAME__
36208 - name: interface-name
36210 description: Name given to the interface
36213 example: __INTERFACE-NAME__
36214 /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:
36218 summary: see node definition for valid relationships
36219 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
36228 description: Response codes found in [response codes](https://wiki.onap.org/).
36232 description: unique name of Physical Network Function.
36235 example: __PNF-NAME__
36236 - name: interface-name
36238 description: Name that identifies the physical interface
36241 example: __INTERFACE-NAME__
36242 - name: interface-name
36244 description: Name given to the interface
36247 example: __INTERFACE-NAME__
36248 - name: l3-interface-ipv4-address
36250 description: IP address
36253 example: __L3-INTERFACE-IPV4-ADDRESS__
36256 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
36259 $ref: "#/definitions/relationship"
36263 summary: delete an existing relationship
36264 description: delete an existing relationship
36265 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
36274 description: Response codes found in [response codes](https://wiki.onap.org/).
36278 description: unique name of Physical Network Function.
36281 example: __PNF-NAME__
36282 - name: interface-name
36284 description: Name that identifies the physical interface
36287 example: __INTERFACE-NAME__
36288 - name: interface-name
36290 description: Name given to the interface
36293 example: __INTERFACE-NAME__
36294 - name: l3-interface-ipv4-address
36296 description: IP address
36299 example: __L3-INTERFACE-IPV4-ADDRESS__
36300 /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}:
36304 summary: returns l3-interface-ipv4-address-list
36305 description: returns l3-interface-ipv4-address-list
36306 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36312 description: successful operation
36314 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
36316 description: Response codes found in [response codes](https://wiki.onap.org/).
36320 description: unique name of Physical Network Function.
36323 example: __PNF-NAME__
36324 - name: interface-name
36326 description: Name that identifies the physical interface
36329 example: __INTERFACE-NAME__
36330 - name: interface-name
36332 description: Name given to the interface
36335 example: __INTERFACE-NAME__
36336 - name: l3-interface-ipv4-address
36338 description: IP address
36341 example: __L3-INTERFACE-IPV4-ADDRESS__
36345 summary: create or update an existing l3-interface-ipv4-address-list
36347 Create or update an existing l3-interface-ipv4-address-list.
36349 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36350 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36359 description: Response codes found in [response codes](https://wiki.onap.org/).
36363 description: unique name of Physical Network Function.
36366 example: __PNF-NAME__
36367 - name: interface-name
36369 description: Name that identifies the physical interface
36372 example: __INTERFACE-NAME__
36373 - name: interface-name
36375 description: Name given to the interface
36378 example: __INTERFACE-NAME__
36379 - name: l3-interface-ipv4-address
36381 description: IP address
36384 example: __L3-INTERFACE-IPV4-ADDRESS__
36387 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
36390 $ref: "#/definitions/l3-interface-ipv4-address-list"
36394 summary: update an existing l3-interface-ipv4-address-list
36396 Update an existing l3-interface-ipv4-address-list
36398 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36399 The PUT operation will entirely replace an existing object.
36400 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36402 Other differences between PUT and PATCH are:
36404 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36405 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36406 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36407 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36416 description: Response codes found in [response codes](https://wiki.onap.org/).
36420 description: unique name of Physical Network Function.
36423 example: __PNF-NAME__
36424 - name: interface-name
36426 description: Name that identifies the physical interface
36429 example: __INTERFACE-NAME__
36430 - name: interface-name
36432 description: Name given to the interface
36435 example: __INTERFACE-NAME__
36436 - name: l3-interface-ipv4-address
36438 description: IP address
36441 example: __L3-INTERFACE-IPV4-ADDRESS__
36444 description: l3-interface-ipv4-address-list object that needs to be updated.
36447 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
36451 summary: delete an existing l3-interface-ipv4-address-list
36452 description: delete an existing l3-interface-ipv4-address-list
36453 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36462 description: Response codes found in [response codes](https://wiki.onap.org/).
36466 description: unique name of Physical Network Function.
36469 example: __PNF-NAME__
36470 - name: interface-name
36472 description: Name that identifies the physical interface
36475 example: __INTERFACE-NAME__
36476 - name: interface-name
36478 description: Name given to the interface
36481 example: __INTERFACE-NAME__
36482 - name: l3-interface-ipv4-address
36484 description: IP address
36487 example: __L3-INTERFACE-IPV4-ADDRESS__
36488 - name: resource-version
36490 description: resource-version for concurrency
36493 /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:
36497 summary: see node definition for valid relationships
36498 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
36507 description: Response codes found in [response codes](https://wiki.onap.org/).
36511 description: unique name of Physical Network Function.
36514 example: __PNF-NAME__
36515 - name: interface-name
36517 description: Name that identifies the physical interface
36520 example: __INTERFACE-NAME__
36521 - name: interface-name
36523 description: Name given to the interface
36526 example: __INTERFACE-NAME__
36527 - name: l3-interface-ipv6-address
36529 description: IP address
36532 example: __L3-INTERFACE-IPV6-ADDRESS__
36535 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
36538 $ref: "#/definitions/relationship"
36542 summary: delete an existing relationship
36543 description: delete an existing relationship
36544 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
36553 description: Response codes found in [response codes](https://wiki.onap.org/).
36557 description: unique name of Physical Network Function.
36560 example: __PNF-NAME__
36561 - name: interface-name
36563 description: Name that identifies the physical interface
36566 example: __INTERFACE-NAME__
36567 - name: interface-name
36569 description: Name given to the interface
36572 example: __INTERFACE-NAME__
36573 - name: l3-interface-ipv6-address
36575 description: IP address
36578 example: __L3-INTERFACE-IPV6-ADDRESS__
36579 /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}:
36583 summary: returns l3-interface-ipv6-address-list
36584 description: returns l3-interface-ipv6-address-list
36585 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36591 description: successful operation
36593 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
36595 description: Response codes found in [response codes](https://wiki.onap.org/).
36599 description: unique name of Physical Network Function.
36602 example: __PNF-NAME__
36603 - name: interface-name
36605 description: Name that identifies the physical interface
36608 example: __INTERFACE-NAME__
36609 - name: interface-name
36611 description: Name given to the interface
36614 example: __INTERFACE-NAME__
36615 - name: l3-interface-ipv6-address
36617 description: IP address
36620 example: __L3-INTERFACE-IPV6-ADDRESS__
36624 summary: create or update an existing l3-interface-ipv6-address-list
36626 Create or update an existing l3-interface-ipv6-address-list.
36628 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36629 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36638 description: Response codes found in [response codes](https://wiki.onap.org/).
36642 description: unique name of Physical Network Function.
36645 example: __PNF-NAME__
36646 - name: interface-name
36648 description: Name that identifies the physical interface
36651 example: __INTERFACE-NAME__
36652 - name: interface-name
36654 description: Name given to the interface
36657 example: __INTERFACE-NAME__
36658 - name: l3-interface-ipv6-address
36660 description: IP address
36663 example: __L3-INTERFACE-IPV6-ADDRESS__
36666 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
36669 $ref: "#/definitions/l3-interface-ipv6-address-list"
36673 summary: update an existing l3-interface-ipv6-address-list
36675 Update an existing l3-interface-ipv6-address-list
36677 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36678 The PUT operation will entirely replace an existing object.
36679 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36681 Other differences between PUT and PATCH are:
36683 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36684 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36685 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36686 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36695 description: Response codes found in [response codes](https://wiki.onap.org/).
36699 description: unique name of Physical Network Function.
36702 example: __PNF-NAME__
36703 - name: interface-name
36705 description: Name that identifies the physical interface
36708 example: __INTERFACE-NAME__
36709 - name: interface-name
36711 description: Name given to the interface
36714 example: __INTERFACE-NAME__
36715 - name: l3-interface-ipv6-address
36717 description: IP address
36720 example: __L3-INTERFACE-IPV6-ADDRESS__
36723 description: l3-interface-ipv6-address-list object that needs to be updated.
36726 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
36730 summary: delete an existing l3-interface-ipv6-address-list
36731 description: delete an existing l3-interface-ipv6-address-list
36732 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36741 description: Response codes found in [response codes](https://wiki.onap.org/).
36745 description: unique name of Physical Network Function.
36748 example: __PNF-NAME__
36749 - name: interface-name
36751 description: Name that identifies the physical interface
36754 example: __INTERFACE-NAME__
36755 - name: interface-name
36757 description: Name given to the interface
36760 example: __INTERFACE-NAME__
36761 - name: l3-interface-ipv6-address
36763 description: IP address
36766 example: __L3-INTERFACE-IPV6-ADDRESS__
36767 - name: resource-version
36769 description: resource-version for concurrency
36772 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
36776 summary: returns l-interface
36777 description: returns l-interface
36778 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
36784 description: successful operation
36786 $ref: "#/getDefinitions/l-interface"
36788 description: Response codes found in [response codes](https://wiki.onap.org/).
36792 description: unique name of Physical Network Function.
36795 example: __PNF-NAME__
36796 - name: interface-name
36798 description: Name that identifies the physical interface
36801 example: __INTERFACE-NAME__
36802 - name: interface-name
36804 description: Name given to the interface
36807 example: __INTERFACE-NAME__
36811 summary: create or update an existing l-interface
36813 Create or update an existing l-interface.
36815 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36816 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
36825 description: Response codes found in [response codes](https://wiki.onap.org/).
36829 description: unique name of Physical Network Function.
36832 example: __PNF-NAME__
36833 - name: interface-name
36835 description: Name that identifies the physical interface
36838 example: __INTERFACE-NAME__
36839 - name: interface-name
36841 description: Name given to the interface
36844 example: __INTERFACE-NAME__
36847 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
36850 $ref: "#/definitions/l-interface"
36854 summary: update an existing l-interface
36856 Update an existing l-interface
36858 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36859 The PUT operation will entirely replace an existing object.
36860 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36862 Other differences between PUT and PATCH are:
36864 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36865 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36866 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36867 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
36876 description: Response codes found in [response codes](https://wiki.onap.org/).
36880 description: unique name of Physical Network Function.
36883 example: __PNF-NAME__
36884 - name: interface-name
36886 description: Name that identifies the physical interface
36889 example: __INTERFACE-NAME__
36890 - name: interface-name
36892 description: Name given to the interface
36895 example: __INTERFACE-NAME__
36898 description: l-interface object that needs to be updated.
36901 $ref: "#/patchDefinitions/l-interface"
36905 summary: delete an existing l-interface
36906 description: delete an existing l-interface
36907 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
36916 description: Response codes found in [response codes](https://wiki.onap.org/).
36920 description: unique name of Physical Network Function.
36923 example: __PNF-NAME__
36924 - name: interface-name
36926 description: Name that identifies the physical interface
36929 example: __INTERFACE-NAME__
36930 - name: interface-name
36932 description: Name given to the interface
36935 example: __INTERFACE-NAME__
36936 - name: resource-version
36938 description: resource-version for concurrency
36941 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
36945 summary: returns l-interfaces
36946 description: returns l-interfaces
36947 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces
36953 description: successful operation
36955 $ref: "#/getDefinitions/l-interfaces"
36957 description: Response codes found in [response codes](https://wiki.onap.org/).
36961 description: unique name of Physical Network Function.
36964 example: __PNF-NAME__
36965 - name: interface-name
36967 description: Name that identifies the physical interface
36970 example: __INTERFACE-NAME__
36971 - name: interface-name
36976 - name: interface-id
36986 - name: network-name
36991 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}:
36995 summary: returns p-interface
36996 description: returns p-interface
36997 operationId: getNetworkPnfsPnfPInterfacesPInterface
37003 description: successful operation
37005 $ref: "#/getDefinitions/p-interface"
37007 description: Response codes found in [response codes](https://wiki.onap.org/).
37011 description: unique name of Physical Network Function.
37014 example: __PNF-NAME__
37015 - name: interface-name
37017 description: Name that identifies the physical interface
37020 example: __INTERFACE-NAME__
37024 summary: create or update an existing p-interface
37026 Create or update an existing p-interface.
37028 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37029 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterface
37038 description: Response codes found in [response codes](https://wiki.onap.org/).
37042 description: unique name of Physical Network Function.
37045 example: __PNF-NAME__
37046 - name: interface-name
37048 description: Name that identifies the physical interface
37051 example: __INTERFACE-NAME__
37054 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterface.json)
37057 $ref: "#/definitions/p-interface"
37061 summary: update an existing p-interface
37063 Update an existing p-interface
37065 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37066 The PUT operation will entirely replace an existing object.
37067 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37069 Other differences between PUT and PATCH are:
37071 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37072 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37073 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37074 operationId: UpdateNetworkPnfsPnfPInterfacesPInterface
37083 description: Response codes found in [response codes](https://wiki.onap.org/).
37087 description: unique name of Physical Network Function.
37090 example: __PNF-NAME__
37091 - name: interface-name
37093 description: Name that identifies the physical interface
37096 example: __INTERFACE-NAME__
37099 description: p-interface object that needs to be updated.
37102 $ref: "#/patchDefinitions/p-interface"
37106 summary: delete an existing p-interface
37107 description: delete an existing p-interface
37108 operationId: deleteNetworkPnfsPnfPInterfacesPInterface
37117 description: Response codes found in [response codes](https://wiki.onap.org/).
37121 description: unique name of Physical Network Function.
37124 example: __PNF-NAME__
37125 - name: interface-name
37127 description: Name that identifies the physical interface
37130 example: __INTERFACE-NAME__
37131 - name: resource-version
37133 description: resource-version for concurrency
37136 /network/pnfs/pnf/{pnf-name}/p-interfaces:
37140 summary: returns p-interfaces
37141 description: returns p-interfaces
37142 operationId: getNetworkPnfsPnfPInterfaces
37148 description: successful operation
37150 $ref: "#/getDefinitions/p-interfaces"
37152 description: Response codes found in [response codes](https://wiki.onap.org/).
37156 description: unique name of Physical Network Function.
37159 example: __PNF-NAME__
37160 - name: interface-name
37165 - name: prov-status
37170 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
37174 summary: see node definition for valid relationships
37175 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
37184 description: Response codes found in [response codes](https://wiki.onap.org/).
37188 description: unique name of Physical Network Function.
37191 example: __PNF-NAME__
37192 - name: interface-name
37194 description: Name that identifies the link aggregate interface
37197 example: __INTERFACE-NAME__
37200 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterface.json)
37203 $ref: "#/definitions/relationship"
37207 summary: delete an existing relationship
37208 description: delete an existing relationship
37209 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
37218 description: Response codes found in [response codes](https://wiki.onap.org/).
37222 description: unique name of Physical Network Function.
37225 example: __PNF-NAME__
37226 - name: interface-name
37228 description: Name that identifies the link aggregate interface
37231 example: __INTERFACE-NAME__
37232 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
37236 summary: see node definition for valid relationships
37237 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
37246 description: Response codes found in [response codes](https://wiki.onap.org/).
37250 description: unique name of Physical Network Function.
37253 example: __PNF-NAME__
37254 - name: interface-name
37256 description: Name that identifies the link aggregate interface
37259 example: __INTERFACE-NAME__
37260 - name: interface-name
37262 description: Name given to the interface
37265 example: __INTERFACE-NAME__
37266 - name: vlan-interface
37268 description: String that identifies the interface
37271 example: __VLAN-INTERFACE__
37274 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
37277 $ref: "#/definitions/relationship"
37281 summary: delete an existing relationship
37282 description: delete an existing relationship
37283 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
37292 description: Response codes found in [response codes](https://wiki.onap.org/).
37296 description: unique name of Physical Network Function.
37299 example: __PNF-NAME__
37300 - name: interface-name
37302 description: Name that identifies the link aggregate interface
37305 example: __INTERFACE-NAME__
37306 - name: interface-name
37308 description: Name given to the interface
37311 example: __INTERFACE-NAME__
37312 - name: vlan-interface
37314 description: String that identifies the interface
37317 example: __VLAN-INTERFACE__
37318 /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:
37322 summary: see node definition for valid relationships
37323 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
37332 description: Response codes found in [response codes](https://wiki.onap.org/).
37336 description: unique name of Physical Network Function.
37339 example: __PNF-NAME__
37340 - name: interface-name
37342 description: Name that identifies the link aggregate interface
37345 example: __INTERFACE-NAME__
37346 - name: interface-name
37348 description: Name given to the interface
37351 example: __INTERFACE-NAME__
37352 - name: vlan-interface
37354 description: String that identifies the interface
37357 example: __VLAN-INTERFACE__
37358 - name: l3-interface-ipv4-address
37360 description: IP address
37363 example: __L3-INTERFACE-IPV4-ADDRESS__
37366 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
37369 $ref: "#/definitions/relationship"
37373 summary: delete an existing relationship
37374 description: delete an existing relationship
37375 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
37384 description: Response codes found in [response codes](https://wiki.onap.org/).
37388 description: unique name of Physical Network Function.
37391 example: __PNF-NAME__
37392 - name: interface-name
37394 description: Name that identifies the link aggregate interface
37397 example: __INTERFACE-NAME__
37398 - name: interface-name
37400 description: Name given to the interface
37403 example: __INTERFACE-NAME__
37404 - name: vlan-interface
37406 description: String that identifies the interface
37409 example: __VLAN-INTERFACE__
37410 - name: l3-interface-ipv4-address
37412 description: IP address
37415 example: __L3-INTERFACE-IPV4-ADDRESS__
37416 /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}:
37420 summary: returns l3-interface-ipv4-address-list
37421 description: returns l3-interface-ipv4-address-list
37422 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37428 description: successful operation
37430 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
37432 description: Response codes found in [response codes](https://wiki.onap.org/).
37436 description: unique name of Physical Network Function.
37439 example: __PNF-NAME__
37440 - name: interface-name
37442 description: Name that identifies the link aggregate interface
37445 example: __INTERFACE-NAME__
37446 - name: interface-name
37448 description: Name given to the interface
37451 example: __INTERFACE-NAME__
37452 - name: vlan-interface
37454 description: String that identifies the interface
37457 example: __VLAN-INTERFACE__
37458 - name: l3-interface-ipv4-address
37460 description: IP address
37463 example: __L3-INTERFACE-IPV4-ADDRESS__
37467 summary: create or update an existing l3-interface-ipv4-address-list
37469 Create or update an existing l3-interface-ipv4-address-list.
37471 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37472 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37481 description: Response codes found in [response codes](https://wiki.onap.org/).
37485 description: unique name of Physical Network Function.
37488 example: __PNF-NAME__
37489 - name: interface-name
37491 description: Name that identifies the link aggregate interface
37494 example: __INTERFACE-NAME__
37495 - name: interface-name
37497 description: Name given to the interface
37500 example: __INTERFACE-NAME__
37501 - name: vlan-interface
37503 description: String that identifies the interface
37506 example: __VLAN-INTERFACE__
37507 - name: l3-interface-ipv4-address
37509 description: IP address
37512 example: __L3-INTERFACE-IPV4-ADDRESS__
37515 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
37518 $ref: "#/definitions/l3-interface-ipv4-address-list"
37522 summary: update an existing l3-interface-ipv4-address-list
37524 Update an existing l3-interface-ipv4-address-list
37526 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37527 The PUT operation will entirely replace an existing object.
37528 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37530 Other differences between PUT and PATCH are:
37532 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37533 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37534 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37535 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37544 description: Response codes found in [response codes](https://wiki.onap.org/).
37548 description: unique name of Physical Network Function.
37551 example: __PNF-NAME__
37552 - name: interface-name
37554 description: Name that identifies the link aggregate interface
37557 example: __INTERFACE-NAME__
37558 - name: interface-name
37560 description: Name given to the interface
37563 example: __INTERFACE-NAME__
37564 - name: vlan-interface
37566 description: String that identifies the interface
37569 example: __VLAN-INTERFACE__
37570 - name: l3-interface-ipv4-address
37572 description: IP address
37575 example: __L3-INTERFACE-IPV4-ADDRESS__
37578 description: l3-interface-ipv4-address-list object that needs to be updated.
37581 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
37585 summary: delete an existing l3-interface-ipv4-address-list
37586 description: delete an existing l3-interface-ipv4-address-list
37587 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37596 description: Response codes found in [response codes](https://wiki.onap.org/).
37600 description: unique name of Physical Network Function.
37603 example: __PNF-NAME__
37604 - name: interface-name
37606 description: Name that identifies the link aggregate interface
37609 example: __INTERFACE-NAME__
37610 - name: interface-name
37612 description: Name given to the interface
37615 example: __INTERFACE-NAME__
37616 - name: vlan-interface
37618 description: String that identifies the interface
37621 example: __VLAN-INTERFACE__
37622 - name: l3-interface-ipv4-address
37624 description: IP address
37627 example: __L3-INTERFACE-IPV4-ADDRESS__
37628 - name: resource-version
37630 description: resource-version for concurrency
37633 /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:
37637 summary: see node definition for valid relationships
37638 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
37647 description: Response codes found in [response codes](https://wiki.onap.org/).
37651 description: unique name of Physical Network Function.
37654 example: __PNF-NAME__
37655 - name: interface-name
37657 description: Name that identifies the link aggregate interface
37660 example: __INTERFACE-NAME__
37661 - name: interface-name
37663 description: Name given to the interface
37666 example: __INTERFACE-NAME__
37667 - name: vlan-interface
37669 description: String that identifies the interface
37672 example: __VLAN-INTERFACE__
37673 - name: l3-interface-ipv6-address
37675 description: IP address
37678 example: __L3-INTERFACE-IPV6-ADDRESS__
37681 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
37684 $ref: "#/definitions/relationship"
37688 summary: delete an existing relationship
37689 description: delete an existing relationship
37690 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
37699 description: Response codes found in [response codes](https://wiki.onap.org/).
37703 description: unique name of Physical Network Function.
37706 example: __PNF-NAME__
37707 - name: interface-name
37709 description: Name that identifies the link aggregate interface
37712 example: __INTERFACE-NAME__
37713 - name: interface-name
37715 description: Name given to the interface
37718 example: __INTERFACE-NAME__
37719 - name: vlan-interface
37721 description: String that identifies the interface
37724 example: __VLAN-INTERFACE__
37725 - name: l3-interface-ipv6-address
37727 description: IP address
37730 example: __L3-INTERFACE-IPV6-ADDRESS__
37731 /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}:
37735 summary: returns l3-interface-ipv6-address-list
37736 description: returns l3-interface-ipv6-address-list
37737 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37743 description: successful operation
37745 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
37747 description: Response codes found in [response codes](https://wiki.onap.org/).
37751 description: unique name of Physical Network Function.
37754 example: __PNF-NAME__
37755 - name: interface-name
37757 description: Name that identifies the link aggregate interface
37760 example: __INTERFACE-NAME__
37761 - name: interface-name
37763 description: Name given to the interface
37766 example: __INTERFACE-NAME__
37767 - name: vlan-interface
37769 description: String that identifies the interface
37772 example: __VLAN-INTERFACE__
37773 - name: l3-interface-ipv6-address
37775 description: IP address
37778 example: __L3-INTERFACE-IPV6-ADDRESS__
37782 summary: create or update an existing l3-interface-ipv6-address-list
37784 Create or update an existing l3-interface-ipv6-address-list.
37786 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37787 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37796 description: Response codes found in [response codes](https://wiki.onap.org/).
37800 description: unique name of Physical Network Function.
37803 example: __PNF-NAME__
37804 - name: interface-name
37806 description: Name that identifies the link aggregate interface
37809 example: __INTERFACE-NAME__
37810 - name: interface-name
37812 description: Name given to the interface
37815 example: __INTERFACE-NAME__
37816 - name: vlan-interface
37818 description: String that identifies the interface
37821 example: __VLAN-INTERFACE__
37822 - name: l3-interface-ipv6-address
37824 description: IP address
37827 example: __L3-INTERFACE-IPV6-ADDRESS__
37830 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
37833 $ref: "#/definitions/l3-interface-ipv6-address-list"
37837 summary: update an existing l3-interface-ipv6-address-list
37839 Update an existing l3-interface-ipv6-address-list
37841 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37842 The PUT operation will entirely replace an existing object.
37843 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37845 Other differences between PUT and PATCH are:
37847 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37848 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37849 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37850 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37859 description: Response codes found in [response codes](https://wiki.onap.org/).
37863 description: unique name of Physical Network Function.
37866 example: __PNF-NAME__
37867 - name: interface-name
37869 description: Name that identifies the link aggregate interface
37872 example: __INTERFACE-NAME__
37873 - name: interface-name
37875 description: Name given to the interface
37878 example: __INTERFACE-NAME__
37879 - name: vlan-interface
37881 description: String that identifies the interface
37884 example: __VLAN-INTERFACE__
37885 - name: l3-interface-ipv6-address
37887 description: IP address
37890 example: __L3-INTERFACE-IPV6-ADDRESS__
37893 description: l3-interface-ipv6-address-list object that needs to be updated.
37896 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
37900 summary: delete an existing l3-interface-ipv6-address-list
37901 description: delete an existing l3-interface-ipv6-address-list
37902 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37911 description: Response codes found in [response codes](https://wiki.onap.org/).
37915 description: unique name of Physical Network Function.
37918 example: __PNF-NAME__
37919 - name: interface-name
37921 description: Name that identifies the link aggregate interface
37924 example: __INTERFACE-NAME__
37925 - name: interface-name
37927 description: Name given to the interface
37930 example: __INTERFACE-NAME__
37931 - name: vlan-interface
37933 description: String that identifies the interface
37936 example: __VLAN-INTERFACE__
37937 - name: l3-interface-ipv6-address
37939 description: IP address
37942 example: __L3-INTERFACE-IPV6-ADDRESS__
37943 - name: resource-version
37945 description: resource-version for concurrency
37948 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
37952 summary: returns vlan
37953 description: returns vlan
37954 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
37960 description: successful operation
37962 $ref: "#/getDefinitions/vlan"
37964 description: Response codes found in [response codes](https://wiki.onap.org/).
37968 description: unique name of Physical Network Function.
37971 example: __PNF-NAME__
37972 - name: interface-name
37974 description: Name that identifies the link aggregate interface
37977 example: __INTERFACE-NAME__
37978 - name: interface-name
37980 description: Name given to the interface
37983 example: __INTERFACE-NAME__
37984 - name: vlan-interface
37986 description: String that identifies the interface
37989 example: __VLAN-INTERFACE__
37993 summary: create or update an existing vlan
37995 Create or update an existing vlan.
37997 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37998 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
38007 description: Response codes found in [response codes](https://wiki.onap.org/).
38011 description: unique name of Physical Network Function.
38014 example: __PNF-NAME__
38015 - name: interface-name
38017 description: Name that identifies the link aggregate interface
38020 example: __INTERFACE-NAME__
38021 - name: interface-name
38023 description: Name given to the interface
38026 example: __INTERFACE-NAME__
38027 - name: vlan-interface
38029 description: String that identifies the interface
38032 example: __VLAN-INTERFACE__
38035 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
38038 $ref: "#/definitions/vlan"
38042 summary: update an existing vlan
38044 Update an existing vlan
38046 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38047 The PUT operation will entirely replace an existing object.
38048 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38050 Other differences between PUT and PATCH are:
38052 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38053 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38054 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38055 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
38064 description: Response codes found in [response codes](https://wiki.onap.org/).
38068 description: unique name of Physical Network Function.
38071 example: __PNF-NAME__
38072 - name: interface-name
38074 description: Name that identifies the link aggregate interface
38077 example: __INTERFACE-NAME__
38078 - name: interface-name
38080 description: Name given to the interface
38083 example: __INTERFACE-NAME__
38084 - name: vlan-interface
38086 description: String that identifies the interface
38089 example: __VLAN-INTERFACE__
38092 description: vlan object that needs to be updated.
38095 $ref: "#/patchDefinitions/vlan"
38099 summary: delete an existing vlan
38100 description: delete an existing vlan
38101 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
38110 description: Response codes found in [response codes](https://wiki.onap.org/).
38114 description: unique name of Physical Network Function.
38117 example: __PNF-NAME__
38118 - name: interface-name
38120 description: Name that identifies the link aggregate interface
38123 example: __INTERFACE-NAME__
38124 - name: interface-name
38126 description: Name given to the interface
38129 example: __INTERFACE-NAME__
38130 - name: vlan-interface
38132 description: String that identifies the interface
38135 example: __VLAN-INTERFACE__
38136 - name: resource-version
38138 description: resource-version for concurrency
38141 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
38145 summary: returns vlans
38146 description: returns vlans
38147 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
38153 description: successful operation
38155 $ref: "#/getDefinitions/vlans"
38157 description: Response codes found in [response codes](https://wiki.onap.org/).
38161 description: unique name of Physical Network Function.
38164 example: __PNF-NAME__
38165 - name: interface-name
38167 description: Name that identifies the link aggregate interface
38170 example: __INTERFACE-NAME__
38171 - name: interface-name
38173 description: Name given to the interface
38176 example: __INTERFACE-NAME__
38177 - name: vlan-interface
38182 - name: vlan-id-inner
38193 /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:
38197 summary: see node definition for valid relationships
38198 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
38207 description: Response codes found in [response codes](https://wiki.onap.org/).
38211 description: unique name of Physical Network Function.
38214 example: __PNF-NAME__
38215 - name: interface-name
38217 description: Name that identifies the link aggregate interface
38220 example: __INTERFACE-NAME__
38221 - name: interface-name
38223 description: Name given to the interface
38226 example: __INTERFACE-NAME__
38229 description: PCI ID used to identify the sriov-vf
38232 example: __PCI-ID__
38235 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
38238 $ref: "#/definitions/relationship"
38242 summary: delete an existing relationship
38243 description: delete an existing relationship
38244 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
38253 description: Response codes found in [response codes](https://wiki.onap.org/).
38257 description: unique name of Physical Network Function.
38260 example: __PNF-NAME__
38261 - name: interface-name
38263 description: Name that identifies the link aggregate interface
38266 example: __INTERFACE-NAME__
38267 - name: interface-name
38269 description: Name given to the interface
38272 example: __INTERFACE-NAME__
38275 description: PCI ID used to identify the sriov-vf
38278 example: __PCI-ID__
38279 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
38283 summary: returns sriov-vf
38284 description: returns sriov-vf
38285 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38291 description: successful operation
38293 $ref: "#/getDefinitions/sriov-vf"
38295 description: Response codes found in [response codes](https://wiki.onap.org/).
38299 description: unique name of Physical Network Function.
38302 example: __PNF-NAME__
38303 - name: interface-name
38305 description: Name that identifies the link aggregate interface
38308 example: __INTERFACE-NAME__
38309 - name: interface-name
38311 description: Name given to the interface
38314 example: __INTERFACE-NAME__
38317 description: PCI ID used to identify the sriov-vf
38320 example: __PCI-ID__
38324 summary: create or update an existing sriov-vf
38326 Create or update an existing sriov-vf.
38328 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38329 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38338 description: Response codes found in [response codes](https://wiki.onap.org/).
38342 description: unique name of Physical Network Function.
38345 example: __PNF-NAME__
38346 - name: interface-name
38348 description: Name that identifies the link aggregate interface
38351 example: __INTERFACE-NAME__
38352 - name: interface-name
38354 description: Name given to the interface
38357 example: __INTERFACE-NAME__
38360 description: PCI ID used to identify the sriov-vf
38363 example: __PCI-ID__
38366 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
38369 $ref: "#/definitions/sriov-vf"
38373 summary: update an existing sriov-vf
38375 Update an existing sriov-vf
38377 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38378 The PUT operation will entirely replace an existing object.
38379 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38381 Other differences between PUT and PATCH are:
38383 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38384 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38385 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38386 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38395 description: Response codes found in [response codes](https://wiki.onap.org/).
38399 description: unique name of Physical Network Function.
38402 example: __PNF-NAME__
38403 - name: interface-name
38405 description: Name that identifies the link aggregate interface
38408 example: __INTERFACE-NAME__
38409 - name: interface-name
38411 description: Name given to the interface
38414 example: __INTERFACE-NAME__
38417 description: PCI ID used to identify the sriov-vf
38420 example: __PCI-ID__
38423 description: sriov-vf object that needs to be updated.
38426 $ref: "#/patchDefinitions/sriov-vf"
38430 summary: delete an existing sriov-vf
38431 description: delete an existing sriov-vf
38432 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38441 description: Response codes found in [response codes](https://wiki.onap.org/).
38445 description: unique name of Physical Network Function.
38448 example: __PNF-NAME__
38449 - name: interface-name
38451 description: Name that identifies the link aggregate interface
38454 example: __INTERFACE-NAME__
38455 - name: interface-name
38457 description: Name given to the interface
38460 example: __INTERFACE-NAME__
38463 description: PCI ID used to identify the sriov-vf
38466 example: __PCI-ID__
38467 - name: resource-version
38469 description: resource-version for concurrency
38472 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
38476 summary: returns sriov-vfs
38477 description: returns sriov-vfs
38478 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
38484 description: successful operation
38486 $ref: "#/getDefinitions/sriov-vfs"
38488 description: Response codes found in [response codes](https://wiki.onap.org/).
38492 description: unique name of Physical Network Function.
38495 example: __PNF-NAME__
38496 - name: interface-name
38498 description: Name that identifies the link aggregate interface
38501 example: __INTERFACE-NAME__
38502 - name: interface-name
38504 description: Name given to the interface
38507 example: __INTERFACE-NAME__
38513 - name: vf-vlan-filter
38518 - name: vf-mac-filter
38523 - name: vf-vlan-strip
38528 - name: neutron-network-id
38533 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
38537 summary: see node definition for valid relationships
38538 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
38547 description: Response codes found in [response codes](https://wiki.onap.org/).
38551 description: unique name of Physical Network Function.
38554 example: __PNF-NAME__
38555 - name: interface-name
38557 description: Name that identifies the link aggregate interface
38560 example: __INTERFACE-NAME__
38561 - name: interface-name
38563 description: Name given to the interface
38566 example: __INTERFACE-NAME__
38569 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
38572 $ref: "#/definitions/relationship"
38576 summary: delete an existing relationship
38577 description: delete an existing relationship
38578 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
38587 description: Response codes found in [response codes](https://wiki.onap.org/).
38591 description: unique name of Physical Network Function.
38594 example: __PNF-NAME__
38595 - name: interface-name
38597 description: Name that identifies the link aggregate interface
38600 example: __INTERFACE-NAME__
38601 - name: interface-name
38603 description: Name given to the interface
38606 example: __INTERFACE-NAME__
38607 /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:
38611 summary: see node definition for valid relationships
38612 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
38621 description: Response codes found in [response codes](https://wiki.onap.org/).
38625 description: unique name of Physical Network Function.
38628 example: __PNF-NAME__
38629 - name: interface-name
38631 description: Name that identifies the link aggregate interface
38634 example: __INTERFACE-NAME__
38635 - name: interface-name
38637 description: Name given to the interface
38640 example: __INTERFACE-NAME__
38641 - name: l3-interface-ipv4-address
38643 description: IP address
38646 example: __L3-INTERFACE-IPV4-ADDRESS__
38649 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
38652 $ref: "#/definitions/relationship"
38656 summary: delete an existing relationship
38657 description: delete an existing relationship
38658 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
38667 description: Response codes found in [response codes](https://wiki.onap.org/).
38671 description: unique name of Physical Network Function.
38674 example: __PNF-NAME__
38675 - name: interface-name
38677 description: Name that identifies the link aggregate interface
38680 example: __INTERFACE-NAME__
38681 - name: interface-name
38683 description: Name given to the interface
38686 example: __INTERFACE-NAME__
38687 - name: l3-interface-ipv4-address
38689 description: IP address
38692 example: __L3-INTERFACE-IPV4-ADDRESS__
38693 /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}:
38697 summary: returns l3-interface-ipv4-address-list
38698 description: returns l3-interface-ipv4-address-list
38699 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
38705 description: successful operation
38707 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
38709 description: Response codes found in [response codes](https://wiki.onap.org/).
38713 description: unique name of Physical Network Function.
38716 example: __PNF-NAME__
38717 - name: interface-name
38719 description: Name that identifies the link aggregate interface
38722 example: __INTERFACE-NAME__
38723 - name: interface-name
38725 description: Name given to the interface
38728 example: __INTERFACE-NAME__
38729 - name: l3-interface-ipv4-address
38731 description: IP address
38734 example: __L3-INTERFACE-IPV4-ADDRESS__
38738 summary: create or update an existing l3-interface-ipv4-address-list
38740 Create or update an existing l3-interface-ipv4-address-list.
38742 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38743 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
38752 description: Response codes found in [response codes](https://wiki.onap.org/).
38756 description: unique name of Physical Network Function.
38759 example: __PNF-NAME__
38760 - name: interface-name
38762 description: Name that identifies the link aggregate interface
38765 example: __INTERFACE-NAME__
38766 - name: interface-name
38768 description: Name given to the interface
38771 example: __INTERFACE-NAME__
38772 - name: l3-interface-ipv4-address
38774 description: IP address
38777 example: __L3-INTERFACE-IPV4-ADDRESS__
38780 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
38783 $ref: "#/definitions/l3-interface-ipv4-address-list"
38787 summary: update an existing l3-interface-ipv4-address-list
38789 Update an existing l3-interface-ipv4-address-list
38791 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38792 The PUT operation will entirely replace an existing object.
38793 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38795 Other differences between PUT and PATCH are:
38797 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38798 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38799 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38800 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
38809 description: Response codes found in [response codes](https://wiki.onap.org/).
38813 description: unique name of Physical Network Function.
38816 example: __PNF-NAME__
38817 - name: interface-name
38819 description: Name that identifies the link aggregate interface
38822 example: __INTERFACE-NAME__
38823 - name: interface-name
38825 description: Name given to the interface
38828 example: __INTERFACE-NAME__
38829 - name: l3-interface-ipv4-address
38831 description: IP address
38834 example: __L3-INTERFACE-IPV4-ADDRESS__
38837 description: l3-interface-ipv4-address-list object that needs to be updated.
38840 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
38844 summary: delete an existing l3-interface-ipv4-address-list
38845 description: delete an existing l3-interface-ipv4-address-list
38846 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
38855 description: Response codes found in [response codes](https://wiki.onap.org/).
38859 description: unique name of Physical Network Function.
38862 example: __PNF-NAME__
38863 - name: interface-name
38865 description: Name that identifies the link aggregate interface
38868 example: __INTERFACE-NAME__
38869 - name: interface-name
38871 description: Name given to the interface
38874 example: __INTERFACE-NAME__
38875 - name: l3-interface-ipv4-address
38877 description: IP address
38880 example: __L3-INTERFACE-IPV4-ADDRESS__
38881 - name: resource-version
38883 description: resource-version for concurrency
38886 /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:
38890 summary: see node definition for valid relationships
38891 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
38900 description: Response codes found in [response codes](https://wiki.onap.org/).
38904 description: unique name of Physical Network Function.
38907 example: __PNF-NAME__
38908 - name: interface-name
38910 description: Name that identifies the link aggregate interface
38913 example: __INTERFACE-NAME__
38914 - name: interface-name
38916 description: Name given to the interface
38919 example: __INTERFACE-NAME__
38920 - name: l3-interface-ipv6-address
38922 description: IP address
38925 example: __L3-INTERFACE-IPV6-ADDRESS__
38928 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
38931 $ref: "#/definitions/relationship"
38935 summary: delete an existing relationship
38936 description: delete an existing relationship
38937 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
38946 description: Response codes found in [response codes](https://wiki.onap.org/).
38950 description: unique name of Physical Network Function.
38953 example: __PNF-NAME__
38954 - name: interface-name
38956 description: Name that identifies the link aggregate interface
38959 example: __INTERFACE-NAME__
38960 - name: interface-name
38962 description: Name given to the interface
38965 example: __INTERFACE-NAME__
38966 - name: l3-interface-ipv6-address
38968 description: IP address
38971 example: __L3-INTERFACE-IPV6-ADDRESS__
38972 /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}:
38976 summary: returns l3-interface-ipv6-address-list
38977 description: returns l3-interface-ipv6-address-list
38978 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
38984 description: successful operation
38986 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
38988 description: Response codes found in [response codes](https://wiki.onap.org/).
38992 description: unique name of Physical Network Function.
38995 example: __PNF-NAME__
38996 - name: interface-name
38998 description: Name that identifies the link aggregate interface
39001 example: __INTERFACE-NAME__
39002 - name: interface-name
39004 description: Name given to the interface
39007 example: __INTERFACE-NAME__
39008 - name: l3-interface-ipv6-address
39010 description: IP address
39013 example: __L3-INTERFACE-IPV6-ADDRESS__
39017 summary: create or update an existing l3-interface-ipv6-address-list
39019 Create or update an existing l3-interface-ipv6-address-list.
39021 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39022 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39031 description: Response codes found in [response codes](https://wiki.onap.org/).
39035 description: unique name of Physical Network Function.
39038 example: __PNF-NAME__
39039 - name: interface-name
39041 description: Name that identifies the link aggregate interface
39044 example: __INTERFACE-NAME__
39045 - name: interface-name
39047 description: Name given to the interface
39050 example: __INTERFACE-NAME__
39051 - name: l3-interface-ipv6-address
39053 description: IP address
39056 example: __L3-INTERFACE-IPV6-ADDRESS__
39059 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
39062 $ref: "#/definitions/l3-interface-ipv6-address-list"
39066 summary: update an existing l3-interface-ipv6-address-list
39068 Update an existing l3-interface-ipv6-address-list
39070 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39071 The PUT operation will entirely replace an existing object.
39072 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39074 Other differences between PUT and PATCH are:
39076 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39077 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39078 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39079 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39088 description: Response codes found in [response codes](https://wiki.onap.org/).
39092 description: unique name of Physical Network Function.
39095 example: __PNF-NAME__
39096 - name: interface-name
39098 description: Name that identifies the link aggregate interface
39101 example: __INTERFACE-NAME__
39102 - name: interface-name
39104 description: Name given to the interface
39107 example: __INTERFACE-NAME__
39108 - name: l3-interface-ipv6-address
39110 description: IP address
39113 example: __L3-INTERFACE-IPV6-ADDRESS__
39116 description: l3-interface-ipv6-address-list object that needs to be updated.
39119 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
39123 summary: delete an existing l3-interface-ipv6-address-list
39124 description: delete an existing l3-interface-ipv6-address-list
39125 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39134 description: Response codes found in [response codes](https://wiki.onap.org/).
39138 description: unique name of Physical Network Function.
39141 example: __PNF-NAME__
39142 - name: interface-name
39144 description: Name that identifies the link aggregate interface
39147 example: __INTERFACE-NAME__
39148 - name: interface-name
39150 description: Name given to the interface
39153 example: __INTERFACE-NAME__
39154 - name: l3-interface-ipv6-address
39156 description: IP address
39159 example: __L3-INTERFACE-IPV6-ADDRESS__
39160 - name: resource-version
39162 description: resource-version for concurrency
39165 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
39169 summary: returns l-interface
39170 description: returns l-interface
39171 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
39177 description: successful operation
39179 $ref: "#/getDefinitions/l-interface"
39181 description: Response codes found in [response codes](https://wiki.onap.org/).
39185 description: unique name of Physical Network Function.
39188 example: __PNF-NAME__
39189 - name: interface-name
39191 description: Name that identifies the link aggregate interface
39194 example: __INTERFACE-NAME__
39195 - name: interface-name
39197 description: Name given to the interface
39200 example: __INTERFACE-NAME__
39204 summary: create or update an existing l-interface
39206 Create or update an existing l-interface.
39208 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39209 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
39218 description: Response codes found in [response codes](https://wiki.onap.org/).
39222 description: unique name of Physical Network Function.
39225 example: __PNF-NAME__
39226 - name: interface-name
39228 description: Name that identifies the link aggregate interface
39231 example: __INTERFACE-NAME__
39232 - name: interface-name
39234 description: Name given to the interface
39237 example: __INTERFACE-NAME__
39240 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
39243 $ref: "#/definitions/l-interface"
39247 summary: update an existing l-interface
39249 Update an existing l-interface
39251 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39252 The PUT operation will entirely replace an existing object.
39253 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39255 Other differences between PUT and PATCH are:
39257 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39258 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39259 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39260 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
39269 description: Response codes found in [response codes](https://wiki.onap.org/).
39273 description: unique name of Physical Network Function.
39276 example: __PNF-NAME__
39277 - name: interface-name
39279 description: Name that identifies the link aggregate interface
39282 example: __INTERFACE-NAME__
39283 - name: interface-name
39285 description: Name given to the interface
39288 example: __INTERFACE-NAME__
39291 description: l-interface object that needs to be updated.
39294 $ref: "#/patchDefinitions/l-interface"
39298 summary: delete an existing l-interface
39299 description: delete an existing l-interface
39300 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
39309 description: Response codes found in [response codes](https://wiki.onap.org/).
39313 description: unique name of Physical Network Function.
39316 example: __PNF-NAME__
39317 - name: interface-name
39319 description: Name that identifies the link aggregate interface
39322 example: __INTERFACE-NAME__
39323 - name: interface-name
39325 description: Name given to the interface
39328 example: __INTERFACE-NAME__
39329 - name: resource-version
39331 description: resource-version for concurrency
39334 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
39338 summary: returns l-interfaces
39339 description: returns l-interfaces
39340 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces
39346 description: successful operation
39348 $ref: "#/getDefinitions/l-interfaces"
39350 description: Response codes found in [response codes](https://wiki.onap.org/).
39354 description: unique name of Physical Network Function.
39357 example: __PNF-NAME__
39358 - name: interface-name
39360 description: Name that identifies the link aggregate interface
39363 example: __INTERFACE-NAME__
39364 - name: interface-name
39369 - name: interface-id
39379 - name: network-name
39384 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}:
39388 summary: returns lag-interface
39389 description: returns lag-interface
39390 operationId: getNetworkPnfsPnfLagInterfacesLagInterface
39396 description: successful operation
39398 $ref: "#/getDefinitions/lag-interface"
39400 description: Response codes found in [response codes](https://wiki.onap.org/).
39404 description: unique name of Physical Network Function.
39407 example: __PNF-NAME__
39408 - name: interface-name
39410 description: Name that identifies the link aggregate interface
39413 example: __INTERFACE-NAME__
39417 summary: create or update an existing lag-interface
39419 Create or update an existing lag-interface.
39421 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39422 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface
39431 description: Response codes found in [response codes](https://wiki.onap.org/).
39435 description: unique name of Physical Network Function.
39438 example: __PNF-NAME__
39439 - name: interface-name
39441 description: Name that identifies the link aggregate interface
39444 example: __INTERFACE-NAME__
39447 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterface.json)
39450 $ref: "#/definitions/lag-interface"
39454 summary: update an existing lag-interface
39456 Update an existing lag-interface
39458 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39459 The PUT operation will entirely replace an existing object.
39460 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39462 Other differences between PUT and PATCH are:
39464 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39465 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39466 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39467 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterface
39476 description: Response codes found in [response codes](https://wiki.onap.org/).
39480 description: unique name of Physical Network Function.
39483 example: __PNF-NAME__
39484 - name: interface-name
39486 description: Name that identifies the link aggregate interface
39489 example: __INTERFACE-NAME__
39492 description: lag-interface object that needs to be updated.
39495 $ref: "#/patchDefinitions/lag-interface"
39499 summary: delete an existing lag-interface
39500 description: delete an existing lag-interface
39501 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface
39510 description: Response codes found in [response codes](https://wiki.onap.org/).
39514 description: unique name of Physical Network Function.
39517 example: __PNF-NAME__
39518 - name: interface-name
39520 description: Name that identifies the link aggregate interface
39523 example: __INTERFACE-NAME__
39524 - name: resource-version
39526 description: resource-version for concurrency
39529 /network/pnfs/pnf/{pnf-name}/lag-interfaces:
39533 summary: returns lag-interfaces
39534 description: returns lag-interfaces
39535 operationId: getNetworkPnfsPnfLagInterfaces
39541 description: successful operation
39543 $ref: "#/getDefinitions/lag-interfaces"
39545 description: Response codes found in [response codes](https://wiki.onap.org/).
39549 description: unique name of Physical Network Function.
39552 example: __PNF-NAME__
39553 - name: interface-name
39558 - name: interface-id
39563 - name: interface-role
39568 /network/pnfs/pnf/{pnf-name}:
39572 summary: returns pnf
39573 description: returns pnf
39574 operationId: getNetworkPnfsPnf
39580 description: successful operation
39582 $ref: "#/getDefinitions/pnf"
39584 description: Response codes found in [response codes](https://wiki.onap.org/).
39588 description: unique name of Physical Network Function.
39591 example: __PNF-NAME__
39595 summary: create or update an existing pnf
39597 Create or update an existing pnf.
39599 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39600 operationId: createOrUpdateNetworkPnfsPnf
39609 description: Response codes found in [response codes](https://wiki.onap.org/).
39613 description: unique name of Physical Network Function.
39616 example: __PNF-NAME__
39619 description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnf.json)
39622 $ref: "#/definitions/pnf"
39626 summary: update an existing pnf
39628 Update an existing pnf
39630 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39631 The PUT operation will entirely replace an existing object.
39632 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39634 Other differences between PUT and PATCH are:
39636 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39637 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39638 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39639 operationId: UpdateNetworkPnfsPnf
39648 description: Response codes found in [response codes](https://wiki.onap.org/).
39652 description: unique name of Physical Network Function.
39655 example: __PNF-NAME__
39658 description: pnf object that needs to be updated.
39661 $ref: "#/patchDefinitions/pnf"
39665 summary: delete an existing pnf
39666 description: delete an existing pnf
39667 operationId: deleteNetworkPnfsPnf
39676 description: Response codes found in [response codes](https://wiki.onap.org/).
39680 description: unique name of Physical Network Function.
39683 example: __PNF-NAME__
39684 - name: resource-version
39686 description: resource-version for concurrency
39693 summary: returns pnfs
39694 description: returns pnfs
39695 operationId: getNetworkPnfs
39701 description: successful operation
39703 $ref: "#/getDefinitions/pnfs"
39705 description: Response codes found in [response codes](https://wiki.onap.org/).
39717 /network/physical-links/physical-link/{link-name}/relationship-list/relationship:
39721 summary: see node definition for valid relationships
39722 operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
39731 description: Response codes found in [response codes](https://wiki.onap.org/).
39735 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
39738 example: __LINK-NAME__
39741 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPhysicalLinksPhysicalLink.json)
39744 $ref: "#/definitions/relationship"
39748 summary: delete an existing relationship
39749 description: delete an existing relationship
39750 operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
39759 description: Response codes found in [response codes](https://wiki.onap.org/).
39763 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
39766 example: __LINK-NAME__
39767 /network/physical-links/physical-link/{link-name}:
39771 summary: returns physical-link
39772 description: returns physical-link
39773 operationId: getNetworkPhysicalLinksPhysicalLink
39779 description: successful operation
39781 $ref: "#/getDefinitions/physical-link"
39783 description: Response codes found in [response codes](https://wiki.onap.org/).
39787 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
39790 example: __LINK-NAME__
39794 summary: create or update an existing physical-link
39796 Create or update an existing physical-link.
39798 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39799 operationId: createOrUpdateNetworkPhysicalLinksPhysicalLink
39808 description: Response codes found in [response codes](https://wiki.onap.org/).
39812 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
39815 example: __LINK-NAME__
39818 description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPhysicalLinksPhysicalLink.json)
39821 $ref: "#/definitions/physical-link"
39825 summary: update an existing physical-link
39827 Update an existing physical-link
39829 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39830 The PUT operation will entirely replace an existing object.
39831 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39833 Other differences between PUT and PATCH are:
39835 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39836 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39837 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39838 operationId: UpdateNetworkPhysicalLinksPhysicalLink
39847 description: Response codes found in [response codes](https://wiki.onap.org/).
39851 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
39854 example: __LINK-NAME__
39857 description: physical-link object that needs to be updated.
39860 $ref: "#/patchDefinitions/physical-link"
39864 summary: delete an existing physical-link
39865 description: delete an existing physical-link
39866 operationId: deleteNetworkPhysicalLinksPhysicalLink
39875 description: Response codes found in [response codes](https://wiki.onap.org/).
39879 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
39882 example: __LINK-NAME__
39883 - name: resource-version
39885 description: resource-version for concurrency
39888 /network/physical-links:
39892 summary: returns physical-links
39893 description: returns physical-links
39894 operationId: getNetworkPhysicalLinks
39900 description: successful operation
39902 $ref: "#/getDefinitions/physical-links"
39904 description: Response codes found in [response codes](https://wiki.onap.org/).
39916 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship:
39920 summary: see node definition for valid relationships
39921 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
39930 description: Response codes found in [response codes](https://wiki.onap.org/).
39932 - name: ipsec-configuration-id
39934 description: UUID of this configuration
39937 example: __IPSEC-CONFIGURATION-ID__
39940 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkIpsecConfigurationsIpsecConfiguration.json)
39943 $ref: "#/definitions/relationship"
39947 summary: delete an existing relationship
39948 description: delete an existing relationship
39949 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
39958 description: Response codes found in [response codes](https://wiki.onap.org/).
39960 - name: ipsec-configuration-id
39962 description: UUID of this configuration
39965 example: __IPSEC-CONFIGURATION-ID__
39966 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship:
39970 summary: see node definition for valid relationships
39971 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
39980 description: Response codes found in [response codes](https://wiki.onap.org/).
39982 - name: ipsec-configuration-id
39984 description: UUID of this configuration
39987 example: __IPSEC-CONFIGURATION-ID__
39988 - name: vig-address-type
39990 description: indicates whether the VIG is for AVPN or INTERNET
39993 example: __VIG-ADDRESS-TYPE__
39996 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
39999 $ref: "#/definitions/relationship"
40003 summary: delete an existing relationship
40004 description: delete an existing relationship
40005 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
40014 description: Response codes found in [response codes](https://wiki.onap.org/).
40016 - name: ipsec-configuration-id
40018 description: UUID of this configuration
40021 example: __IPSEC-CONFIGURATION-ID__
40022 - name: vig-address-type
40024 description: indicates whether the VIG is for AVPN or INTERNET
40027 example: __VIG-ADDRESS-TYPE__
40028 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}:
40032 summary: returns vig-server
40033 description: returns vig-server
40034 operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
40040 description: successful operation
40042 $ref: "#/getDefinitions/vig-server"
40044 description: Response codes found in [response codes](https://wiki.onap.org/).
40046 - name: ipsec-configuration-id
40048 description: UUID of this configuration
40051 example: __IPSEC-CONFIGURATION-ID__
40052 - name: vig-address-type
40054 description: indicates whether the VIG is for AVPN or INTERNET
40057 example: __VIG-ADDRESS-TYPE__
40061 summary: create or update an existing vig-server
40063 Create or update an existing vig-server.
40065 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40066 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
40075 description: Response codes found in [response codes](https://wiki.onap.org/).
40077 - name: ipsec-configuration-id
40079 description: UUID of this configuration
40082 example: __IPSEC-CONFIGURATION-ID__
40083 - name: vig-address-type
40085 description: indicates whether the VIG is for AVPN or INTERNET
40088 example: __VIG-ADDRESS-TYPE__
40091 description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
40094 $ref: "#/definitions/vig-server"
40098 summary: update an existing vig-server
40100 Update an existing vig-server
40102 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40103 The PUT operation will entirely replace an existing object.
40104 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40106 Other differences between PUT and PATCH are:
40108 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40109 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40110 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40111 operationId: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
40120 description: Response codes found in [response codes](https://wiki.onap.org/).
40122 - name: ipsec-configuration-id
40124 description: UUID of this configuration
40127 example: __IPSEC-CONFIGURATION-ID__
40128 - name: vig-address-type
40130 description: indicates whether the VIG is for AVPN or INTERNET
40133 example: __VIG-ADDRESS-TYPE__
40136 description: vig-server object that needs to be updated.
40139 $ref: "#/patchDefinitions/vig-server"
40143 summary: delete an existing vig-server
40144 description: delete an existing vig-server
40145 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
40154 description: Response codes found in [response codes](https://wiki.onap.org/).
40156 - name: ipsec-configuration-id
40158 description: UUID of this configuration
40161 example: __IPSEC-CONFIGURATION-ID__
40162 - name: vig-address-type
40164 description: indicates whether the VIG is for AVPN or INTERNET
40167 example: __VIG-ADDRESS-TYPE__
40168 - name: resource-version
40170 description: resource-version for concurrency
40173 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers:
40177 summary: returns vig-servers
40178 description: returns vig-servers
40179 operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers
40185 description: successful operation
40187 $ref: "#/getDefinitions/vig-servers"
40189 description: Response codes found in [response codes](https://wiki.onap.org/).
40191 - name: ipsec-configuration-id
40193 description: UUID of this configuration
40196 example: __IPSEC-CONFIGURATION-ID__
40197 - name: vig-address-type
40202 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}:
40206 summary: returns ipsec-configuration
40207 description: returns ipsec-configuration
40208 operationId: getNetworkIpsecConfigurationsIpsecConfiguration
40214 description: successful operation
40216 $ref: "#/getDefinitions/ipsec-configuration"
40218 description: Response codes found in [response codes](https://wiki.onap.org/).
40220 - name: ipsec-configuration-id
40222 description: UUID of this configuration
40225 example: __IPSEC-CONFIGURATION-ID__
40229 summary: create or update an existing ipsec-configuration
40231 Create or update an existing ipsec-configuration.
40233 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40234 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration
40243 description: Response codes found in [response codes](https://wiki.onap.org/).
40245 - name: ipsec-configuration-id
40247 description: UUID of this configuration
40250 example: __IPSEC-CONFIGURATION-ID__
40253 description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkIpsecConfigurationsIpsecConfiguration.json)
40256 $ref: "#/definitions/ipsec-configuration"
40260 summary: update an existing ipsec-configuration
40262 Update an existing ipsec-configuration
40264 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40265 The PUT operation will entirely replace an existing object.
40266 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40268 Other differences between PUT and PATCH are:
40270 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40271 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40272 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40273 operationId: UpdateNetworkIpsecConfigurationsIpsecConfiguration
40282 description: Response codes found in [response codes](https://wiki.onap.org/).
40284 - name: ipsec-configuration-id
40286 description: UUID of this configuration
40289 example: __IPSEC-CONFIGURATION-ID__
40292 description: ipsec-configuration object that needs to be updated.
40295 $ref: "#/patchDefinitions/ipsec-configuration"
40299 summary: delete an existing ipsec-configuration
40300 description: delete an existing ipsec-configuration
40301 operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration
40310 description: Response codes found in [response codes](https://wiki.onap.org/).
40312 - name: ipsec-configuration-id
40314 description: UUID of this configuration
40317 example: __IPSEC-CONFIGURATION-ID__
40318 - name: resource-version
40320 description: resource-version for concurrency
40323 /network/ipsec-configurations:
40327 summary: returns ipsec-configurations
40328 description: returns ipsec-configurations
40329 operationId: getNetworkIpsecConfigurations
40335 description: successful operation
40337 $ref: "#/getDefinitions/ipsec-configurations"
40339 description: Response codes found in [response codes](https://wiki.onap.org/).
40341 - name: ipsec-configuration-id
40346 /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship:
40350 summary: see node definition for valid relationships
40351 operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
40360 description: Response codes found in [response codes](https://wiki.onap.org/).
40362 - name: route-table-reference-id
40364 description: Route Table Reference id, UUID assigned to this instance.
40367 example: __ROUTE-TABLE-REFERENCE-ID__
40370 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkRouteTableReferencesRouteTableReference.json)
40373 $ref: "#/definitions/relationship"
40377 summary: delete an existing relationship
40378 description: delete an existing relationship
40379 operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
40388 description: Response codes found in [response codes](https://wiki.onap.org/).
40390 - name: route-table-reference-id
40392 description: Route Table Reference id, UUID assigned to this instance.
40395 example: __ROUTE-TABLE-REFERENCE-ID__
40396 /network/route-table-references/route-table-reference/{route-table-reference-id}:
40400 summary: returns route-table-reference
40401 description: returns route-table-reference
40402 operationId: getNetworkRouteTableReferencesRouteTableReference
40408 description: successful operation
40410 $ref: "#/getDefinitions/route-table-reference"
40412 description: Response codes found in [response codes](https://wiki.onap.org/).
40414 - name: route-table-reference-id
40416 description: Route Table Reference id, UUID assigned to this instance.
40419 example: __ROUTE-TABLE-REFERENCE-ID__
40423 summary: create or update an existing route-table-reference
40425 Create or update an existing route-table-reference.
40427 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40428 operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference
40437 description: Response codes found in [response codes](https://wiki.onap.org/).
40439 - name: route-table-reference-id
40441 description: Route Table Reference id, UUID assigned to this instance.
40444 example: __ROUTE-TABLE-REFERENCE-ID__
40447 description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkRouteTableReferencesRouteTableReference.json)
40450 $ref: "#/definitions/route-table-reference"
40454 summary: update an existing route-table-reference
40456 Update an existing route-table-reference
40458 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40459 The PUT operation will entirely replace an existing object.
40460 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40462 Other differences between PUT and PATCH are:
40464 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40465 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40466 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40467 operationId: UpdateNetworkRouteTableReferencesRouteTableReference
40476 description: Response codes found in [response codes](https://wiki.onap.org/).
40478 - name: route-table-reference-id
40480 description: Route Table Reference id, UUID assigned to this instance.
40483 example: __ROUTE-TABLE-REFERENCE-ID__
40486 description: route-table-reference object that needs to be updated.
40489 $ref: "#/patchDefinitions/route-table-reference"
40493 summary: delete an existing route-table-reference
40494 description: delete an existing route-table-reference
40495 operationId: deleteNetworkRouteTableReferencesRouteTableReference
40504 description: Response codes found in [response codes](https://wiki.onap.org/).
40506 - name: route-table-reference-id
40508 description: Route Table Reference id, UUID assigned to this instance.
40511 example: __ROUTE-TABLE-REFERENCE-ID__
40512 - name: resource-version
40514 description: resource-version for concurrency
40517 /network/route-table-references:
40521 summary: returns route-table-references
40522 description: returns route-table-references
40523 operationId: getNetworkRouteTableReferences
40529 description: successful operation
40531 $ref: "#/getDefinitions/route-table-references"
40533 description: Response codes found in [response codes](https://wiki.onap.org/).
40535 - name: route-table-reference-id
40540 - name: route-table-reference-fqdn
40545 /network/instance-groups/instance-group/{id}/relationship-list/relationship:
40549 summary: see node definition for valid relationships
40550 operationId: createOrUpdateNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
40559 description: Response codes found in [response codes](https://wiki.onap.org/).
40563 description: Instance Group ID, UUID assigned to this instance.
40569 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkInstanceGroupsInstanceGroup.json)
40572 $ref: "#/definitions/relationship"
40576 summary: delete an existing relationship
40577 description: delete an existing relationship
40578 operationId: deleteNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
40587 description: Response codes found in [response codes](https://wiki.onap.org/).
40591 description: Instance Group ID, UUID assigned to this instance.
40595 /network/instance-groups/instance-group/{id}:
40599 summary: returns instance-group
40600 description: returns instance-group
40601 operationId: getNetworkInstanceGroupsInstanceGroup
40607 description: successful operation
40609 $ref: "#/getDefinitions/instance-group"
40611 description: Response codes found in [response codes](https://wiki.onap.org/).
40615 description: Instance Group ID, UUID assigned to this instance.
40622 summary: create or update an existing instance-group
40624 Create or update an existing instance-group.
40626 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40627 operationId: createOrUpdateNetworkInstanceGroupsInstanceGroup
40636 description: Response codes found in [response codes](https://wiki.onap.org/).
40640 description: Instance Group ID, UUID assigned to this instance.
40646 description: instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkInstanceGroupsInstanceGroup.json)
40649 $ref: "#/definitions/instance-group"
40653 summary: update an existing instance-group
40655 Update an existing instance-group
40657 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40658 The PUT operation will entirely replace an existing object.
40659 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40661 Other differences between PUT and PATCH are:
40663 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40664 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40665 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40666 operationId: UpdateNetworkInstanceGroupsInstanceGroup
40675 description: Response codes found in [response codes](https://wiki.onap.org/).
40679 description: Instance Group ID, UUID assigned to this instance.
40685 description: instance-group object that needs to be updated.
40688 $ref: "#/patchDefinitions/instance-group"
40692 summary: delete an existing instance-group
40693 description: delete an existing instance-group
40694 operationId: deleteNetworkInstanceGroupsInstanceGroup
40703 description: Response codes found in [response codes](https://wiki.onap.org/).
40707 description: Instance Group ID, UUID assigned to this instance.
40711 - name: resource-version
40713 description: resource-version for concurrency
40716 /network/instance-groups:
40720 summary: returns instance-groups
40721 description: returns instance-groups
40722 operationId: getNetworkInstanceGroups
40728 description: successful operation
40730 $ref: "#/getDefinitions/instance-groups"
40732 description: Response codes found in [response codes](https://wiki.onap.org/).
40739 - name: description
40754 /network/zones/zone/{zone-id}/relationship-list/relationship:
40758 summary: see node definition for valid relationships
40759 operationId: createOrUpdateNetworkZonesZoneRelationshipListRelationship
40768 description: Response codes found in [response codes](https://wiki.onap.org/).
40772 description: Code assigned by AIC to the zone
40775 example: __ZONE-ID__
40778 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkZonesZone.json)
40781 $ref: "#/definitions/relationship"
40785 summary: delete an existing relationship
40786 description: delete an existing relationship
40787 operationId: deleteNetworkZonesZoneRelationshipListRelationship
40796 description: Response codes found in [response codes](https://wiki.onap.org/).
40800 description: Code assigned by AIC to the zone
40803 example: __ZONE-ID__
40804 /network/zones/zone/{zone-id}:
40808 summary: returns zone
40809 description: returns zone
40810 operationId: getNetworkZonesZone
40816 description: successful operation
40818 $ref: "#/getDefinitions/zone"
40820 description: Response codes found in [response codes](https://wiki.onap.org/).
40824 description: Code assigned by AIC to the zone
40827 example: __ZONE-ID__
40831 summary: create or update an existing zone
40833 Create or update an existing zone.
40835 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40836 operationId: createOrUpdateNetworkZonesZone
40845 description: Response codes found in [response codes](https://wiki.onap.org/).
40849 description: Code assigned by AIC to the zone
40852 example: __ZONE-ID__
40855 description: zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkZonesZone.json)
40858 $ref: "#/definitions/zone"
40862 summary: update an existing zone
40864 Update an existing zone
40866 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40867 The PUT operation will entirely replace an existing object.
40868 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40870 Other differences between PUT and PATCH are:
40872 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40873 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40874 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40875 operationId: UpdateNetworkZonesZone
40884 description: Response codes found in [response codes](https://wiki.onap.org/).
40888 description: Code assigned by AIC to the zone
40891 example: __ZONE-ID__
40894 description: zone object that needs to be updated.
40897 $ref: "#/patchDefinitions/zone"
40901 summary: delete an existing zone
40902 description: delete an existing zone
40903 operationId: deleteNetworkZonesZone
40912 description: Response codes found in [response codes](https://wiki.onap.org/).
40916 description: Code assigned by AIC to the zone
40919 example: __ZONE-ID__
40920 - name: resource-version
40922 description: resource-version for concurrency
40929 summary: returns zones
40930 description: returns zones
40931 operationId: getNetworkZones
40937 description: successful operation
40939 $ref: "#/getDefinitions/zones"
40941 description: Response codes found in [response codes](https://wiki.onap.org/).
40948 - name: design-type
40953 - name: zone-context
40966 $ref: "#/definitions/action-data"
40975 APIs that are more action related than REST (e.g., notify, update).
40979 $ref: "#/definitions/update"
40982 $ref: "#/definitions/notify"
40985 Represents a slice or partial piece of a resource that gets separately allotted
40986 ###### Related Nodes
40987 - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
40988 - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
40989 - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
40990 - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
40991 - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
40992 - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
40993 - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
40995 -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
40996 -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
41002 description: Allotted Resource id UUID assigned to this instance.
41005 description: The descriptive information assigned to this allotted resource instance
41008 description: Link back to more information in the controller
41011 description: the ASDC model id for this resource or service model.
41012 persona-model-version:
41014 description: the ASDC model version for this resource or service model.
41017 description: the ASDC model version for this resource or service model.
41018 persona-model-customization-id:
41020 description: captures the id of all the configuration used to customize the resource for the service.
41023 description: Concurrency value
41027 $ref: "#/definitions/tunnel-xconnect"
41031 $ref: "#/definitions/relationship"
41032 allotted-resources:
41034 This object is used to store slices of services being offered
41039 $ref: "#/definitions/allotted-resource"
41042 Availability zone, a collection of compute hosts/pservers
41043 ###### Related Nodes
41044 - TO complex( availability-zone LocatedIn complex, MANY2ONE)
41045 - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
41046 - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
41047 - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
41048 - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
41049 - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
41050 - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
41051 - FROM vce( vce Uses availability-zone, MANY2MANY)
41053 -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
41054 -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
41057 - availability-zone-name
41060 availability-zone-name:
41062 description: Name of the availability zone. Unique across a cloud region
41065 description: Type of hypervisor. Source of truth should define valid values.
41068 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
41071 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41075 $ref: "#/definitions/relationship"
41076 availability-zones:
41078 Collection of availability zones
41083 $ref: "#/definitions/availability-zone"
41084 az-and-dvs-switches:
41088 $ref: "#/definitions/dvs-switches"
41091 $ref: "#/definitions/availability-zone"
41094 Namespace for business related constructs
41099 $ref: "#/definitions/connector"
41103 $ref: "#/definitions/customer"
41106 ###### Related Nodes
41107 - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
41109 -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
41115 description: unique identifier of probe
41118 description: identifier of probe
41121 description: type of probe
41124 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41128 $ref: "#/definitions/relationship"
41129 classes-of-service:
41131 class-of-service of probe
41136 $ref: "#/definitions/class-of-service"
41137 cloud-infrastructure:
41139 Namespace for cloud infrastructure.
41144 $ref: "#/definitions/complex"
41148 $ref: "#/definitions/cloud-region"
41152 $ref: "#/definitions/network-profile"
41156 $ref: "#/definitions/pserver"
41157 virtual-data-centers:
41160 $ref: "#/definitions/virtual-data-center"
41163 cloud-region designates an installation of a cloud cluster or region or instantiation.
41164 ###### Related Nodes
41165 - TO complex( cloud-region LocatedIn complex, MANY2ONE)
41166 - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
41167 - TO zone( cloud-region LocatedIn zone, MANY2ONE)
41168 - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
41169 - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
41170 - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
41171 - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
41172 - FROM image( image BelongsTo cloud-region, MANY2ONE)
41173 - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
41174 - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
41175 - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
41176 - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
41177 - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
41178 - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
41180 -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
41181 -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
41189 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
41192 description: Identifier used by the vendor for the region. Second part of composite key
41195 description: Type of the cloud (e.g., openstack)
41196 owner-defined-type:
41198 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
41199 cloud-region-version:
41201 description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
41204 description: URL of the keystone identity service
41207 description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
41210 description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
41213 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41217 $ref: "#/definitions/volume-group"
41221 $ref: "#/definitions/tenant"
41225 $ref: "#/definitions/flavor"
41229 $ref: "#/definitions/group-assignment"
41233 $ref: "#/definitions/snapshot"
41237 $ref: "#/definitions/image"
41241 $ref: "#/definitions/dvs-switch"
41245 $ref: "#/definitions/oam-network"
41246 availability-zones:
41249 $ref: "#/definitions/availability-zone"
41253 $ref: "#/definitions/relationship"
41259 $ref: "#/definitions/cloud-region"
41262 Collection of physical locations that can house cloud-regions.
41263 ###### Related Nodes
41264 - TO l3-network( complex Uses l3-network, MANY2MANY)
41265 - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
41266 - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
41267 - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
41268 - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
41269 - FROM pnf( pnf LocatedIn complex, MANY2ONE)
41270 - FROM pserver( pserver LocatedIn complex, MANY2ONE)
41271 - FROM vce( vce LocatedIn complex, MANY2MANY)
41272 - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
41273 - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
41274 - FROM zone( zone LocatedIn complex, MANY2ONE)
41276 -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
41277 -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
41280 - physical-location-id
41281 - physical-location-type
41288 physical-location-id:
41290 description: Unique identifier for physical location, e.g., CLLI
41293 description: Data center code which can be an alternate way to identify a complex
41296 description: Gamma complex name for LCP instance.
41299 description: URL of the keystone identity service
41302 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41303 physical-location-type:
41305 description: Type, e.g., central office, data center.
41331 $ref: "#/definitions/ctag-pool"
41335 $ref: "#/definitions/relationship"
41338 Collection of physical locations that can house cloud-regions.
41343 $ref: "#/definitions/complex"
41346 Port Mirror Configuration.
41347 ###### Related Nodes
41348 - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
41349 - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
41350 - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
41351 - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
41352 - FROM service-instance( service-instance Uses configuration, ONE2MANY)
41354 -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
41355 -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
41356 -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
41359 - configuration-type
41360 - configuration-sub-type
41361 - orchestration-status
41362 - operational-status
41363 - configuration-selflink
41364 - model-customization-id
41368 description: UUID assigned to configuration.
41371 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
41372 configuration-name:
41374 description: Name of the configuration.
41375 configuration-type:
41377 description: port-mirroring-configuration.
41378 configuration-sub-type:
41380 description: vprobe, pprobe.
41381 model-invariant-id:
41383 description: the ASDC model id for this resource or service model.
41386 description: the ASDC model version for this resource or service model.
41387 orchestration-status:
41389 description: Orchestration status of the configuration.
41390 operational-status:
41392 description: Indicator for whether the resource is considered operational.
41393 configuration-selflink:
41395 description: URL to endpoint where AAI can get more details from SDN-GC.
41396 model-customization-id:
41398 description: id of the configuration used to customize the resource
41401 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41405 $ref: "#/definitions/relationship"
41409 $ref: "#/definitions/metadatum"
41412 Collection of configurations
41417 $ref: "#/definitions/configuration"
41420 Collection of resource instances used to connect a variety of disparate inventory widgets
41421 ###### Related Nodes
41422 - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
41423 - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
41424 - FROM service-instance( service-instance Uses connector, MANY2MANY)
41426 -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
41428 - resource-instance-id
41430 resource-instance-id:
41432 description: Unique id of resource instance.
41435 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41438 description: the ASDC model id for this resource or service model.
41439 persona-model-version:
41441 description: the ASDC model version for this resource or service model.
41444 description: the ASDC model version for this resource or service model.
41447 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41448 widget-model-version:
41450 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41454 $ref: "#/definitions/relationship"
41458 $ref: "#/definitions/metadatum"
41461 Collection of resource instances used to connect a variety of disparate inventory widgets
41466 $ref: "#/definitions/connector"
41467 constrained-element-set:
41469 This is how we would capture constraints defining allowed sets of elements.
41470 ###### Related Nodes
41471 - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
41472 - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
41473 - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
41475 -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
41476 -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
41478 - constrained-element-set-uuid
41482 constrained-element-set-uuid:
41490 element-choice-sets:
41493 $ref: "#/definitions/element-choice-set"
41497 $ref: "#/definitions/relationship"
41498 constrained-element-sets:
41500 constrained-element-set:
41503 $ref: "#/definitions/constrained-element-set"
41506 ###### Related Nodes
41507 - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
41508 - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
41510 -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
41520 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41524 $ref: "#/definitions/relationship"
41530 $ref: "#/definitions/ctag-assignment"
41533 A collection of C tags (vlan tags) grouped for a specific purpose.
41534 ###### Related Nodes
41535 - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
41536 - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
41537 - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
41539 -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
41542 - availability-zone-name
41543 - ctag-pool-purpose
41547 description: The Target provider edge router
41548 availability-zone-name:
41550 description: Name of the availability zone
41553 description: Describes what the intended purpose of this pool is.
41556 description: Comma separated list of ctags
41559 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41563 $ref: "#/definitions/relationship"
41569 $ref: "#/definitions/ctag-pool"
41572 customer identifiers to provide linkage back to BSS information.
41573 ###### Related Nodes
41574 - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
41576 -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
41578 - global-customer-id
41582 global-customer-id:
41584 description: Global customer id used across ECOMP to uniquely identify customer.
41587 description: Subscriber name, an alternate way to retrieve a customer.
41590 description: Subscriber type, a way to provide VID with only the INFRA customers.
41593 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41594 service-subscriptions:
41597 $ref: "#/definitions/service-subscription"
41601 $ref: "#/definitions/relationship"
41604 Collection of customer identifiers to provide linkage back to BSS information.
41609 $ref: "#/definitions/customer"
41617 description: See mis-na-virtualization-platform.yang
41620 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41624 $ref: "#/definitions/relationship"
41630 $ref: "#/definitions/cvlan-tag-entry"
41633 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.
41634 ###### Related Nodes
41635 - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
41636 - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
41644 description: DVS switch name
41647 description: URL used to reach the vcenter
41650 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41654 $ref: "#/definitions/relationship"
41657 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
41662 $ref: "#/definitions/dvs-switch"
41665 Internal map to define the properties of an edge and interpret the map EdgeRules
41683 edge-tag-query-request:
41694 $ref: "#/definitions/start-node-filter"
41695 include-node-filter:
41698 $ref: "#/definitions/include-node-filter"
41702 $ref: "#/definitions/secondary-filter"
41703 edge-tag-query-result:
41705 tagged-inventory-item-list:
41708 $ref: "#/definitions/tagged-inventory-item-list"
41709 element-choice-set:
41711 This is how we would capture constraints defining allowed sets of elements.
41712 ###### Related Nodes
41713 - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
41714 - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
41716 -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
41717 -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
41719 - element-choice-set-uuid
41720 - element-choice-set-name
41722 element-choice-set-uuid:
41724 element-choice-set-name:
41733 $ref: "#/definitions/model-element"
41737 $ref: "#/definitions/relationship"
41738 element-choice-sets:
41740 element-choice-set:
41743 $ref: "#/definitions/element-choice-set"
41746 Metadata for entitlement group.
41747 ###### Related Nodes
41748 - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
41749 - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
41751 -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
41758 description: Unique ID for the entitlement group the resource comes from, should be uuid.
41761 description: Unique ID of an entitlement resource.
41764 description: Concurrency value
41768 $ref: "#/definitions/relationship"
41771 Entitlements, keyed by group-uuid and resource-uuid, related to license management
41776 $ref: "#/definitions/entitlement"
41779 Persist EMS address information used by EMS driver.
41780 ###### Related Nodes
41781 - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
41783 -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
41789 description: Unique ID of EMS.
41792 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41793 esr-system-info-list:
41795 $ref: "#/definitions/esr-system-info-list"
41798 $ref: "#/definitions/relationship-list"
41804 $ref: "#/definitions/esr-ems"
41807 Persist common address information of external systems.
41808 ###### Related Nodes
41809 - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
41810 - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
41811 - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
41812 - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
41814 -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
41816 - esr-system-info-id
41821 esr-system-info-id:
41823 description: Unique ID of esr system info.
41826 description: name of external system.
41829 description: type of external systems.
41832 description: vendor of external systems.
41835 description: version of external systems.
41838 description: url used to access external systems.
41841 description: username used to access external systems.
41844 description: password used to access external systems.
41847 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
41850 description: protocol of third party SDNC, for example netconf/snmp.
41853 description: ca file content if enabled ssl on auth-url.
41856 description: Whether to verify VIM's certificate.
41859 description: service IP of ftp server.
41862 description: service port of ftp server.
41865 description: domain info for authentication.
41868 description: default tenant of VIM.
41871 description: ftp passive mode or not.
41874 description: resource or performance data file path.
41877 description: the status of external system.
41880 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41884 $ref: "#/definitions/relationship"
41885 esr-system-info-list:
41887 Collection of persistent block-level external system auth info.
41892 $ref: "#/definitions/esr-system-info"
41893 esr-thirdparty-sdnc:
41895 Persist SDNC address information used by ONAP SDNC.
41896 ###### Related Nodes
41897 - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
41898 - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
41900 -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
41902 - thirdparty-sdnc-id
41904 thirdparty-sdnc-id:
41906 description: Unique ID of SDNC.
41909 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
41912 description: password used to access SDNC server.
41915 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41916 esr-system-info-list:
41918 $ref: "#/definitions/esr-system-info-list"
41921 $ref: "#/definitions/relationship-list"
41922 esr-thirdparty-sdnc-list:
41924 esr-thirdparty-sdnc:
41927 $ref: "#/definitions/esr-thirdparty-sdnc"
41930 Persist VNFM address information used by VF-C.
41931 ###### Related Nodes
41932 - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
41934 -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
41940 description: Unique ID of VNFM.
41943 description: indecate the VIM to deploy VNF.
41946 description: certificate url of VNFM.
41949 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
41950 esr-system-info-list:
41952 $ref: "#/definitions/esr-system-info-list"
41955 $ref: "#/definitions/relationship-list"
41961 $ref: "#/definitions/esr-vnfm"
41964 evc object is an optional child object of the Configuration object.
41965 ###### Related Nodes
41966 - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
41968 -(4) IF this TO node is deleted, this EVC is DELETED also
41974 description: Unique/key field for the evc object
41975 forwarding-path-topology:
41977 description: Point-to-Point, Multi-Point
41980 description: Commited Information Rate
41983 description: CIR units
41984 connection-diversity-group-id:
41986 description: Diversity Group ID
41989 description: formerly Performance Group
41990 esp-evc-circuit-id:
41992 description: EVC Circuit ID of ESP EVC
41995 description: Committed Information Rate (For ESP)
41998 description: CIR units (For ESP)
42001 description: Identifies ESP
42002 collector-pop-clli:
42004 description: Collector POP CLLI (from the hostname of the access pnf)
42005 inter-connect-type-ingress:
42007 description: Interconnect type on ingress side of EVC.
42008 tagmode-access-ingress:
42010 description: tagode for collector side of EVC
42011 tagmode-access-egress:
42013 description: tagMode for network side of EVC
42017 $ref: "#/definitions/relationship"
42020 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42026 $ref: "#/definitions/evc"
42029 Namespace for external system.
42033 $ref: "#/definitions/esr-ems-list"
42036 $ref: "#/definitions/esr-vnfm-list"
42037 esr-thirdparty-sdnc-list:
42039 $ref: "#/definitions/esr-thirdparty-sdnc-list"
42042 Extra properties for inventory item for response list
42050 ###### Related Nodes
42051 - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
42052 - FROM vserver( vserver Uses flavor, MANY2ONE)
42054 -FLAVOR cannot be deleted if related to VSERVER
42063 description: Flavor id, expected to be unique across cloud-region.
42066 description: Flavor name
42070 description: Number of CPUs
42074 description: Amount of memory
42078 description: Disk space
42082 description: Amount of ephemeral disk space
42085 description: amount of swap space allocation
42088 description: whether flavor is available to all users or private to the tenant it was created in.
42091 description: URL to endpoint where AAI can get more details
42094 description: Boolean as to whether this flavor is no longer enabled
42097 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42101 $ref: "#/definitions/relationship"
42104 Collection of openstack flavors.
42109 $ref: "#/definitions/flavor"
42112 Entity describing a sequenced segment of forwarding path
42113 ###### Related Nodes
42114 - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
42115 - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
42116 - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
42117 - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
42118 - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
42120 -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
42121 -(4) IF this TO node is deleted, this FORWARDER is DELETED also
42128 description: Unique ID of this segmentation
42131 description: ingress, intermediate, egress
42135 $ref: "#/definitions/relationship"
42138 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42141 forwarder object is an optional child object of the Configuration object.
42142 ###### Related Nodes
42143 - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
42145 -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
42151 description: Key for forwarder-evc object
42154 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
42157 description: Internal VLAN.
42160 description: SVLAN value for ingress of egress forwarder.
42163 description: CVLAN value for ingress of egress forwarder.
42167 $ref: "#/definitions/relationship"
42170 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42176 $ref: "#/definitions/forwarder-evc"
42182 $ref: "#/definitions/forwarder"
42185 Entity that describes the sequenced forwarding path between interfaces of services or resources
42186 ###### Related Nodes
42187 - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
42188 - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
42189 - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
42191 -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
42192 -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
42193 -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
42195 - forwarding-path-id
42196 - forwarding-path-name
42198 forwarding-path-id:
42200 description: Unique ID of this FP
42201 forwarding-path-name:
42203 description: Name of the FP
42207 $ref: "#/definitions/relationship"
42210 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42213 description: the self link for this FP
42217 $ref: "#/definitions/forwarder"
42223 $ref: "#/definitions/forwarding-path"
42226 General purpose VNF
42227 ###### Related Nodes
42228 - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
42229 - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
42230 - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
42231 - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
42232 - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
42233 - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
42234 - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
42235 - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
42236 - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
42237 - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
42238 - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
42239 - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
42240 - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
42241 - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
42242 - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
42243 - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
42244 - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
42245 - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
42246 - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
42247 - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
42248 - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
42250 -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
42256 - is-closed-loop-disabled
42260 description: Unique id of VNF. This is unique across the graph.
42263 description: Name of VNF.
42266 description: Alternate name of VNF.
42269 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.
42272 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
42273 regional-resource-zone:
42275 description: Regional way of organizing pservers, source of truth should define values
42278 description: Trigger for operational monitoring of this resource by Service Assurance systems.
42281 description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
42284 description: OBSOLETE - do not use
42287 description: Client should send valid enumerated value
42288 orchestration-status:
42290 description: Orchestration status of this VNF, used by MSO.
42293 description: Heat stack id corresponding to this instance, managed by MSO
42296 description: Corresponds to the SDN-C catalog id used to configure this VCE
42299 description: identifier of managed by company or customer
42302 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
42303 ipv4-loopback0-address:
42305 description: v4 Loopback0 address
42308 description: v6 Loopback address
42309 management-v6-address:
42311 description: v6 management address
42315 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
42318 description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only in some usecases
42322 description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
42325 description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only in some usecases
42329 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
42332 description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases
42335 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.
42336 is-closed-loop-disabled:
42338 description: used to indicate whether closed loop function is enabled on this node
42341 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42344 description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
42345 encrypted-access-flag:
42347 description: indicates whether generic-vnf access uses SSH
42350 description: the ASDC model id for this resource or service model.
42351 persona-model-version:
42353 description: the ASDC model version for this resource or service model.
42356 description: the ASDC model version for this resource or service model.
42357 persona-model-customization-id:
42359 description: captures the id of all the configuration used to customize the resource for the service.
42362 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
42363 widget-model-version:
42365 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
42368 description: as-number of the VNF
42369 regional-resource-subzone:
42371 description: represents sub zone of the rr plane
42374 description: Path to the controller object.
42378 $ref: "#/definitions/relationship"
42382 $ref: "#/definitions/l-interface"
42386 $ref: "#/definitions/lag-interface"
42390 $ref: "#/definitions/vf-module"
42394 $ref: "#/definitions/license"
42398 $ref: "#/definitions/entitlement"
42406 $ref: "#/definitions/generic-vnf"
42409 Openstack group-assignment used to store exclusivity groups (EG).
42410 ###### Related Nodes
42411 - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
42412 - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
42413 - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
42422 description: Group id, expected to be unique across cloud-region.
42425 description: Group type - the type of group this instance refers to
42428 description: Group name - name assigned to the group
42431 description: Group description - description of the group
42434 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42438 $ref: "#/definitions/relationship"
42441 Collection of openstack group assignments
42446 $ref: "#/definitions/group-assignment"
42449 ###### Related Nodes
42450 - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
42452 -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
42460 description: host-route id
42463 description: subnet prefix
42466 description: Could be ip-address, hostname, or service-instance
42469 description: Should be ip-address, hostname, or service-instance to match next-hop
42472 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42476 $ref: "#/definitions/relationship"
42482 $ref: "#/definitions/host-route"
42485 Collection of HPA Capabilities
42490 $ref: "#/definitions/hpa-capability"
42493 Represents a HPA capability
42494 ###### Related Nodes
42495 - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
42496 - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
42497 - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
42499 -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
42501 - hpa-capability-id
42506 description: UUID to uniquely identify a HPA capability
42509 description: Name of the HPACapability
42512 description: HPA schema version
42515 description: Hardware architecture
42518 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42522 $ref: "#/definitions/relationship"
42523 hpa-feature-attributes:
42526 $ref: "#/definitions/hpa-feature-attributes"
42527 hpa-feature-attributes:
42529 HPA Capability Feature attributes
42530 ###### Related Nodes
42531 - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
42533 -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
42535 - hpa-attribute-key
42539 description: name of the specific HPA attribute
42540 hpa-attribute-value:
42542 description: JSON string specifying the value, unit and type of the specific HPA attribute
42545 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42549 $ref: "#/definitions/relationship"
42553 ###### Related Nodes
42554 - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
42555 - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
42556 - FROM vserver( vserver Uses image, MANY2ONE)
42558 -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
42559 -IMAGE cannot be deleted if related to VSERVER
42570 description: Image id, expected to be unique across cloud region
42573 description: Image name
42574 image-architecture:
42576 description: Operating system architecture.
42579 description: The common name of the operating system distribution in lowercase
42582 description: The operating system version as specified by the distributor.
42585 description: The application that the image instantiates.
42586 application-vendor:
42588 description: The vendor of the application.
42589 application-version:
42591 description: The version of the application.
42594 description: URL to endpoint where AAI can get more details
42597 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42601 $ref: "#/definitions/relationship"
42605 $ref: "#/definitions/metadatum"
42608 Collectio of Openstack images.
42613 $ref: "#/definitions/image"
42614 include-node-filter:
42620 InstanceFilter for performing a named-query or model query
42623 InstanceFilters for performing a named-query or model query
42628 $ref: "#/definitions/instance-filter"
42631 General mechanism for grouping instances
42632 ###### Related Nodes
42633 - TO model( instance-group Targets model, MANY2MANY)
42634 - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
42635 - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
42636 - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
42637 - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
42646 description: Instance Group ID, UUID assigned to this instance.
42649 description: Descriptive text to help identify the usage of this instance-group
42652 description: Only valid value today is lower case ha for high availability
42655 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
42658 description: Concurrency value
42662 $ref: "#/definitions/relationship"
42665 Collection of openstack route table references
42670 $ref: "#/definitions/instance-group"
42675 $ref: "#/definitions/search"
42678 $ref: "#/definitions/actions"
42679 cloud-infrastructure:
42681 $ref: "#/definitions/cloud-infrastructure"
42684 $ref: "#/definitions/business"
42685 service-design-and-creation:
42687 $ref: "#/definitions/service-design-and-creation"
42690 $ref: "#/definitions/network"
42693 $ref: "#/definitions/nodes"
42696 inventory-item-type:
42698 inventory-item-link:
42700 inventory-item-data:
42703 $ref: "#/definitions/inventory-item-data"
42704 tagged-inventory-item-list:
42707 $ref: "#/definitions/tagged-inventory-item-list"
42708 inventory-item-data:
42714 inventory-response-item:
42716 Inventory item for response list
42722 $ref: "#/definitions/extra-properties"
42723 inventory-response-items:
42725 $ref: "#/definitions/inventory-response-items"
42726 inventory-response-items:
42728 Container for inventory items in response list
42730 inventory-response-item:
42733 $ref: "#/definitions/inventory-response-item"
42734 ipsec-configuration:
42736 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
42737 ###### Related Nodes
42738 - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
42739 - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
42741 -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
42743 - ipsec-configuration-id
42745 ipsec-configuration-id:
42747 description: UUID of this configuration
42748 requested-vig-address-type:
42750 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
42751 requested-encryption-strength:
42753 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
42754 requested-dmz-type:
42756 description: can offer a shared DMZ or a DMZ specific to a customer
42757 shared-dmz-network-address:
42759 description: Network address of shared DMZ
42760 requested-customer-name:
42762 description: If the DMZ is a custom DMZ, this field will indicate the customer information
42765 description: can be 1 or 2
42766 ikev1-authentication:
42768 description: Contains values like md5, sha1, sha256, sha384
42771 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
42774 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
42777 description: Group name defined in VIG for clients using aggressive mode
42780 description: pre-shared key for the above group name
42783 description: Lifetime for IKEv1 SA
42784 ipsec-authentication:
42786 description: md5, sha1, sha256, sha384
42789 description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
42792 description: Life time for IPSec SA
42795 description: enable PFS or not
42798 description: user ID for xAuth, sm-user, ,nmteHostName
42799 xauth-user-password:
42801 description: Encrypted using the Juniper $9$ algorithm
42804 description: The time between DPD probe
42807 description: Maximum number of DPD before claiming the tunnel is down
42810 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42814 $ref: "#/definitions/relationship"
42818 $ref: "#/definitions/vig-server"
42819 ipsec-configurations:
42821 ipsec-configuration:
42824 $ref: "#/definitions/ipsec-configuration"
42833 Logical interfaces, e.g., a vnic.
42834 ###### Related Nodes
42835 - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
42836 - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
42837 - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
42838 - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
42839 - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
42840 - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
42841 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
42842 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
42843 - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
42844 - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
42846 -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
42847 -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
42848 -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
42854 description: Name given to the interface
42857 description: E.g., CUSTOMER, UPLINK, etc.
42860 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
42863 description: URL to endpoint where AAI can get more details
42866 description: ID of interface
42869 description: MAC address for the interface
42872 description: Name of the network
42875 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
42876 interface-description:
42878 description: Human friendly text regarding this interface.
42881 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42885 $ref: "#/definitions/vlan"
42889 $ref: "#/definitions/sriov-vf"
42893 $ref: "#/definitions/relationship"
42894 l3-interface-ipv4-address-list:
42897 $ref: "#/definitions/l3-interface-ipv4-address-list"
42898 l3-interface-ipv6-address-list:
42901 $ref: "#/definitions/l3-interface-ipv6-address-list"
42904 Collection of logical interfaces.
42909 $ref: "#/definitions/l-interface"
42910 l3-interface-ipv4-address-list:
42913 ###### Related Nodes
42914 - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
42915 - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
42916 - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
42917 - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
42919 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
42921 - l3-interface-ipv4-address
42923 l3-interface-ipv4-address:
42925 description: IP address
42926 l3-interface-ipv4-prefix-length:
42929 description: Prefix length, 32 for single address
42933 description: Inner VLAN tag
42937 description: Outer VLAN tag
42940 description: Indicator of fixed or floating address
42943 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42944 neutron-network-id:
42946 description: Neutron network id of the interface that address belongs to
42949 description: Neutron id of subnet that address belongs to
42953 $ref: "#/definitions/relationship"
42954 l3-interface-ipv6-address-list:
42957 ###### Related Nodes
42958 - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
42959 - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
42960 - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
42961 - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
42963 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
42965 - l3-interface-ipv6-address
42967 l3-interface-ipv6-address:
42969 description: IP address
42970 l3-interface-ipv6-prefix-length:
42973 description: Prefix length, 128 for single address
42977 description: Inner VLAN tag
42981 description: Outer VLAN tag
42984 description: Indicator of fixed or floating address
42987 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
42988 neutron-network-id:
42990 description: Neutron network id of the interface that address belongs to
42993 description: Neutron id of subnet that address belongs to
42997 $ref: "#/definitions/relationship"
43000 Generic network definition
43001 ###### Related Nodes
43002 - TO network-policy( l3-network Uses network-policy, MANY2MANY)
43003 - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
43004 - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
43005 - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
43006 - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
43007 - FROM complex( complex Uses l3-network, MANY2MANY)
43008 - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
43009 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
43010 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
43011 - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
43012 - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
43013 - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
43014 - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
43015 - FROM tenant( tenant Uses l3-network, MANY2MANY)
43016 - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
43018 -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
43023 - is-provider-network
43024 - is-shared-network
43025 - is-external-network
43029 description: Network ID, should be uuid. Unique across A&AI.
43032 description: Name of the network, governed by some naming convention..
43035 description: Type of the network - who defines these values?
43038 description: Role the network plans - who defines these values?
43039 network-technology:
43041 description: Network technology - who defines these values?
43042 neutron-network-id:
43044 description: Neutron network id of this Interface
43047 description: Set to true if bound to VPN
43050 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
43051 network-role-instance:
43054 description: network role instance
43057 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43058 orchestration-status:
43060 description: Orchestration status of this VNF, mastered by MSO
43063 description: Heat stack id corresponding to this instance, managed by MSO
43066 description: Corresponds to the SDN-C catalog id used to configure this VCE
43067 contrail-network-fqdn:
43069 description: Contrail FQDN for the network
43072 description: the ASDC model id for this resource or service model.
43073 persona-model-version:
43075 description: the ASDC model version for this resource or service model.
43078 description: the ASDC model version for this resource or service model.
43079 persona-model-customization-id:
43081 description: captures the id of all the configuration used to customize the resource for the service.
43084 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
43085 widget-model-version:
43087 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
43088 physical-network-name:
43090 description: Name associated with the physical network.
43091 is-provider-network:
43093 description: boolean indicatating whether or not network is a provider network.
43096 description: boolean indicatating whether or not network is a shared network.
43097 is-external-network:
43099 description: boolean indicatating whether or not network is an external network.
43102 description: Path to the controller object.
43106 $ref: "#/definitions/subnet"
43110 $ref: "#/definitions/ctag-assignment"
43111 segmentation-assignments:
43114 $ref: "#/definitions/segmentation-assignment"
43118 $ref: "#/definitions/relationship"
43119 description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
43125 $ref: "#/definitions/l3-network"
43128 Link aggregate interface
43129 ###### Related Nodes
43130 - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
43131 - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
43132 - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
43133 - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
43134 - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
43135 - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
43136 - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
43138 -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
43139 -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
43140 -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
43146 description: Name that identifies the link aggregate interface
43147 interface-description:
43149 description: Human friendly text regarding this interface.
43152 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43155 description: Captures the numeric part of the speed
43158 description: Captures the units corresponding to the speed
43161 description: ID of interface
43164 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
43167 description: Trigger for operational monitoring of this resource by Service Assurance systems.
43171 $ref: "#/definitions/relationship"
43175 $ref: "#/definitions/l-interface"
43178 Collection of link aggregate interfaces.
43183 $ref: "#/definitions/lag-interface"
43186 LAG links can connect lag-interfaces
43187 ###### Related Nodes
43188 - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
43189 - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
43191 -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
43197 description: Alphabetical concatenation of lag-interface names
43200 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43204 $ref: "#/definitions/relationship"
43207 Collection of link aggregation connections
43212 $ref: "#/definitions/lag-link"
43215 Metadata for license group.
43216 ###### Related Nodes
43217 - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
43218 - TO vce( license BelongsTo vce, MANY2ONE)(4)
43220 -(4) IF this TO node is deleted, this LICENSE is DELETED also
43227 description: Unique ID for the license group the resource belongs to, should be uuid.
43230 description: Unique ID of a license resource.
43233 description: Concurrency value
43237 $ref: "#/definitions/relationship"
43240 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
43245 $ref: "#/definitions/license"
43248 describes a line-of-business
43249 ###### Related Nodes
43250 - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
43253 - line-of-business-name
43255 line-of-business-name:
43257 description: Name of the line-of-business (product)
43260 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43264 $ref: "#/definitions/relationship"
43267 Collection of lines-of-business
43272 $ref: "#/definitions/line-of-business"
43275 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
43276 ###### Related Nodes
43277 - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
43278 - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
43279 - TO lag-link( logical-link Uses lag-link, MANY2MANY)
43280 - TO logical-link( logical-link Uses logical-link, ONE2MANY)
43281 - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
43282 - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
43283 - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
43284 - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
43285 - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
43286 - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
43287 - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
43288 - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
43289 - FROM logical-link( logical-link Uses logical-link, ONE2MANY)
43291 -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
43298 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
43301 description: Type of logical link, e.g., evc
43304 description: Captures the numeric part of the speed
43307 description: Captures the units corresponding to the speed
43310 description: v4, v6, or ds for dual stack
43313 description: For example, static or BGP
43316 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43319 description: the ASDC model id for this resource or service model.
43320 persona-model-version:
43322 description: the ASDC model version for this resource or service model.
43325 description: the ASDC model version for this resource or service model.
43328 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
43329 widget-model-version:
43331 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
43332 operational-status:
43334 description: Indication of operational status of the logical link.
43337 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
43340 description: Indication of the network use of the logical link.
43343 description: Alias or alternate name (CLCI or D1 name).
43346 description: UUID of the logical-link, SDNC generates this.
43349 description: Circuit id
43352 description: Reason for this entity, role it is playing
43356 $ref: "#/definitions/relationship"
43359 Collection of logical connections
43364 $ref: "#/definitions/logical-link"
43367 Collection of metadatum (key/value pairs)
43372 $ref: "#/definitions/metadatum"
43376 ###### Related Nodes
43377 - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
43378 - TO image( metadatum BelongsTo image, MANY2ONE)(4)
43379 - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
43380 - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
43382 -(4) IF this TO node is deleted, this METADATUM is DELETED also
43393 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43396 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
43397 ###### Related Nodes
43398 - TO model( model-ver BelongsTo model, MANY2ONE)(1)
43399 - FROM instance-group( instance-group Targets model, MANY2MANY)
43400 - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
43401 - FROM named-query( named-query AppliesTo model, ONE2MANY)
43402 - FROM named-query-element( named-query-element IsA model, MANY2ONE)
43404 -(1) IF this MODEL node is deleted, this FROM node is DELETED also
43405 -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
43408 - model-invariant-id
43411 model-invariant-id:
43413 description: Unique identifier corresponding to the main definition of a model in ASDC
43416 description: Type of the model, e.g., service, resource, widget, etc.
43419 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43423 $ref: "#/definitions/model-ver"
43427 $ref: "#/definitions/relationship"
43428 model-and-named-query-search:
43430 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
43434 $ref: "#/definitions/query-parameters"
43437 $ref: "#/definitions/instance-filters"
43440 $ref: "#/definitions/secondary-filts"
43443 secondary-filter-cut-point:
43447 This is how we would capture constraints defining allowed sets of elements.
43448 ###### Related Nodes
43449 - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
43450 - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
43452 -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
43453 -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
43455 - model-constraint-uuid
43456 - constrained-element-set-uuid-to-replace
43458 model-constraint-uuid:
43460 constrained-element-set-uuid-to-replace:
43462 constrained-element-sets:
43465 $ref: "#/definitions/constrained-element-set"
43468 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43474 $ref: "#/definitions/model-constraint"
43477 Defines how other models combine to make up a higher-level model.
43478 ###### Related Nodes
43479 - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
43480 - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
43481 - TO model-ver( model-element IsA model-ver, MANY2ONE)
43482 - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
43483 - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
43484 - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
43485 - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
43487 -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
43488 -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
43490 - model-element-uuid
43491 - new-data-del-flag
43494 model-element-uuid:
43498 description: Indicates whether this element was created as part of instantiation from this model
43501 description: How many of this type of element are required/allowed
43506 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43510 $ref: "#/definitions/model-element"
43511 description: Defines how other models combine to make up a higher-level model
43515 $ref: "#/definitions/model-constraint"
43516 description: Describes new constraints on this model element that are not part of that model's definition
43520 $ref: "#/definitions/relationship"
43526 $ref: "#/definitions/model-element"
43529 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
43530 ###### Related Nodes
43531 - TO model( model-ver BelongsTo model, MANY2ONE)(4)
43532 - FROM model-element( model-element IsA model-ver, MANY2ONE)
43533 - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
43534 - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
43536 -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
43537 -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
43538 -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
43547 description: Unique identifier corresponding to one version of a model in ASDC
43550 description: Name of the model, which can change from version to version.
43553 description: Version
43556 description: Description
43559 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43563 $ref: "#/definitions/model-element"
43567 $ref: "#/definitions/metadatum"
43571 $ref: "#/definitions/relationship"
43577 $ref: "#/definitions/model-ver"
43580 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
43585 $ref: "#/definitions/model"
43586 multicast-configuration:
43588 ###### Related Nodes
43589 - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
43592 - multicast-configuration-id
43593 - multicast-protocol
43596 multicast-configuration-id:
43598 description: Unique id of multicast configuration.
43599 multicast-protocol:
43601 description: protocol of multicast configuration
43604 description: rp type of multicast configuration
43607 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43611 $ref: "#/definitions/relationship"
43612 multicast-configurations:
43614 multicast configuration of generic-vnf ip-address
43616 multicast-configuration:
43619 $ref: "#/definitions/multicast-configuration"
43625 $ref: "#/definitions/named-query"
43629 ###### Related Nodes
43630 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
43631 - TO model( named-query AppliesTo model, ONE2MANY)
43632 - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
43634 -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
43638 - named-query-version
43644 named-query-version:
43646 required-input-param:
43652 named-query-elements:
43655 $ref: "#/definitions/named-query-element"
43659 $ref: "#/definitions/relationship"
43660 named-query-element:
43663 ###### Related Nodes
43664 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
43665 - TO model( named-query-element IsA model, MANY2ONE)
43666 - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
43667 - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
43668 - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
43669 - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
43671 -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
43672 -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
43674 - named-query-element-uuid
43676 named-query-element-uuid:
43678 property-collect-list:
43682 property-limit-desc:
43686 named-query-elements:
43689 $ref: "#/definitions/named-query-element"
43693 $ref: "#/definitions/related-lookup"
43694 property-constraints:
43697 $ref: "#/definitions/property-constraint"
43701 $ref: "#/definitions/relationship"
43702 named-query-elements:
43704 named-query-element:
43707 $ref: "#/definitions/named-query-element"
43710 Namespace for network inventory resources.
43715 $ref: "#/definitions/logical-link"
43719 $ref: "#/definitions/site-pair-set"
43723 $ref: "#/definitions/vpn-binding"
43727 $ref: "#/definitions/vpls-pe"
43728 multicast-configurations:
43731 $ref: "#/definitions/multicast-configuration"
43735 $ref: "#/definitions/vce"
43739 $ref: "#/definitions/vnfc"
43743 $ref: "#/definitions/l3-network"
43747 $ref: "#/definitions/network-policy"
43751 $ref: "#/definitions/generic-vnf"
43755 $ref: "#/definitions/lag-link"
43759 $ref: "#/definitions/newvce"
43763 $ref: "#/definitions/pnf"
43767 $ref: "#/definitions/physical-link"
43768 ipsec-configurations:
43771 $ref: "#/definitions/ipsec-configuration"
43772 route-table-references:
43775 $ref: "#/definitions/route-table-reference"
43779 $ref: "#/definitions/instance-group"
43783 $ref: "#/definitions/zone"
43789 $ref: "#/definitions/network-policy"
43792 ###### Related Nodes
43793 - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
43796 - network-policy-id
43800 description: UUID representing unique key to this instance
43801 network-policy-fqdn:
43803 description: Contrail FQDN for the policy
43806 description: ID for the openStack Heat instance
43809 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43813 $ref: "#/definitions/relationship"
43816 Network profile populated by SDN-GP for SNMP
43817 ###### Related Nodes
43818 - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
43825 description: Unique name of network profile.
43828 description: Encrypted SNMP community string
43831 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43835 $ref: "#/definitions/relationship"
43838 Collection of network profiles
43843 $ref: "#/definitions/network-profile"
43846 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
43847 ###### Related Nodes
43848 - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
43850 -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
43858 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43861 description: Name of VNF.
43864 description: Alternate name of VNF.
43867 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.
43870 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
43873 description: Indicator for whether the resource is considered operational
43876 description: OBSOLETE - do not use
43879 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
43882 description: Client should send valid enumerated value.
43885 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43886 ipv4-loopback0-address:
43888 description: v4 Loopback0 address
43889 orchestration-status:
43891 description: Orchestration status of this VNF, mastered by MSO.
43894 description: Heat stack id corresponding to this instance, managed by MSO
43897 description: Corresponds to the SDN-C catalog id used to configure this VCE
43901 $ref: "#/definitions/relationship"
43905 $ref: "#/definitions/l-interface"
43908 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
43913 $ref: "#/definitions/newvce"
43916 inventory-item-data:
43919 $ref: "#/definitions/inventory-item-data"
43920 notification-event:
43924 notification-event-header:
43926 $ref: "#/definitions/notification-event-header"
43927 notification-event-header:
43968 $ref: "#/definitions/key-data"
43973 OAM network, to be deprecated shortly. Do not use for new purposes.
43974 ###### Related Nodes
43975 - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
43976 - TO complex( oam-network AppliesTo complex, MANY2MANY)
43977 - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
43986 description: UUID of the network. Unique across a cloud-region
43989 description: Name of the network.
43993 description: cvlan-id
43994 ipv4-oam-gateway-address:
43996 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
43997 ipv4-oam-gateway-address-prefix-length:
44000 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
44003 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44007 $ref: "#/definitions/relationship"
44010 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
44015 $ref: "#/definitions/oam-network"
44016 operational-environment:
44018 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
44019 ###### Related Nodes
44020 - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
44021 - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
44024 - operational-environment-id
44025 - operational-environment-name
44026 - operational-environment-type
44027 - operational-environment-status
44031 operational-environment-id:
44033 description: UUID of an operational environment
44034 operational-environment-name:
44036 description: Operational Environment name
44037 operational-environment-type:
44039 description: Operational Environment Type.
44040 operational-environment-status:
44042 description: Status
44045 description: Tenant Context.
44048 description: Workload Context.
44051 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44055 $ref: "#/definitions/relationship"
44056 operational-environments:
44058 a logical partition of the cloud which allows to have multiple environments in the production AIC.
44060 operational-environment:
44063 $ref: "#/definitions/operational-environment"
44066 Allows for legacy POST of old-style and new-style models
44068 - model-invariant-id
44069 - model-name-version-id
44075 model-invariant-id:
44077 description: Unique identifier corresponding to the main definition of a model in ASDC
44078 model-name-version-id:
44080 description: Unique identifier corresponding to one version of a model in ASDC
44083 description: Type of the model, e.g., service, resource, widget, etc.
44086 description: Name of the model, which can change from version to version.
44089 description: Invariant unique ID which does not change from version to version
44092 description: Version
44095 description: Description
44098 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44101 $ref: "#/definitions/model-vers"
44104 $ref: "#/definitions/relationship-list"
44107 Collection of owning-entities
44112 $ref: "#/definitions/owning-entity"
44115 describes an owning-entity
44116 ###### Related Nodes
44117 - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
44121 - owning-entity-name
44125 description: UUID of an owning entity
44126 owning-entity-name:
44128 description: Owning entity name
44131 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44135 $ref: "#/definitions/relationship"
44138 Physical interface (e.g., nic)
44139 ###### Related Nodes
44140 - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
44141 - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
44142 - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
44143 - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
44144 - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
44145 - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
44146 - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
44148 -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
44149 -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
44150 -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
44156 description: Name that identifies the physical interface
44159 description: Captures the numeric part of the speed
44162 description: Captures the units corresponding to the speed
44165 description: Nature of the services and connectivity on this port.
44166 equipment-identifier:
44168 description: CLEI or other specification for p-interface hardware.
44171 description: Role specification for p-interface hardware.
44174 description: Indicates the physical properties of the interface.
44177 description: Trigger for operational monitoring of this resource by Service Assurance systems.
44180 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44184 $ref: "#/definitions/relationship"
44188 $ref: "#/definitions/l-interface"
44191 Collection of physical interfaces.
44196 $ref: "#/definitions/p-interface"
44199 Collection of physical connections, typically between p-interfaces
44200 ###### Related Nodes
44201 - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
44203 -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
44209 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
44212 description: Captures the numeric part of the speed
44215 description: Captures the units corresponding to the speed
44218 description: Circuit it
44221 description: Dual access mode (e.g., primary, secondary
44224 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
44225 service-provider-name:
44227 description: Name of the service Provider on this link.
44230 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44234 $ref: "#/definitions/relationship"
44237 Collection of physical connections, typically between p-interfaces
44242 $ref: "#/definitions/physical-link"
44245 describes a platform
44246 ###### Related Nodes
44247 - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
44254 description: Name of the platform
44257 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44261 $ref: "#/definitions/relationship"
44264 Collection of platforms
44269 $ref: "#/definitions/platform"
44272 PNF represents a physical network function. typically equipment used in the D1 world.
44273 ###### Related Nodes
44274 - TO complex( pnf LocatedIn complex, MANY2ONE)
44275 - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
44276 - TO zone( pnf LocatedIn zone, MANY2ONE)
44277 - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
44278 - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
44279 - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
44280 - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
44282 -(1) IF this PNF node is deleted, this FROM node is DELETED also
44289 description: unique name of Physical Network Function.
44292 description: name of Physical Network Function.
44295 description: source of name2
44298 description: id of pnf
44301 description: Equipment type. Source of truth should define valid values.
44304 description: Equipment vendor. Source of truth should define valid values.
44307 description: Equipment model. Source of truth should define valid values.
44310 description: identifier of managed by company or customer
44313 description: ipv4-oam-address with new naming convention for IP addresses
44316 description: sw-version is the version of SW for the hosted application on the PNF.
44319 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.
44322 description: ID of the physical frame (relay rack) where pnf is installed.
44325 description: Serial number of the device
44326 ipaddress-v4-loopback-0:
44328 description: IPV4 Loopback 0 address
44329 ipaddress-v6-loopback-0:
44331 description: IPV6 Loopback 0 address
44334 description: IPV4 AIM address
44337 description: IPV6 AIM address
44340 description: IPV6 OAM address
44343 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
44346 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44349 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
44352 description: Nf Role is the role performed by this instance in the network.
44356 $ref: "#/definitions/relationship"
44360 $ref: "#/definitions/p-interface"
44364 $ref: "#/definitions/lag-interface"
44367 Collection of Physical Network Functions.
44372 $ref: "#/definitions/pnf"
44375 Used to capture the network interfaces of this VCE
44376 ###### Related Nodes
44377 - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
44378 - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
44380 -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
44381 -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
44384 - orchestration-status
44388 description: Unique ID of the interface
44389 neutron-network-id:
44391 description: Neutron network id of this Interface
44392 neutron-network-name:
44394 description: Neutron network name of this Interface
44397 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
44400 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44403 description: Unique ID for port group in vmware
44406 description: Likely to duplicate value of neutron network name
44409 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
44410 orchestration-status:
44412 description: Orchestration status of this VNF, mastered by MSO
44415 description: Heat stack id corresponding to this instance, managed by MSO
44418 description: Corresponds to the SDN-C catalog id used to configure this VCE
44422 $ref: "#/definitions/cvlan-tag-entry"
44426 $ref: "#/definitions/relationship"
44432 $ref: "#/definitions/port-group"
44435 describes the project
44436 ###### Related Nodes
44437 - TO service-instance( project Uses service-instance, ONE2MANY)
44444 description: Name of the project deploying a service
44447 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44451 $ref: "#/definitions/relationship"
44454 Collection of projects
44459 $ref: "#/definitions/project"
44462 Property holder for query properties or instance properties
44468 property-constraint:
44471 ###### Related Nodes
44472 - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
44474 -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
44476 - property-constraint-uuid
44481 property-constraint-uuid:
44491 property-constraints:
44493 property-constraint:
44496 $ref: "#/definitions/property-constraint"
44499 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
44500 ###### Related Nodes
44501 - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
44502 - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
44503 - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
44504 - TO complex( pserver LocatedIn complex, MANY2ONE)
44505 - TO zone( pserver LocatedIn zone, MANY2ONE)
44506 - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
44507 - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
44508 - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
44509 - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
44510 - FROM vserver( vserver HostedOn pserver, MANY2ONE)
44512 -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
44513 -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
44521 description: Value from executing hostname on the compute node.
44524 description: PTNII name
44528 description: Number of cpus
44532 description: Disk size, in GBs
44536 description: RAM size, in MBs
44539 description: Equipment type. Source of truth should define valid values.
44542 description: Equipment vendor. Source of truth should define valid values.
44545 description: Equipment model. Source of truth should define valid values.
44548 description: Fully-qualified domain name
44551 description: URL to endpoint where AAI can get more details
44554 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
44557 description: Serial number, may be queried
44558 ipaddress-v4-loopback-0:
44560 description: IPV4 Loopback 0 address
44561 ipaddress-v6-loopback-0:
44563 description: IPV6 Loopback 0 address
44566 description: IPV4 AIM address
44569 description: IPV6 AIM address
44572 description: IPV6 OAM address
44575 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
44578 description: ID of Pserver
44581 description: internet topology of Pserver
44584 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.
44587 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44590 description: alternative pserver name
44593 description: purpose of pserver
44596 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
44600 $ref: "#/definitions/relationship"
44604 $ref: "#/definitions/p-interface"
44608 $ref: "#/definitions/lag-interface"
44611 Collection of compute hosts.
44616 $ref: "#/definitions/pserver"
44619 QueryParameters for performing a named-query or model query
44623 $ref: "#/definitions/named-query"
44626 $ref: "#/definitions/overloaded-model"
44630 ###### Related Nodes
44631 - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
44633 -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
44635 - related-lookup-uuid
44637 - source-node-property
44639 - target-node-property
44641 related-lookup-uuid:
44645 source-node-property:
44649 target-node-property:
44651 property-collect-list:
44658 $ref: "#/definitions/relationship"
44664 $ref: "#/definitions/related-lookup"
44665 related-to-property:
44669 description: Key part of a key/value pair
44672 description: Value part of a key/value pair
44677 description: A keyword provided by A&AI to indicate type of node.
44680 description: URL to the object in A&AI.
44684 $ref: "#/definitions/relationship-data"
44688 - relationship-value
44692 description: A keyword provided by A&AI to indicate an attribute.
44693 relationship-value:
44695 description: Value of the attribute.
44701 $ref: "#/definitions/relationship"
44702 reserved-prop-names:
44704 Internal map to define some reserved properties of a vertex
44706 last-mod-source-of-truth:
44724 Response container for the results of a named-query or model query
44726 inventory-response-items:
44728 $ref: "#/definitions/inventory-response-items"
44733 description: The specific type of node in the A&AI graph
44736 description: The URL to the specific resource
44737 route-table-reference:
44739 Openstack route table reference.
44740 ###### Related Nodes
44741 - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
44744 - route-table-reference-id
44745 - route-table-reference-fqdn
44747 route-table-reference-id:
44749 description: Route Table Reference id, UUID assigned to this instance.
44750 route-table-reference-fqdn:
44752 description: FQDN entry in the route table.
44755 description: Concurrency value
44759 $ref: "#/definitions/relationship"
44760 route-table-references:
44762 Collection of openstack route table references
44764 route-table-reference:
44767 $ref: "#/definitions/route-table-reference"
44770 Route target information
44771 ###### Related Nodes
44772 - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
44774 -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
44776 - global-route-target
44777 - route-target-role
44779 global-route-target:
44781 description: Number used to identify an RT, globally unique in the network
44784 description: Role assigned to this route target
44787 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44791 $ref: "#/definitions/relationship"
44794 Collection of route target information
44799 $ref: "#/definitions/route-target"
44802 ###### Related Nodes
44803 - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
44804 - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
44806 -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
44807 -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
44809 - routing-instance-id
44811 routing-instance-id:
44813 description: Unique id of routing instance
44816 description: rpm owner
44819 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44823 $ref: "#/definitions/site-pair"
44827 $ref: "#/definitions/relationship"
44830 set of probes related to generic-vnf routing instance
44835 $ref: "#/definitions/routing-instance"
44840 $ref: "#/definitions/oam-networks"
44841 az-and-dvs-switches:
44844 $ref: "#/definitions/az-and-dvs-switches"
44847 edge-tag-query-result:
44849 $ref: "#/definitions/edge-tag-query-result"
44850 edge-tag-query-request:
44852 $ref: "#/definitions/edge-tag-query-request"
44855 $ref: "#/definitions/search-results"
44858 $ref: "#/definitions/sdn-zone-response"
44864 $ref: "#/definitions/result-data"
44867 SecondaryFilt for performing a named-query or model query
44878 SecondaryFilts for performing a named-query or model query
44883 $ref: "#/definitions/secondary-filt"
44884 segmentation-assignment:
44886 Openstack segmentation assignment.
44887 ###### Related Nodes
44888 - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
44890 -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
44896 description: Route Table Reference id, UUID assigned to this instance.
44899 description: Concurrency value
44903 $ref: "#/definitions/relationship"
44904 segmentation-assignments:
44906 Collection of openstack segmentation assignments
44908 segmentation-assignment:
44911 $ref: "#/definitions/segmentation-assignment"
44914 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
44917 - service-description
44921 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
44922 service-description:
44924 description: Description of the service
44927 description: URL to endpoint where AAI can get more details
44930 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44933 description: service version
44937 $ref: "#/definitions/relationship"
44938 service-capabilities:
44940 Collection of service capabilities.
44942 service-capability:
44945 $ref: "#/definitions/service-capability"
44946 service-capability:
44948 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
44949 ###### Related Nodes
44950 - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
44951 - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
44953 -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
44961 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
44964 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.
44967 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44971 $ref: "#/definitions/relationship"
44972 service-design-and-creation:
44974 Namespace for objects managed by ASDC
44979 $ref: "#/definitions/vnf-image"
44983 $ref: "#/definitions/service"
44984 service-capabilities:
44987 $ref: "#/definitions/service-capability"
44991 $ref: "#/definitions/model"
44995 $ref: "#/definitions/named-query"
44998 Instance of a service
44999 ###### Related Nodes
45000 - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
45001 - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
45002 - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
45003 - TO connector( service-instance Uses connector, MANY2MANY)
45004 - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
45005 - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
45006 - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
45007 - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
45008 - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
45009 - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
45010 - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
45011 - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
45012 - TO vce( service-instance ComposedOf vce, ONE2MANY)
45013 - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
45014 - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
45015 - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
45017 -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
45018 -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
45019 -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
45021 - service-instance-id
45023 service-instance-id:
45025 description: Uniquely identifies this instance of a service
45026 service-instance-name:
45028 description: This field will store a name assigned to the service-instance.
45031 description: the ASDC model id for this resource or service model.
45032 persona-model-version:
45034 description: the ASDC model version for this resource or service model.
45037 description: the ASDC model version for this resource or service model.
45040 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
45041 widget-model-version:
45043 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
45046 description: Indicates the total bandwidth to be used for this service.
45049 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
45050 bandwidth-down-wan1:
45052 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
45055 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
45056 bandwidth-down-wan2:
45058 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
45061 description: URL customers will use to access the vHN Portal.
45062 service-instance-location-id:
45064 description: An identifier that customers assign to the location where this service is being used.
45067 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45070 description: Path to the controller object.
45071 orchestration-status:
45073 description: Orchestration status of this service.
45077 $ref: "#/definitions/relationship"
45081 $ref: "#/definitions/metadatum"
45082 allotted-resources:
45085 $ref: "#/definitions/allotted-resource"
45088 Collection of service instances
45093 $ref: "#/definitions/service-instance"
45094 service-subscription:
45096 Object that group service instances.
45097 ###### Related Nodes
45098 - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
45099 - TO tenant( service-subscription Uses tenant, MANY2MANY)
45100 - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
45102 -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
45103 -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
45109 description: Value defined by orchestration to identify this service across ECOMP.
45110 temp-ub-sub-account-id:
45112 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
45115 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45119 $ref: "#/definitions/service-instance"
45123 $ref: "#/definitions/relationship"
45124 service-subscriptions:
45126 Collection of objects that group service instances.
45128 service-subscription:
45131 $ref: "#/definitions/service-subscription"
45134 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
45139 $ref: "#/definitions/service"
45142 ###### Related Nodes
45143 - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
45144 - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
45146 -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
45147 -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
45153 description: unique identifier of probe
45156 description: Prefix address
45159 description: Prefix address
45162 description: ip version, v4, v6
45163 destination-hostname:
45165 description: Hostname of the destination equipment to which SLAs are measured against.
45166 destination-equip-type:
45168 description: The type of destinatination equipment. Could be Router, etc.
45171 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45172 classes-of-service:
45175 $ref: "#/definitions/class-of-service"
45179 $ref: "#/definitions/relationship"
45182 Set of instances for probes used to measure service level agreements
45183 ###### Related Nodes
45184 - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
45185 - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
45187 -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
45193 description: Unique id of site pair set.
45196 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45200 $ref: "#/definitions/routing-instance"
45204 $ref: "#/definitions/relationship"
45207 Collection of sets of instances for probes related to generic-vnf
45212 $ref: "#/definitions/site-pair-set"
45220 $ref: "#/definitions/site-pair"
45224 ###### Related Nodes
45225 - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
45226 - FROM vserver( vserver Uses snapshot, ONE2ONE)
45233 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
45236 description: Snapshot name
45237 snapshot-architecture:
45239 description: Operating system architecture
45240 snapshot-os-distro:
45242 description: The common name of the operating system distribution in lowercase
45243 snapshot-os-version:
45245 description: The operating system version as specified by the distributor.
45248 description: The application that the image instantiates.
45249 application-vendor:
45251 description: The vendor of the application.
45252 application-version:
45254 description: The version of the application.
45257 description: URL to endpoint where AAI can get more details
45260 description: This field contains the UUID of the previous snapshot (if any).
45263 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45267 $ref: "#/definitions/relationship"
45270 Collection of openstack snapshots
45275 $ref: "#/definitions/snapshot"
45278 SR-IOV Physical Function
45279 ###### Related Nodes
45280 - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
45281 - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
45283 -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
45289 description: Identifier for the sriov-pf
45292 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45296 $ref: "#/definitions/relationship"
45299 Collection of SR-IOV Physical Functions.
45304 $ref: "#/definitions/sriov-pf"
45307 SR-IOV Virtual Function (not to be confused with virtual network function)
45308 ###### Related Nodes
45309 - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
45311 -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
45317 description: PCI ID used to identify the sriov-vf
45320 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
45323 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
45326 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
45327 vf-vlan-anti-spoof-check:
45329 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.
45330 vf-mac-anti-spoof-check:
45332 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.
45335 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
45336 vf-broadcast-allow:
45338 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
45339 vf-unknown-multicast-allow:
45341 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
45342 vf-unknown-unicast-allow:
45344 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
45347 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
45350 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
45353 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45354 neutron-network-id:
45356 description: Neutron network id of the interface
45360 $ref: "#/definitions/relationship"
45363 Collection of SR-IOV Virtual Functions.
45368 $ref: "#/definitions/sriov-vf"
45377 ###### Related Nodes
45378 - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
45379 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
45380 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
45382 -(4) IF this TO node is deleted, this SUBNET is DELETED also
45383 -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
45391 description: Subnet ID, should be UUID.
45394 description: Name associated with the subnet.
45397 description: Neutron id of this subnet
45400 description: gateway ip address
45401 network-start-address:
45403 description: network start address
45406 description: cidr mask
45409 description: ip version
45410 orchestration-status:
45412 description: Orchestration status of this VNF, mastered by MSO
45415 description: dhcp enabled
45418 description: the start address reserved for use by dhcp
45421 description: the last address reserved for use by dhcp
45424 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45428 $ref: "#/definitions/relationship"
45434 $ref: "#/definitions/subnet"
45435 tagged-inventory-item-list:
45440 $ref: "#/definitions/inventory-item"
45444 ###### Related Nodes
45445 - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
45446 - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
45447 - TO l3-network( tenant Uses l3-network, MANY2MANY)
45448 - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
45449 - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
45450 - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
45452 -TENANT cannot be deleted if related to VSERVER
45460 description: Unique id relative to the cloud-region.
45463 description: Readable name of tenant
45466 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45470 $ref: "#/definitions/vserver"
45474 $ref: "#/definitions/relationship"
45477 Collection of openstack tenants.
45482 $ref: "#/definitions/tenant"
45485 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
45486 ###### Related Nodes
45487 - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
45489 -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
45492 - bandwidth-up-wan1
45493 - bandwidth-down-wan1
45494 - bandwidth-up-wan2
45495 - bandwidth-down-wan2
45499 description: Allotted Resource id UUID assigned to this instance.
45502 description: The WAN uplink bandwidth for WAN1
45503 bandwidth-down-wan1:
45505 description: The WAN downlink bandwidth for WAN1
45508 description: The WAN uplink bandwidth for WAN2
45509 bandwidth-down-wan2:
45511 description: The WAN downlink bandwidth for WAN2
45514 description: Concurrency value
45518 $ref: "#/definitions/relationship"
45521 This object is used to store the specific tunnel cross connect aspects of an allotted resource
45526 $ref: "#/definitions/tunnel-xconnect"
45529 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
45538 $ref: "#/definitions/update-node-key"
45544 $ref: "#/definitions/action"
45553 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
45554 ###### Related Nodes
45555 - TO availability-zone( vce Uses availability-zone, MANY2MANY)
45556 - TO complex( vce LocatedIn complex, MANY2MANY)
45557 - TO vserver( vce HostedOn vserver, ONE2MANY)
45558 - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
45559 - FROM license( license BelongsTo vce, MANY2ONE)(1)
45560 - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
45561 - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
45563 -(1) IF this VCE node is deleted, this FROM node is DELETED also
45571 description: Unique id of VNF. This is unique across the graph.
45574 description: Name of VNF.
45577 description: Alternate name of VNF.
45580 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.
45583 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
45584 regional-resource-zone:
45586 description: Regional way of organizing pservers, source of truth should define values
45589 description: Trigger for operational monitoring of this resource by Service Assurance systems.
45592 description: Indicator for whether the resource is considered operational
45595 description: OBSOLETE - do not use
45598 description: Network role being played by this VNF
45599 orchestration-status:
45601 description: Orchestration status of this VNF, mastered by MSO
45604 description: Heat stack id corresponding to this instance, managed by MSO
45607 description: Corresponds to the SDN-C catalog id used to configure this VCE
45610 description: Unique ID of VPE connected to this VCE.
45611 v6-vce-wan-address:
45613 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
45616 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
45619 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45620 ipv4-loopback0-address:
45622 description: Loopback0 address
45623 entitlement-resource-uuid:
45625 description: OBSOLETE - see child relationships
45629 $ref: "#/definitions/port-group"
45633 $ref: "#/definitions/license"
45637 $ref: "#/definitions/entitlement"
45641 $ref: "#/definitions/relationship"
45644 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
45649 $ref: "#/definitions/vce"
45652 a deployment unit of VNFCs
45653 ###### Related Nodes
45654 - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
45655 - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
45656 - TO vnfc( vf-module Uses vnfc, ONE2MANY)
45657 - TO volume-group( vf-module Uses volume-group, ONE2ONE)
45658 - TO vserver( vf-module Uses vserver, ONE2MANY)
45660 -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
45661 -VF-MODULE cannot be deleted if related to VNFC
45665 - is-base-vf-module
45669 description: Unique ID of vf-module.
45672 description: Name of vf-module
45675 description: Heat stack id corresponding to this instance.
45676 orchestration-status:
45678 description: orchestration status of this vf-module, mastered by MSO
45681 description: used to indicate whether or not this object is base vf module
45684 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45687 description: the ASDC model id for this resource or service model.
45688 persona-model-version:
45690 description: the ASDC model version for this resource or service model.
45693 description: the ASDC model version for this resource or service model.
45694 persona-model-customization-id:
45696 description: captures the id of all the configuration used to customize the resource for the service.
45699 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
45700 widget-model-version:
45702 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
45703 contrail-service-instance-fqdn:
45705 description: the Contrail unique ID for a service-instance
45709 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
45712 description: Path to the controller object.
45716 $ref: "#/definitions/relationship"
45719 Collection of vf-modules, a deployment unit of VNFCs
45724 $ref: "#/definitions/vf-module"
45727 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
45728 ###### Related Nodes
45729 - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
45731 -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
45737 description: indicates whether the VIG is for AVPN or INTERNET
45740 description: v4 IP of the vig server
45743 description: v6 IP of the vig server
45746 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45750 $ref: "#/definitions/relationship"
45756 $ref: "#/definitions/vig-server"
45757 vip-ipv4-address-list:
45760 ###### Related Nodes
45761 - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
45762 - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
45763 - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
45764 - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
45771 description: IP address
45772 vip-ipv4-prefix-length:
45775 description: Prefix length, 32 for single address
45779 description: Inner VLAN tag
45783 description: Outer VLAN tag
45786 description: Indicator of fixed or floating address
45789 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45790 neutron-network-id:
45792 description: Neutron network id of the interface that address belongs to
45795 description: Neutron id of subnet that address belongs to
45799 $ref: "#/definitions/relationship"
45800 vip-ipv6-address-list:
45803 ###### Related Nodes
45804 - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
45805 - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
45806 - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
45807 - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
45814 description: IP address
45815 vip-ipv6-prefix-length:
45818 description: Prefix length, 128 for single address
45822 description: Inner VLAN tag
45826 description: Outer VLAN tag
45829 description: Indicator of fixed or floating address
45832 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45833 neutron-network-id:
45835 description: Neutron network id of the interface that address belongs to
45838 description: Neutron id of subnet that address belongs to
45842 $ref: "#/definitions/relationship"
45843 virtual-data-center:
45845 Virtual organization of cloud infrastructure elements in a data center context
45846 ###### Related Nodes
45847 - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
45848 - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
45849 - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
45857 description: Unique ID of the vdc
45860 description: Name of the virtual data center
45863 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45867 $ref: "#/definitions/relationship"
45868 virtual-data-centers:
45870 Virtual organization of cloud infrastructure elements in a data center context
45872 virtual-data-center:
45875 $ref: "#/definitions/virtual-data-center"
45879 ###### Related Nodes
45880 - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
45881 - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
45882 - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
45883 - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
45884 - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
45885 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
45886 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
45888 -(1) IF this VLAN node is deleted, this FROM node is DELETED also
45889 -(2) IF this VLAN node is deleted, this TO node is DELETED also
45890 -(4) IF this TO node is deleted, this VLAN is DELETED also
45896 description: String that identifies the interface
45900 description: Inner VLAN tag
45904 description: Outer VLAN tag
45907 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45910 description: Captures the numeric part of the speed
45913 description: Captures the units corresponding to the speed
45916 description: Used to describe (the service associated with) the vlan
45917 backdoor-connection:
45919 description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
45922 description: This indicates the customers VPN ID associated with this vlan
45923 orchestration-status:
45925 description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
45929 $ref: "#/definitions/relationship"
45930 l3-interface-ipv4-address-list:
45933 $ref: "#/definitions/l3-interface-ipv4-address-list"
45934 l3-interface-ipv6-address-list:
45937 $ref: "#/definitions/l3-interface-ipv6-address-list"
45943 $ref: "#/definitions/vlan"
45952 description: Unique id of VNF. This is unique across the graph.
45955 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
45956 ###### Related Nodes
45957 - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
45959 -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
45964 - application-vendor
45968 description: Unique ID of this asset
45971 description: The application that the image instantiates.
45972 application-vendor:
45974 description: The vendor of the application.
45975 application-version:
45977 description: The version of the application.
45980 description: URL to endpoint where AAI can get more details
45983 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45987 $ref: "#/definitions/relationship"
45990 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
45995 $ref: "#/definitions/vnf-image"
45998 ###### Related Nodes
45999 - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
46000 - TO vserver( vnfc HostedOn vserver, ONE2MANY)
46001 - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
46003 -(4) IF this TO node is deleted, this VNFC is DELETED also
46006 - vnfc-function-code
46009 - is-closed-loop-disabled
46013 description: Unique ID of vnfc.
46014 vnfc-function-code:
46016 description: function code
46022 description: prov status of this vnfc
46023 orchestration-status:
46025 description: Orchestration status of this VNF, mastered by APP-C
46026 ipaddress-v4-oam-vip:
46028 description: Oam V4 vip address of this vnfc
46031 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
46032 is-closed-loop-disabled:
46034 description: used to indicate whether closed loop function is enabled on this node
46037 description: Group notation of VNFC
46040 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46044 $ref: "#/definitions/relationship"
46047 virtual network components associated with a vserver from application controller.
46052 $ref: "#/definitions/vnfc"
46055 Ephemeral Block storage volume.
46056 ###### Related Nodes
46057 - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
46059 -(3) IF this FROM node is deleted, this VOLUME is DELETED also
46066 description: Unique ID of block storage volume relative to the vserver.
46069 description: URL to endpoint where AAI can get more details
46072 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46076 $ref: "#/definitions/relationship"
46079 Persistent block-level storage.
46080 ###### Related Nodes
46081 - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
46082 - TO complex( volume-group LocatedIn complex, MANY2ONE)
46083 - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
46084 - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
46085 - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
46089 - volume-group-name
46094 description: Unique ID of volume-group.
46097 description: Name of the volume group.
46100 description: Heat stack id corresponding to this volume-group
46103 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
46104 orchestration-status:
46106 description: Orchestration status of this volume-group
46107 persona-model-customization-id:
46109 description: captures the id of all the configuration used to customize the resource for the service.
46110 vf-module-persona-model-customization-id:
46112 description: helps relate the volume group to the vf-module whose components will require the volume group
46115 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46119 $ref: "#/definitions/relationship"
46122 Collection of persistent block-level storage.
46127 $ref: "#/definitions/volume-group"
46130 Collection of ephemeral Block storage volumes.
46135 $ref: "#/definitions/volume"
46138 VPLS Provider Edge routers.
46139 ###### Related Nodes
46140 - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
46141 - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
46142 - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
46143 - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
46145 -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
46153 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
46156 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
46159 description: Client should send valid enumerated value, e.g., VPLS-PE.
46163 description: Temporary location for stag to get to VCE
46166 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46170 $ref: "#/definitions/relationship"
46174 $ref: "#/definitions/p-interface"
46178 $ref: "#/definitions/lag-interface"
46181 Collection of VPLS Provider Edge routers
46186 $ref: "#/definitions/vpls-pe"
46190 ###### Related Nodes
46191 - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
46192 - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
46194 -VPN-BINDING cannot be deleted if related to L3-NETWORK,LOGICAL-LINK
46199 - global-route-target
46200 - route-target-role
46204 description: VPN ID, globally unique within A&AI
46207 description: VPN Name
46208 global-route-target:
46210 description: Number used to identify a VPN, globally unique in the network
46213 description: the platform associated with the VPN example AVPN, Mobility
46216 description: Type of the vpn, should be taken from enumerated/valid values
46217 route-distinguisher:
46219 description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
46222 description: Role assigned to this route target
46225 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46229 $ref: "#/definitions/relationship"
46230 description: l3-networks relate to vpn-bindings
46236 $ref: "#/definitions/vpn-binding"
46239 Virtual Servers, aka virtual machine or VM.
46240 ###### Related Nodes
46241 - TO tenant( vserver BelongsTo tenant, MANY2ONE)
46242 - TO flavor( vserver Uses flavor, MANY2ONE)
46243 - TO image( vserver Uses image, MANY2ONE)
46244 - TO pserver( vserver HostedOn pserver, MANY2ONE)
46245 - TO snapshot( vserver Uses snapshot, ONE2ONE)
46246 - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
46247 - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
46248 - FROM vce( vce HostedOn vserver, ONE2MANY)
46249 - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
46250 - FROM vf-module( vf-module Uses vserver, ONE2MANY)
46251 - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
46253 -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
46254 -(2) IF this VSERVER node is deleted, this TO node is DELETED also
46260 - is-closed-loop-disabled
46264 description: Unique identifier for this vserver relative to its tenant
46267 description: Name of vserver
46270 description: Alternative name of vserver
46273 description: Trigger for operational monitoring of this resource by Service Assurance systems.
46276 description: URL to endpoint where AAI can get more details
46279 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.
46280 is-closed-loop-disabled:
46282 description: Used to indicate whether closed loop function is enabled on this node
46285 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46289 $ref: "#/definitions/volume"
46293 $ref: "#/definitions/relationship"
46297 $ref: "#/definitions/l-interface"
46300 Collection of virtual Servers, aka virtual machines or VMs.
46305 $ref: "#/definitions/vserver"
46308 A zone is a grouping of assets in a location homing to the same connections into the CBB
46309 ###### Related Nodes
46310 - TO complex( zone LocatedIn complex, MANY2ONE)
46311 - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
46312 - FROM pnf( pnf LocatedIn zone, MANY2ONE)
46313 - FROM pserver( pserver LocatedIn zone, MANY2ONE)
46323 description: Code assigned by AIC to the zone
46326 description: English name associated with the zone
46329 description: Design of zone [Medium/Large?]
46332 description: Context of zone [production/test]
46335 description: Status of a zone.
46338 description: Concurrency value
46342 $ref: "#/definitions/relationship"
46345 Collection of zones
46350 $ref: "#/definitions/zone"
46359 $ref: "#/patchDefinitions/action-data"
46368 APIs that are more action related than REST (e.g., notify, update).
46372 $ref: "#/patchDefinitions/update"
46375 $ref: "#/patchDefinitions/notify"
46378 Represents a slice or partial piece of a resource that gets separately allotted
46379 ###### Related Nodes
46380 - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
46381 - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
46382 - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
46383 - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
46384 - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
46385 - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
46386 - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
46388 -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
46389 -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
46395 description: Allotted Resource id UUID assigned to this instance.
46398 description: The descriptive information assigned to this allotted resource instance
46401 description: Link back to more information in the controller
46404 description: the ASDC model id for this resource or service model.
46405 persona-model-version:
46407 description: the ASDC model version for this resource or service model.
46410 description: the ASDC model version for this resource or service model.
46411 persona-model-customization-id:
46413 description: captures the id of all the configuration used to customize the resource for the service.
46414 allotted-resources:
46416 This object is used to store slices of services being offered
46421 $ref: "#/patchDefinitions/allotted-resource"
46424 Availability zone, a collection of compute hosts/pservers
46425 ###### Related Nodes
46426 - TO complex( availability-zone LocatedIn complex, MANY2ONE)
46427 - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
46428 - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
46429 - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
46430 - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
46431 - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
46432 - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
46433 - FROM vce( vce Uses availability-zone, MANY2MANY)
46435 -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
46436 -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
46439 - availability-zone-name
46442 availability-zone-name:
46444 description: Name of the availability zone. Unique across a cloud region
46447 description: Type of hypervisor. Source of truth should define valid values.
46450 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
46451 availability-zones:
46453 Collection of availability zones
46458 $ref: "#/patchDefinitions/availability-zone"
46459 az-and-dvs-switches:
46463 $ref: "#/patchDefinitions/dvs-switches"
46466 $ref: "#/patchDefinitions/availability-zone"
46469 Namespace for business related constructs
46474 $ref: "#/patchDefinitions/connector"
46478 $ref: "#/patchDefinitions/customer"
46481 ###### Related Nodes
46482 - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
46484 -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
46490 description: unique identifier of probe
46493 description: identifier of probe
46496 description: type of probe
46497 classes-of-service:
46499 class-of-service of probe
46504 $ref: "#/patchDefinitions/class-of-service"
46505 cloud-infrastructure:
46507 Namespace for cloud infrastructure.
46512 $ref: "#/patchDefinitions/complex"
46516 $ref: "#/patchDefinitions/cloud-region"
46520 $ref: "#/patchDefinitions/network-profile"
46524 $ref: "#/patchDefinitions/pserver"
46525 virtual-data-centers:
46528 $ref: "#/patchDefinitions/virtual-data-center"
46531 cloud-region designates an installation of a cloud cluster or region or instantiation.
46532 ###### Related Nodes
46533 - TO complex( cloud-region LocatedIn complex, MANY2ONE)
46534 - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
46535 - TO zone( cloud-region LocatedIn zone, MANY2ONE)
46536 - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
46537 - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
46538 - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
46539 - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
46540 - FROM image( image BelongsTo cloud-region, MANY2ONE)
46541 - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
46542 - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
46543 - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
46544 - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
46545 - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
46546 - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
46548 -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
46549 -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
46557 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
46560 description: Identifier used by the vendor for the region. Second part of composite key
46563 description: Type of the cloud (e.g., openstack)
46564 owner-defined-type:
46566 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
46567 cloud-region-version:
46569 description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
46572 description: URL of the keystone identity service
46575 description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
46578 description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
46584 $ref: "#/patchDefinitions/cloud-region"
46587 Collection of physical locations that can house cloud-regions.
46588 ###### Related Nodes
46589 - TO l3-network( complex Uses l3-network, MANY2MANY)
46590 - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
46591 - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
46592 - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
46593 - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
46594 - FROM pnf( pnf LocatedIn complex, MANY2ONE)
46595 - FROM pserver( pserver LocatedIn complex, MANY2ONE)
46596 - FROM vce( vce LocatedIn complex, MANY2MANY)
46597 - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
46598 - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
46599 - FROM zone( zone LocatedIn complex, MANY2ONE)
46601 -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
46602 -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
46605 - physical-location-id
46606 - physical-location-type
46613 physical-location-id:
46615 description: Unique identifier for physical location, e.g., CLLI
46618 description: Data center code which can be an alternate way to identify a complex
46621 description: Gamma complex name for LCP instance.
46624 description: URL of the keystone identity service
46627 Collection of physical locations that can house cloud-regions.
46632 $ref: "#/patchDefinitions/complex"
46635 Port Mirror Configuration.
46636 ###### Related Nodes
46637 - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
46638 - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
46639 - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
46640 - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
46641 - FROM service-instance( service-instance Uses configuration, ONE2MANY)
46643 -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
46644 -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
46645 -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
46648 - configuration-type
46649 - configuration-sub-type
46650 - orchestration-status
46651 - operational-status
46652 - configuration-selflink
46653 - model-customization-id
46657 description: UUID assigned to configuration.
46660 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
46661 configuration-name:
46663 description: Name of the configuration.
46664 configuration-type:
46666 description: port-mirroring-configuration.
46667 configuration-sub-type:
46669 description: vprobe, pprobe.
46670 model-invariant-id:
46672 description: the ASDC model id for this resource or service model.
46675 description: the ASDC model version for this resource or service model.
46676 orchestration-status:
46678 description: Orchestration status of the configuration.
46679 operational-status:
46681 description: Indicator for whether the resource is considered operational.
46682 configuration-selflink:
46684 description: URL to endpoint where AAI can get more details from SDN-GC.
46685 model-customization-id:
46687 description: id of the configuration used to customize the resource
46690 Collection of configurations
46695 $ref: "#/patchDefinitions/configuration"
46698 Collection of resource instances used to connect a variety of disparate inventory widgets
46699 ###### Related Nodes
46700 - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
46701 - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
46702 - FROM service-instance( service-instance Uses connector, MANY2MANY)
46704 -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
46706 - resource-instance-id
46708 resource-instance-id:
46710 description: Unique id of resource instance.
46713 Collection of resource instances used to connect a variety of disparate inventory widgets
46718 $ref: "#/patchDefinitions/connector"
46719 constrained-element-set:
46721 This is how we would capture constraints defining allowed sets of elements.
46722 ###### Related Nodes
46723 - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
46724 - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
46725 - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
46727 -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
46728 -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
46730 - constrained-element-set-uuid
46734 constrained-element-set-uuid:
46740 constrained-element-sets:
46742 constrained-element-set:
46745 $ref: "#/patchDefinitions/constrained-element-set"
46748 ###### Related Nodes
46749 - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
46750 - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
46752 -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
46765 $ref: "#/patchDefinitions/ctag-assignment"
46768 A collection of C tags (vlan tags) grouped for a specific purpose.
46769 ###### Related Nodes
46770 - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
46771 - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
46772 - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
46774 -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
46777 - availability-zone-name
46778 - ctag-pool-purpose
46782 description: The Target provider edge router
46783 availability-zone-name:
46785 description: Name of the availability zone
46788 description: Describes what the intended purpose of this pool is.
46791 description: Comma separated list of ctags
46797 $ref: "#/patchDefinitions/ctag-pool"
46800 customer identifiers to provide linkage back to BSS information.
46801 ###### Related Nodes
46802 - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
46804 -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
46806 - global-customer-id
46810 global-customer-id:
46812 description: Global customer id used across ECOMP to uniquely identify customer.
46815 description: Subscriber name, an alternate way to retrieve a customer.
46818 description: Subscriber type, a way to provide VID with only the INFRA customers.
46821 Collection of customer identifiers to provide linkage back to BSS information.
46826 $ref: "#/patchDefinitions/customer"
46834 description: See mis-na-virtualization-platform.yang
46840 $ref: "#/patchDefinitions/cvlan-tag-entry"
46843 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.
46844 ###### Related Nodes
46845 - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
46846 - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
46854 description: DVS switch name
46857 description: URL used to reach the vcenter
46860 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
46865 $ref: "#/patchDefinitions/dvs-switch"
46868 Internal map to define the properties of an edge and interpret the map EdgeRules
46886 edge-tag-query-request:
46897 $ref: "#/patchDefinitions/start-node-filter"
46898 include-node-filter:
46901 $ref: "#/patchDefinitions/include-node-filter"
46905 $ref: "#/patchDefinitions/secondary-filter"
46906 edge-tag-query-result:
46908 tagged-inventory-item-list:
46911 $ref: "#/patchDefinitions/tagged-inventory-item-list"
46912 element-choice-set:
46914 This is how we would capture constraints defining allowed sets of elements.
46915 ###### Related Nodes
46916 - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
46917 - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
46919 -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
46920 -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
46922 - element-choice-set-uuid
46923 - element-choice-set-name
46925 element-choice-set-uuid:
46927 element-choice-set-name:
46931 element-choice-sets:
46933 element-choice-set:
46936 $ref: "#/patchDefinitions/element-choice-set"
46939 Metadata for entitlement group.
46940 ###### Related Nodes
46941 - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
46942 - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
46944 -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
46951 description: Unique ID for the entitlement group the resource comes from, should be uuid.
46954 description: Unique ID of an entitlement resource.
46957 Entitlements, keyed by group-uuid and resource-uuid, related to license management
46962 $ref: "#/patchDefinitions/entitlement"
46965 Persist EMS address information used by EMS driver.
46966 ###### Related Nodes
46967 - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
46969 -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
46975 description: Unique ID of EMS.
46981 $ref: "#/patchDefinitions/esr-ems"
46984 Persist common address information of external systems.
46985 ###### Related Nodes
46986 - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
46987 - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
46988 - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
46989 - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
46991 -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
46993 - esr-system-info-id
46998 esr-system-info-id:
47000 description: Unique ID of esr system info.
47003 description: name of external system.
47006 description: type of external systems.
47009 description: vendor of external systems.
47012 description: version of external systems.
47015 description: url used to access external systems.
47018 description: username used to access external systems.
47021 description: password used to access external systems.
47024 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
47027 description: protocol of third party SDNC, for example netconf/snmp.
47030 description: ca file content if enabled ssl on auth-url.
47033 description: Whether to verify VIM's certificate.
47036 description: service IP of ftp server.
47039 description: service port of ftp server.
47042 description: domain info for authentication.
47045 description: default tenant of VIM.
47048 description: ftp passive mode or not.
47051 description: resource or performance data file path.
47054 description: the status of external system.
47055 esr-system-info-list:
47057 Collection of persistent block-level external system auth info.
47062 $ref: "#/patchDefinitions/esr-system-info"
47063 esr-thirdparty-sdnc:
47065 Persist SDNC address information used by ONAP SDNC.
47066 ###### Related Nodes
47067 - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
47068 - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
47070 -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
47072 - thirdparty-sdnc-id
47074 thirdparty-sdnc-id:
47076 description: Unique ID of SDNC.
47079 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
47082 description: password used to access SDNC server.
47083 esr-thirdparty-sdnc-list:
47085 esr-thirdparty-sdnc:
47088 $ref: "#/patchDefinitions/esr-thirdparty-sdnc"
47091 Persist VNFM address information used by VF-C.
47092 ###### Related Nodes
47093 - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
47095 -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
47101 description: Unique ID of VNFM.
47104 description: indecate the VIM to deploy VNF.
47107 description: certificate url of VNFM.
47113 $ref: "#/patchDefinitions/esr-vnfm"
47116 evc object is an optional child object of the Configuration object.
47117 ###### Related Nodes
47118 - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
47120 -(4) IF this TO node is deleted, this EVC is DELETED also
47126 description: Unique/key field for the evc object
47127 forwarding-path-topology:
47129 description: Point-to-Point, Multi-Point
47132 description: Commited Information Rate
47135 description: CIR units
47136 connection-diversity-group-id:
47138 description: Diversity Group ID
47141 description: formerly Performance Group
47142 esp-evc-circuit-id:
47144 description: EVC Circuit ID of ESP EVC
47147 description: Committed Information Rate (For ESP)
47150 description: CIR units (For ESP)
47153 description: Identifies ESP
47154 collector-pop-clli:
47156 description: Collector POP CLLI (from the hostname of the access pnf)
47157 inter-connect-type-ingress:
47159 description: Interconnect type on ingress side of EVC.
47160 tagmode-access-ingress:
47162 description: tagode for collector side of EVC
47163 tagmode-access-egress:
47165 description: tagMode for network side of EVC
47171 $ref: "#/patchDefinitions/evc"
47174 Namespace for external system.
47178 $ref: "#/patchDefinitions/esr-ems-list"
47181 $ref: "#/patchDefinitions/esr-vnfm-list"
47182 esr-thirdparty-sdnc-list:
47184 $ref: "#/patchDefinitions/esr-thirdparty-sdnc-list"
47187 Extra properties for inventory item for response list
47195 ###### Related Nodes
47196 - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
47197 - FROM vserver( vserver Uses flavor, MANY2ONE)
47199 -FLAVOR cannot be deleted if related to VSERVER
47208 description: Flavor id, expected to be unique across cloud-region.
47211 description: Flavor name
47215 description: Number of CPUs
47219 description: Amount of memory
47223 description: Disk space
47227 description: Amount of ephemeral disk space
47230 description: amount of swap space allocation
47233 description: whether flavor is available to all users or private to the tenant it was created in.
47236 description: URL to endpoint where AAI can get more details
47239 description: Boolean as to whether this flavor is no longer enabled
47242 Collection of openstack flavors.
47247 $ref: "#/patchDefinitions/flavor"
47250 Entity describing a sequenced segment of forwarding path
47251 ###### Related Nodes
47252 - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
47253 - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
47254 - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
47255 - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
47256 - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
47258 -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
47259 -(4) IF this TO node is deleted, this FORWARDER is DELETED also
47266 description: Unique ID of this segmentation
47269 description: ingress, intermediate, egress
47272 forwarder object is an optional child object of the Configuration object.
47273 ###### Related Nodes
47274 - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
47276 -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
47282 description: Key for forwarder-evc object
47285 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
47288 description: Internal VLAN.
47291 description: SVLAN value for ingress of egress forwarder.
47294 description: CVLAN value for ingress of egress forwarder.
47300 $ref: "#/patchDefinitions/forwarder-evc"
47306 $ref: "#/patchDefinitions/forwarder"
47309 Entity that describes the sequenced forwarding path between interfaces of services or resources
47310 ###### Related Nodes
47311 - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
47312 - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
47313 - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
47315 -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
47316 -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
47317 -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
47319 - forwarding-path-id
47320 - forwarding-path-name
47322 forwarding-path-id:
47324 description: Unique ID of this FP
47325 forwarding-path-name:
47327 description: Name of the FP
47333 $ref: "#/patchDefinitions/forwarding-path"
47336 General purpose VNF
47337 ###### Related Nodes
47338 - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
47339 - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
47340 - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
47341 - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
47342 - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
47343 - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
47344 - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
47345 - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
47346 - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
47347 - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
47348 - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
47349 - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
47350 - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
47351 - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
47352 - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
47353 - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
47354 - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
47355 - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
47356 - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
47357 - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
47358 - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
47360 -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
47366 - is-closed-loop-disabled
47370 description: Unique id of VNF. This is unique across the graph.
47373 description: Name of VNF.
47376 description: Alternate name of VNF.
47379 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.
47382 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
47383 regional-resource-zone:
47385 description: Regional way of organizing pservers, source of truth should define values
47388 description: Trigger for operational monitoring of this resource by Service Assurance systems.
47391 description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
47394 description: OBSOLETE - do not use
47397 description: Client should send valid enumerated value
47398 orchestration-status:
47400 description: Orchestration status of this VNF, used by MSO.
47403 description: Heat stack id corresponding to this instance, managed by MSO
47406 description: Corresponds to the SDN-C catalog id used to configure this VCE
47409 description: identifier of managed by company or customer
47412 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
47413 ipv4-loopback0-address:
47415 description: v4 Loopback0 address
47418 description: v6 Loopback address
47419 management-v6-address:
47421 description: v6 management address
47425 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
47428 description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only in some usecases
47432 description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
47435 description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only in some usecases
47439 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
47442 description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases
47445 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.
47446 is-closed-loop-disabled:
47448 description: used to indicate whether closed loop function is enabled on this node
47456 $ref: "#/patchDefinitions/generic-vnf"
47459 Openstack group-assignment used to store exclusivity groups (EG).
47460 ###### Related Nodes
47461 - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
47462 - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
47463 - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
47472 description: Group id, expected to be unique across cloud-region.
47475 description: Group type - the type of group this instance refers to
47478 description: Group name - name assigned to the group
47481 description: Group description - description of the group
47484 Collection of openstack group assignments
47489 $ref: "#/patchDefinitions/group-assignment"
47492 ###### Related Nodes
47493 - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
47495 -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
47503 description: host-route id
47506 description: subnet prefix
47509 description: Could be ip-address, hostname, or service-instance
47512 description: Should be ip-address, hostname, or service-instance to match next-hop
47518 $ref: "#/patchDefinitions/host-route"
47521 Collection of HPA Capabilities
47526 $ref: "#/patchDefinitions/hpa-capability"
47529 Represents a HPA capability
47530 ###### Related Nodes
47531 - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
47532 - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
47533 - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
47535 -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
47537 - hpa-capability-id
47542 description: UUID to uniquely identify a HPA capability
47545 description: Name of the HPACapability
47548 description: HPA schema version
47551 description: Hardware architecture
47552 hpa-feature-attributes:
47554 HPA Capability Feature attributes
47555 ###### Related Nodes
47556 - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
47558 -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
47560 - hpa-attribute-key
47564 description: name of the specific HPA attribute
47565 hpa-attribute-value:
47567 description: JSON string specifying the value, unit and type of the specific HPA attribute
47571 ###### Related Nodes
47572 - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
47573 - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
47574 - FROM vserver( vserver Uses image, MANY2ONE)
47576 -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
47577 -IMAGE cannot be deleted if related to VSERVER
47588 description: Image id, expected to be unique across cloud region
47591 description: Image name
47592 image-architecture:
47594 description: Operating system architecture.
47597 description: The common name of the operating system distribution in lowercase
47600 description: The operating system version as specified by the distributor.
47603 description: The application that the image instantiates.
47604 application-vendor:
47606 description: The vendor of the application.
47607 application-version:
47609 description: The version of the application.
47612 description: URL to endpoint where AAI can get more details
47615 Collectio of Openstack images.
47620 $ref: "#/patchDefinitions/image"
47621 include-node-filter:
47627 InstanceFilter for performing a named-query or model query
47630 InstanceFilters for performing a named-query or model query
47635 $ref: "#/patchDefinitions/instance-filter"
47638 General mechanism for grouping instances
47639 ###### Related Nodes
47640 - TO model( instance-group Targets model, MANY2MANY)
47641 - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
47642 - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
47643 - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
47644 - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
47653 description: Instance Group ID, UUID assigned to this instance.
47656 description: Descriptive text to help identify the usage of this instance-group
47659 description: Only valid value today is lower case ha for high availability
47662 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
47665 Collection of openstack route table references
47670 $ref: "#/patchDefinitions/instance-group"
47675 $ref: "#/patchDefinitions/search"
47678 $ref: "#/patchDefinitions/actions"
47679 cloud-infrastructure:
47681 $ref: "#/patchDefinitions/cloud-infrastructure"
47684 $ref: "#/patchDefinitions/business"
47685 service-design-and-creation:
47687 $ref: "#/patchDefinitions/service-design-and-creation"
47690 $ref: "#/patchDefinitions/network"
47693 $ref: "#/patchDefinitions/nodes"
47696 inventory-item-type:
47698 inventory-item-link:
47700 inventory-item-data:
47703 $ref: "#/patchDefinitions/inventory-item-data"
47704 tagged-inventory-item-list:
47707 $ref: "#/patchDefinitions/tagged-inventory-item-list"
47708 inventory-item-data:
47714 inventory-response-item:
47716 Inventory item for response list
47722 $ref: "#/patchDefinitions/extra-properties"
47723 inventory-response-items:
47725 $ref: "#/patchDefinitions/inventory-response-items"
47726 inventory-response-items:
47728 Container for inventory items in response list
47730 inventory-response-item:
47733 $ref: "#/patchDefinitions/inventory-response-item"
47734 ipsec-configuration:
47736 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
47737 ###### Related Nodes
47738 - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
47739 - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
47741 -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
47743 - ipsec-configuration-id
47745 ipsec-configuration-id:
47747 description: UUID of this configuration
47748 requested-vig-address-type:
47750 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
47751 requested-encryption-strength:
47753 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
47754 requested-dmz-type:
47756 description: can offer a shared DMZ or a DMZ specific to a customer
47757 shared-dmz-network-address:
47759 description: Network address of shared DMZ
47760 requested-customer-name:
47762 description: If the DMZ is a custom DMZ, this field will indicate the customer information
47765 description: can be 1 or 2
47766 ikev1-authentication:
47768 description: Contains values like md5, sha1, sha256, sha384
47771 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
47774 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
47777 description: Group name defined in VIG for clients using aggressive mode
47780 description: pre-shared key for the above group name
47783 description: Lifetime for IKEv1 SA
47784 ipsec-authentication:
47786 description: md5, sha1, sha256, sha384
47789 description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
47792 description: Life time for IPSec SA
47795 description: enable PFS or not
47798 description: user ID for xAuth, sm-user, ,nmteHostName
47799 xauth-user-password:
47801 description: Encrypted using the Juniper $9$ algorithm
47804 description: The time between DPD probe
47807 description: Maximum number of DPD before claiming the tunnel is down
47808 ipsec-configurations:
47810 ipsec-configuration:
47813 $ref: "#/patchDefinitions/ipsec-configuration"
47822 Logical interfaces, e.g., a vnic.
47823 ###### Related Nodes
47824 - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
47825 - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
47826 - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
47827 - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
47828 - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
47829 - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
47830 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
47831 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
47832 - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
47833 - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
47835 -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
47836 -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
47837 -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
47843 description: Name given to the interface
47846 description: E.g., CUSTOMER, UPLINK, etc.
47849 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
47852 description: URL to endpoint where AAI can get more details
47855 description: ID of interface
47858 description: MAC address for the interface
47861 description: Name of the network
47864 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
47865 interface-description:
47867 description: Human friendly text regarding this interface.
47870 Collection of logical interfaces.
47875 $ref: "#/patchDefinitions/l-interface"
47876 l3-interface-ipv4-address-list:
47879 ###### Related Nodes
47880 - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
47881 - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
47882 - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
47883 - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
47885 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
47887 - l3-interface-ipv4-address
47889 l3-interface-ipv4-address:
47891 description: IP address
47892 l3-interface-ipv4-prefix-length:
47895 description: Prefix length, 32 for single address
47899 description: Inner VLAN tag
47903 description: Outer VLAN tag
47906 description: Indicator of fixed or floating address
47907 l3-interface-ipv6-address-list:
47910 ###### Related Nodes
47911 - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
47912 - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
47913 - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
47914 - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
47916 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
47918 - l3-interface-ipv6-address
47920 l3-interface-ipv6-address:
47922 description: IP address
47923 l3-interface-ipv6-prefix-length:
47926 description: Prefix length, 128 for single address
47930 description: Inner VLAN tag
47934 description: Outer VLAN tag
47937 description: Indicator of fixed or floating address
47940 Generic network definition
47941 ###### Related Nodes
47942 - TO network-policy( l3-network Uses network-policy, MANY2MANY)
47943 - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
47944 - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
47945 - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
47946 - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
47947 - FROM complex( complex Uses l3-network, MANY2MANY)
47948 - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
47949 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
47950 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
47951 - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
47952 - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
47953 - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
47954 - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
47955 - FROM tenant( tenant Uses l3-network, MANY2MANY)
47956 - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
47958 -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
47963 - is-provider-network
47964 - is-shared-network
47965 - is-external-network
47969 description: Network ID, should be uuid. Unique across A&AI.
47972 description: Name of the network, governed by some naming convention..
47975 description: Type of the network - who defines these values?
47978 description: Role the network plans - who defines these values?
47979 network-technology:
47981 description: Network technology - who defines these values?
47982 neutron-network-id:
47984 description: Neutron network id of this Interface
47987 description: Set to true if bound to VPN
47990 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
47991 network-role-instance:
47994 description: network role instance
48000 $ref: "#/patchDefinitions/l3-network"
48003 Link aggregate interface
48004 ###### Related Nodes
48005 - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
48006 - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
48007 - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
48008 - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
48009 - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
48010 - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
48011 - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
48013 -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
48014 -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
48015 -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
48021 description: Name that identifies the link aggregate interface
48022 interface-description:
48024 description: Human friendly text regarding this interface.
48027 Collection of link aggregate interfaces.
48032 $ref: "#/patchDefinitions/lag-interface"
48035 LAG links can connect lag-interfaces
48036 ###### Related Nodes
48037 - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
48038 - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
48040 -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
48046 description: Alphabetical concatenation of lag-interface names
48049 Collection of link aggregation connections
48054 $ref: "#/patchDefinitions/lag-link"
48057 Metadata for license group.
48058 ###### Related Nodes
48059 - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
48060 - TO vce( license BelongsTo vce, MANY2ONE)(4)
48062 -(4) IF this TO node is deleted, this LICENSE is DELETED also
48069 description: Unique ID for the license group the resource belongs to, should be uuid.
48072 description: Unique ID of a license resource.
48075 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
48080 $ref: "#/patchDefinitions/license"
48083 describes a line-of-business
48084 ###### Related Nodes
48085 - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
48088 - line-of-business-name
48090 line-of-business-name:
48092 description: Name of the line-of-business (product)
48095 Collection of lines-of-business
48100 $ref: "#/patchDefinitions/line-of-business"
48103 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
48104 ###### Related Nodes
48105 - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
48106 - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
48107 - TO lag-link( logical-link Uses lag-link, MANY2MANY)
48108 - TO logical-link( logical-link Uses logical-link, ONE2MANY)
48109 - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
48110 - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
48111 - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
48112 - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
48113 - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
48114 - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
48115 - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
48116 - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
48117 - FROM logical-link( logical-link Uses logical-link, ONE2MANY)
48119 -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
48126 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
48129 description: Type of logical link, e.g., evc
48132 description: Captures the numeric part of the speed
48135 description: Captures the units corresponding to the speed
48138 description: v4, v6, or ds for dual stack
48141 description: For example, static or BGP
48144 Collection of logical connections
48149 $ref: "#/patchDefinitions/logical-link"
48152 Collection of metadatum (key/value pairs)
48157 $ref: "#/patchDefinitions/metadatum"
48161 ###### Related Nodes
48162 - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
48163 - TO image( metadatum BelongsTo image, MANY2ONE)(4)
48164 - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
48165 - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
48167 -(4) IF this TO node is deleted, this METADATUM is DELETED also
48178 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
48179 ###### Related Nodes
48180 - TO model( model-ver BelongsTo model, MANY2ONE)(1)
48181 - FROM instance-group( instance-group Targets model, MANY2MANY)
48182 - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
48183 - FROM named-query( named-query AppliesTo model, ONE2MANY)
48184 - FROM named-query-element( named-query-element IsA model, MANY2ONE)
48186 -(1) IF this MODEL node is deleted, this FROM node is DELETED also
48187 -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
48190 - model-invariant-id
48193 model-invariant-id:
48195 description: Unique identifier corresponding to the main definition of a model in ASDC
48198 description: Type of the model, e.g., service, resource, widget, etc.
48199 model-and-named-query-search:
48201 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
48205 $ref: "#/patchDefinitions/query-parameters"
48208 $ref: "#/patchDefinitions/instance-filters"
48211 $ref: "#/patchDefinitions/secondary-filts"
48214 secondary-filter-cut-point:
48218 This is how we would capture constraints defining allowed sets of elements.
48219 ###### Related Nodes
48220 - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
48221 - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
48223 -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
48224 -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
48226 - model-constraint-uuid
48227 - constrained-element-set-uuid-to-replace
48229 model-constraint-uuid:
48231 constrained-element-set-uuid-to-replace:
48233 constrained-element-sets:
48236 $ref: "#/patchDefinitions/constrained-element-set"
48242 $ref: "#/patchDefinitions/model-constraint"
48245 Defines how other models combine to make up a higher-level model.
48246 ###### Related Nodes
48247 - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
48248 - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
48249 - TO model-ver( model-element IsA model-ver, MANY2ONE)
48250 - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
48251 - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
48252 - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
48253 - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
48255 -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
48256 -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
48258 - model-element-uuid
48259 - new-data-del-flag
48262 model-element-uuid:
48266 description: Indicates whether this element was created as part of instantiation from this model
48269 description: How many of this type of element are required/allowed
48277 $ref: "#/patchDefinitions/model-element"
48280 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
48281 ###### Related Nodes
48282 - TO model( model-ver BelongsTo model, MANY2ONE)(4)
48283 - FROM model-element( model-element IsA model-ver, MANY2ONE)
48284 - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
48285 - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
48287 -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
48288 -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
48289 -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
48298 description: Unique identifier corresponding to one version of a model in ASDC
48301 description: Name of the model, which can change from version to version.
48304 description: Version
48307 description: Description
48313 $ref: "#/patchDefinitions/model-ver"
48316 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
48321 $ref: "#/patchDefinitions/model"
48322 multicast-configuration:
48324 ###### Related Nodes
48325 - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
48328 - multicast-configuration-id
48329 - multicast-protocol
48332 multicast-configuration-id:
48334 description: Unique id of multicast configuration.
48335 multicast-protocol:
48337 description: protocol of multicast configuration
48340 description: rp type of multicast configuration
48341 multicast-configurations:
48343 multicast configuration of generic-vnf ip-address
48345 multicast-configuration:
48348 $ref: "#/patchDefinitions/multicast-configuration"
48354 $ref: "#/patchDefinitions/named-query"
48358 ###### Related Nodes
48359 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
48360 - TO model( named-query AppliesTo model, ONE2MANY)
48361 - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
48363 -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
48367 - named-query-version
48373 named-query-version:
48375 required-input-param:
48379 named-query-element:
48382 ###### Related Nodes
48383 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
48384 - TO model( named-query-element IsA model, MANY2ONE)
48385 - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
48386 - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
48387 - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
48388 - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
48390 -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
48391 -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
48393 - named-query-element-uuid
48395 named-query-element-uuid:
48397 property-collect-list:
48399 named-query-elements:
48401 named-query-element:
48404 $ref: "#/patchDefinitions/named-query-element"
48407 Namespace for network inventory resources.
48412 $ref: "#/patchDefinitions/logical-link"
48416 $ref: "#/patchDefinitions/site-pair-set"
48420 $ref: "#/patchDefinitions/vpn-binding"
48424 $ref: "#/patchDefinitions/vpls-pe"
48425 multicast-configurations:
48428 $ref: "#/patchDefinitions/multicast-configuration"
48432 $ref: "#/patchDefinitions/vce"
48436 $ref: "#/patchDefinitions/vnfc"
48440 $ref: "#/patchDefinitions/l3-network"
48444 $ref: "#/patchDefinitions/network-policy"
48448 $ref: "#/patchDefinitions/generic-vnf"
48452 $ref: "#/patchDefinitions/lag-link"
48456 $ref: "#/patchDefinitions/newvce"
48460 $ref: "#/patchDefinitions/pnf"
48464 $ref: "#/patchDefinitions/physical-link"
48465 ipsec-configurations:
48468 $ref: "#/patchDefinitions/ipsec-configuration"
48469 route-table-references:
48472 $ref: "#/patchDefinitions/route-table-reference"
48476 $ref: "#/patchDefinitions/instance-group"
48480 $ref: "#/patchDefinitions/zone"
48486 $ref: "#/patchDefinitions/network-policy"
48489 ###### Related Nodes
48490 - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
48493 - network-policy-id
48497 description: UUID representing unique key to this instance
48498 network-policy-fqdn:
48500 description: Contrail FQDN for the policy
48503 description: ID for the openStack Heat instance
48506 Network profile populated by SDN-GP for SNMP
48507 ###### Related Nodes
48508 - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
48515 description: Unique name of network profile.
48518 description: Encrypted SNMP community string
48521 Collection of network profiles
48526 $ref: "#/patchDefinitions/network-profile"
48529 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
48530 ###### Related Nodes
48531 - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
48533 -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
48541 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
48544 description: Name of VNF.
48547 description: Alternate name of VNF.
48550 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.
48553 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
48556 description: Indicator for whether the resource is considered operational
48559 description: OBSOLETE - do not use
48562 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
48565 description: Client should send valid enumerated value.
48568 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
48573 $ref: "#/patchDefinitions/newvce"
48576 inventory-item-data:
48579 $ref: "#/patchDefinitions/inventory-item-data"
48580 notification-event:
48584 notification-event-header:
48586 $ref: "#/patchDefinitions/notification-event-header"
48587 notification-event-header:
48628 $ref: "#/patchDefinitions/key-data"
48633 OAM network, to be deprecated shortly. Do not use for new purposes.
48634 ###### Related Nodes
48635 - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
48636 - TO complex( oam-network AppliesTo complex, MANY2MANY)
48637 - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
48646 description: UUID of the network. Unique across a cloud-region
48649 description: Name of the network.
48653 description: cvlan-id
48654 ipv4-oam-gateway-address:
48656 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
48657 ipv4-oam-gateway-address-prefix-length:
48660 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
48663 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
48668 $ref: "#/patchDefinitions/oam-network"
48669 operational-environment:
48671 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
48672 ###### Related Nodes
48673 - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
48674 - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
48677 - operational-environment-id
48678 - operational-environment-name
48679 - operational-environment-type
48680 - operational-environment-status
48684 operational-environment-id:
48686 description: UUID of an operational environment
48687 operational-environment-name:
48689 description: Operational Environment name
48690 operational-environment-type:
48692 description: Operational Environment Type.
48693 operational-environment-status:
48695 description: Status
48698 description: Tenant Context.
48701 description: Workload Context.
48702 operational-environments:
48704 a logical partition of the cloud which allows to have multiple environments in the production AIC.
48706 operational-environment:
48709 $ref: "#/patchDefinitions/operational-environment"
48712 Allows for legacy POST of old-style and new-style models
48714 - model-invariant-id
48715 - model-name-version-id
48721 model-invariant-id:
48723 description: Unique identifier corresponding to the main definition of a model in ASDC
48724 model-name-version-id:
48726 description: Unique identifier corresponding to one version of a model in ASDC
48729 description: Type of the model, e.g., service, resource, widget, etc.
48732 description: Name of the model, which can change from version to version.
48735 description: Invariant unique ID which does not change from version to version
48738 description: Version
48741 description: Description
48744 Collection of owning-entities
48749 $ref: "#/patchDefinitions/owning-entity"
48752 describes an owning-entity
48753 ###### Related Nodes
48754 - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
48758 - owning-entity-name
48762 description: UUID of an owning entity
48763 owning-entity-name:
48765 description: Owning entity name
48768 Physical interface (e.g., nic)
48769 ###### Related Nodes
48770 - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
48771 - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
48772 - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
48773 - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
48774 - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
48775 - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
48776 - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
48778 -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
48779 -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
48780 -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
48786 description: Name that identifies the physical interface
48789 description: Captures the numeric part of the speed
48792 description: Captures the units corresponding to the speed
48795 description: Nature of the services and connectivity on this port.
48796 equipment-identifier:
48798 description: CLEI or other specification for p-interface hardware.
48801 description: Role specification for p-interface hardware.
48804 description: Indicates the physical properties of the interface.
48807 description: Trigger for operational monitoring of this resource by Service Assurance systems.
48810 Collection of physical interfaces.
48815 $ref: "#/patchDefinitions/p-interface"
48818 Collection of physical connections, typically between p-interfaces
48819 ###### Related Nodes
48820 - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
48822 -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
48828 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
48831 description: Captures the numeric part of the speed
48834 description: Captures the units corresponding to the speed
48837 description: Circuit it
48840 description: Dual access mode (e.g., primary, secondary
48843 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
48844 service-provider-name:
48846 description: Name of the service Provider on this link.
48849 Collection of physical connections, typically between p-interfaces
48854 $ref: "#/patchDefinitions/physical-link"
48857 describes a platform
48858 ###### Related Nodes
48859 - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
48866 description: Name of the platform
48869 Collection of platforms
48874 $ref: "#/patchDefinitions/platform"
48877 PNF represents a physical network function. typically equipment used in the D1 world.
48878 ###### Related Nodes
48879 - TO complex( pnf LocatedIn complex, MANY2ONE)
48880 - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
48881 - TO zone( pnf LocatedIn zone, MANY2ONE)
48882 - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
48883 - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
48884 - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
48885 - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
48887 -(1) IF this PNF node is deleted, this FROM node is DELETED also
48894 description: unique name of Physical Network Function.
48897 description: name of Physical Network Function.
48900 description: source of name2
48903 description: id of pnf
48906 description: Equipment type. Source of truth should define valid values.
48909 description: Equipment vendor. Source of truth should define valid values.
48912 description: Equipment model. Source of truth should define valid values.
48915 description: identifier of managed by company or customer
48918 description: ipv4-oam-address with new naming convention for IP addresses
48921 description: sw-version is the version of SW for the hosted application on the PNF.
48924 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.
48927 description: ID of the physical frame (relay rack) where pnf is installed.
48930 description: Serial number of the device
48931 ipaddress-v4-loopback-0:
48933 description: IPV4 Loopback 0 address
48934 ipaddress-v6-loopback-0:
48936 description: IPV6 Loopback 0 address
48939 description: IPV4 AIM address
48942 description: IPV6 AIM address
48945 description: IPV6 OAM address
48948 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
48951 Collection of Physical Network Functions.
48956 $ref: "#/patchDefinitions/pnf"
48959 Used to capture the network interfaces of this VCE
48960 ###### Related Nodes
48961 - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
48962 - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
48964 -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
48965 -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
48968 - orchestration-status
48972 description: Unique ID of the interface
48973 neutron-network-id:
48975 description: Neutron network id of this Interface
48976 neutron-network-name:
48978 description: Neutron network name of this Interface
48981 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
48987 $ref: "#/patchDefinitions/port-group"
48990 describes the project
48991 ###### Related Nodes
48992 - TO service-instance( project Uses service-instance, ONE2MANY)
48999 description: Name of the project deploying a service
49002 Collection of projects
49007 $ref: "#/patchDefinitions/project"
49010 Property holder for query properties or instance properties
49016 property-constraint:
49019 ###### Related Nodes
49020 - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
49022 -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
49024 - property-constraint-uuid
49029 property-constraint-uuid:
49037 property-constraints:
49039 property-constraint:
49042 $ref: "#/patchDefinitions/property-constraint"
49045 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
49046 ###### Related Nodes
49047 - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
49048 - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
49049 - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
49050 - TO complex( pserver LocatedIn complex, MANY2ONE)
49051 - TO zone( pserver LocatedIn zone, MANY2ONE)
49052 - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
49053 - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
49054 - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
49055 - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
49056 - FROM vserver( vserver HostedOn pserver, MANY2ONE)
49058 -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
49059 -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
49067 description: Value from executing hostname on the compute node.
49070 description: PTNII name
49074 description: Number of cpus
49078 description: Disk size, in GBs
49082 description: RAM size, in MBs
49085 description: Equipment type. Source of truth should define valid values.
49088 description: Equipment vendor. Source of truth should define valid values.
49091 description: Equipment model. Source of truth should define valid values.
49094 description: Fully-qualified domain name
49097 description: URL to endpoint where AAI can get more details
49100 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
49103 description: Serial number, may be queried
49104 ipaddress-v4-loopback-0:
49106 description: IPV4 Loopback 0 address
49107 ipaddress-v6-loopback-0:
49109 description: IPV6 Loopback 0 address
49112 description: IPV4 AIM address
49115 description: IPV6 AIM address
49118 description: IPV6 OAM address
49121 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
49124 description: ID of Pserver
49127 description: internet topology of Pserver
49130 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.
49133 Collection of compute hosts.
49138 $ref: "#/patchDefinitions/pserver"
49141 QueryParameters for performing a named-query or model query
49145 $ref: "#/patchDefinitions/named-query"
49148 $ref: "#/patchDefinitions/overloaded-model"
49152 ###### Related Nodes
49153 - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
49155 -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
49157 - related-lookup-uuid
49159 - source-node-property
49161 - target-node-property
49163 related-lookup-uuid:
49167 source-node-property:
49171 target-node-property:
49173 property-collect-list:
49180 $ref: "#/patchDefinitions/related-lookup"
49181 related-to-property:
49185 description: Key part of a key/value pair
49188 description: Value part of a key/value pair
49193 description: A keyword provided by A&AI to indicate type of node.
49196 description: URL to the object in A&AI.
49200 $ref: "#/patchDefinitions/relationship-data"
49201 related-to-property:
49204 $ref: "#/patchDefinitions/related-to-property"
49208 - relationship-value
49212 description: A keyword provided by A&AI to indicate an attribute.
49213 relationship-value:
49215 description: Value of the attribute.
49216 reserved-prop-names:
49218 Internal map to define some reserved properties of a vertex
49220 last-mod-source-of-truth:
49238 Response container for the results of a named-query or model query
49240 inventory-response-items:
49242 $ref: "#/patchDefinitions/inventory-response-items"
49247 description: The specific type of node in the A&AI graph
49250 description: The URL to the specific resource
49251 route-table-reference:
49253 Openstack route table reference.
49254 ###### Related Nodes
49255 - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
49258 - route-table-reference-id
49259 - route-table-reference-fqdn
49261 route-table-reference-id:
49263 description: Route Table Reference id, UUID assigned to this instance.
49264 route-table-reference-fqdn:
49266 description: FQDN entry in the route table.
49267 route-table-references:
49269 Collection of openstack route table references
49271 route-table-reference:
49274 $ref: "#/patchDefinitions/route-table-reference"
49277 Route target information
49278 ###### Related Nodes
49279 - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
49281 -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
49283 - global-route-target
49284 - route-target-role
49286 global-route-target:
49288 description: Number used to identify an RT, globally unique in the network
49291 description: Role assigned to this route target
49294 Collection of route target information
49299 $ref: "#/patchDefinitions/route-target"
49302 ###### Related Nodes
49303 - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
49304 - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
49306 -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
49307 -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
49309 - routing-instance-id
49311 routing-instance-id:
49313 description: Unique id of routing instance
49316 description: rpm owner
49319 set of probes related to generic-vnf routing instance
49324 $ref: "#/patchDefinitions/routing-instance"
49329 $ref: "#/patchDefinitions/oam-networks"
49330 az-and-dvs-switches:
49333 $ref: "#/patchDefinitions/az-and-dvs-switches"
49336 edge-tag-query-result:
49338 $ref: "#/patchDefinitions/edge-tag-query-result"
49339 edge-tag-query-request:
49341 $ref: "#/patchDefinitions/edge-tag-query-request"
49344 $ref: "#/patchDefinitions/search-results"
49347 $ref: "#/patchDefinitions/sdn-zone-response"
49353 $ref: "#/patchDefinitions/result-data"
49356 SecondaryFilt for performing a named-query or model query
49367 SecondaryFilts for performing a named-query or model query
49372 $ref: "#/patchDefinitions/secondary-filt"
49373 segmentation-assignment:
49375 Openstack segmentation assignment.
49376 ###### Related Nodes
49377 - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
49379 -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
49385 description: Route Table Reference id, UUID assigned to this instance.
49386 segmentation-assignments:
49388 Collection of openstack segmentation assignments
49390 segmentation-assignment:
49393 $ref: "#/patchDefinitions/segmentation-assignment"
49396 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
49399 - service-description
49403 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
49404 service-description:
49406 description: Description of the service
49409 description: URL to endpoint where AAI can get more details
49410 service-capabilities:
49412 Collection of service capabilities.
49414 service-capability:
49417 $ref: "#/patchDefinitions/service-capability"
49418 service-capability:
49420 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
49421 ###### Related Nodes
49422 - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
49423 - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
49425 -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
49433 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
49436 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.
49437 service-design-and-creation:
49439 Namespace for objects managed by ASDC
49444 $ref: "#/patchDefinitions/vnf-image"
49448 $ref: "#/patchDefinitions/service"
49449 service-capabilities:
49452 $ref: "#/patchDefinitions/service-capability"
49456 $ref: "#/patchDefinitions/model"
49460 $ref: "#/patchDefinitions/named-query"
49463 Instance of a service
49464 ###### Related Nodes
49465 - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
49466 - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
49467 - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
49468 - TO connector( service-instance Uses connector, MANY2MANY)
49469 - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
49470 - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
49471 - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
49472 - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
49473 - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
49474 - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
49475 - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
49476 - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
49477 - TO vce( service-instance ComposedOf vce, ONE2MANY)
49478 - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
49479 - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
49480 - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
49482 -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
49483 -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
49484 -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
49486 - service-instance-id
49488 service-instance-id:
49490 description: Uniquely identifies this instance of a service
49491 service-instance-name:
49493 description: This field will store a name assigned to the service-instance.
49496 description: the ASDC model id for this resource or service model.
49497 persona-model-version:
49499 description: the ASDC model version for this resource or service model.
49502 description: the ASDC model version for this resource or service model.
49505 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
49506 widget-model-version:
49508 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
49511 description: Indicates the total bandwidth to be used for this service.
49514 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
49515 bandwidth-down-wan1:
49517 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
49520 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
49521 bandwidth-down-wan2:
49523 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
49526 description: URL customers will use to access the vHN Portal.
49527 service-instance-location-id:
49529 description: An identifier that customers assign to the location where this service is being used.
49532 Collection of service instances
49537 $ref: "#/patchDefinitions/service-instance"
49538 service-subscription:
49540 Object that group service instances.
49541 ###### Related Nodes
49542 - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
49543 - TO tenant( service-subscription Uses tenant, MANY2MANY)
49544 - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
49546 -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
49547 -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
49553 description: Value defined by orchestration to identify this service across ECOMP.
49554 temp-ub-sub-account-id:
49556 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
49557 service-subscriptions:
49559 Collection of objects that group service instances.
49561 service-subscription:
49564 $ref: "#/patchDefinitions/service-subscription"
49567 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
49572 $ref: "#/patchDefinitions/service"
49575 ###### Related Nodes
49576 - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
49577 - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
49579 -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
49580 -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
49586 description: unique identifier of probe
49589 description: Prefix address
49592 description: Prefix address
49595 description: ip version, v4, v6
49596 destination-hostname:
49598 description: Hostname of the destination equipment to which SLAs are measured against.
49599 destination-equip-type:
49601 description: The type of destinatination equipment. Could be Router, etc.
49604 Set of instances for probes used to measure service level agreements
49605 ###### Related Nodes
49606 - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
49607 - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
49609 -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
49615 description: Unique id of site pair set.
49618 Collection of sets of instances for probes related to generic-vnf
49623 $ref: "#/patchDefinitions/site-pair-set"
49631 $ref: "#/patchDefinitions/site-pair"
49635 ###### Related Nodes
49636 - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
49637 - FROM vserver( vserver Uses snapshot, ONE2ONE)
49644 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
49647 description: Snapshot name
49648 snapshot-architecture:
49650 description: Operating system architecture
49651 snapshot-os-distro:
49653 description: The common name of the operating system distribution in lowercase
49654 snapshot-os-version:
49656 description: The operating system version as specified by the distributor.
49659 description: The application that the image instantiates.
49660 application-vendor:
49662 description: The vendor of the application.
49663 application-version:
49665 description: The version of the application.
49668 description: URL to endpoint where AAI can get more details
49671 description: This field contains the UUID of the previous snapshot (if any).
49674 Collection of openstack snapshots
49679 $ref: "#/patchDefinitions/snapshot"
49682 SR-IOV Physical Function
49683 ###### Related Nodes
49684 - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
49685 - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
49687 -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
49693 description: Identifier for the sriov-pf
49696 Collection of SR-IOV Physical Functions.
49701 $ref: "#/patchDefinitions/sriov-pf"
49704 SR-IOV Virtual Function (not to be confused with virtual network function)
49705 ###### Related Nodes
49706 - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
49708 -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
49714 description: PCI ID used to identify the sriov-vf
49717 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
49720 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
49723 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
49724 vf-vlan-anti-spoof-check:
49726 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.
49727 vf-mac-anti-spoof-check:
49729 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.
49732 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
49733 vf-broadcast-allow:
49735 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
49736 vf-unknown-multicast-allow:
49738 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
49739 vf-unknown-unicast-allow:
49741 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
49744 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
49747 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
49750 Collection of SR-IOV Virtual Functions.
49755 $ref: "#/patchDefinitions/sriov-vf"
49764 ###### Related Nodes
49765 - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
49766 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
49767 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
49769 -(4) IF this TO node is deleted, this SUBNET is DELETED also
49770 -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
49778 description: Subnet ID, should be UUID.
49781 description: Name associated with the subnet.
49784 description: Neutron id of this subnet
49787 description: gateway ip address
49788 network-start-address:
49790 description: network start address
49793 description: cidr mask
49796 description: ip version
49797 orchestration-status:
49799 description: Orchestration status of this VNF, mastered by MSO
49802 description: dhcp enabled
49805 description: the start address reserved for use by dhcp
49808 description: the last address reserved for use by dhcp
49814 $ref: "#/patchDefinitions/subnet"
49815 tagged-inventory-item-list:
49820 $ref: "#/patchDefinitions/inventory-item"
49824 ###### Related Nodes
49825 - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
49826 - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
49827 - TO l3-network( tenant Uses l3-network, MANY2MANY)
49828 - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
49829 - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
49830 - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
49832 -TENANT cannot be deleted if related to VSERVER
49840 description: Unique id relative to the cloud-region.
49843 description: Readable name of tenant
49846 Collection of openstack tenants.
49851 $ref: "#/patchDefinitions/tenant"
49854 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
49855 ###### Related Nodes
49856 - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
49858 -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
49861 - bandwidth-up-wan1
49862 - bandwidth-down-wan1
49863 - bandwidth-up-wan2
49864 - bandwidth-down-wan2
49868 description: Allotted Resource id UUID assigned to this instance.
49871 description: The WAN uplink bandwidth for WAN1
49872 bandwidth-down-wan1:
49874 description: The WAN downlink bandwidth for WAN1
49877 description: The WAN uplink bandwidth for WAN2
49878 bandwidth-down-wan2:
49880 description: The WAN downlink bandwidth for WAN2
49883 This object is used to store the specific tunnel cross connect aspects of an allotted resource
49888 $ref: "#/patchDefinitions/tunnel-xconnect"
49891 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
49900 $ref: "#/patchDefinitions/update-node-key"
49906 $ref: "#/patchDefinitions/action"
49915 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
49916 ###### Related Nodes
49917 - TO availability-zone( vce Uses availability-zone, MANY2MANY)
49918 - TO complex( vce LocatedIn complex, MANY2MANY)
49919 - TO vserver( vce HostedOn vserver, ONE2MANY)
49920 - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
49921 - FROM license( license BelongsTo vce, MANY2ONE)(1)
49922 - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
49923 - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
49925 -(1) IF this VCE node is deleted, this FROM node is DELETED also
49933 description: Unique id of VNF. This is unique across the graph.
49936 description: Name of VNF.
49939 description: Alternate name of VNF.
49942 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.
49945 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
49946 regional-resource-zone:
49948 description: Regional way of organizing pservers, source of truth should define values
49951 description: Trigger for operational monitoring of this resource by Service Assurance systems.
49954 description: Indicator for whether the resource is considered operational
49957 description: OBSOLETE - do not use
49960 description: Network role being played by this VNF
49961 orchestration-status:
49963 description: Orchestration status of this VNF, mastered by MSO
49966 description: Heat stack id corresponding to this instance, managed by MSO
49969 description: Corresponds to the SDN-C catalog id used to configure this VCE
49972 description: Unique ID of VPE connected to this VCE.
49973 v6-vce-wan-address:
49975 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
49978 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
49981 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
49986 $ref: "#/patchDefinitions/vce"
49989 a deployment unit of VNFCs
49990 ###### Related Nodes
49991 - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
49992 - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
49993 - TO vnfc( vf-module Uses vnfc, ONE2MANY)
49994 - TO volume-group( vf-module Uses volume-group, ONE2ONE)
49995 - TO vserver( vf-module Uses vserver, ONE2MANY)
49997 -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
49998 -VF-MODULE cannot be deleted if related to VNFC
50002 - is-base-vf-module
50006 description: Unique ID of vf-module.
50009 description: Name of vf-module
50012 description: Heat stack id corresponding to this instance.
50013 orchestration-status:
50015 description: orchestration status of this vf-module, mastered by MSO
50018 description: used to indicate whether or not this object is base vf module
50021 Collection of vf-modules, a deployment unit of VNFCs
50026 $ref: "#/patchDefinitions/vf-module"
50029 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
50030 ###### Related Nodes
50031 - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
50033 -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
50039 description: indicates whether the VIG is for AVPN or INTERNET
50042 description: v4 IP of the vig server
50045 description: v6 IP of the vig server
50051 $ref: "#/patchDefinitions/vig-server"
50052 vip-ipv4-address-list:
50055 ###### Related Nodes
50056 - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
50057 - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
50058 - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
50059 - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
50066 description: IP address
50067 vip-ipv4-prefix-length:
50070 description: Prefix length, 32 for single address
50074 description: Inner VLAN tag
50078 description: Outer VLAN tag
50081 description: Indicator of fixed or floating address
50082 vip-ipv6-address-list:
50085 ###### Related Nodes
50086 - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
50087 - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
50088 - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
50089 - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
50096 description: IP address
50097 vip-ipv6-prefix-length:
50100 description: Prefix length, 128 for single address
50104 description: Inner VLAN tag
50108 description: Outer VLAN tag
50111 description: Indicator of fixed or floating address
50112 virtual-data-center:
50114 Virtual organization of cloud infrastructure elements in a data center context
50115 ###### Related Nodes
50116 - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
50117 - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
50118 - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
50126 description: Unique ID of the vdc
50129 description: Name of the virtual data center
50130 virtual-data-centers:
50132 Virtual organization of cloud infrastructure elements in a data center context
50134 virtual-data-center:
50137 $ref: "#/patchDefinitions/virtual-data-center"
50141 ###### Related Nodes
50142 - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
50143 - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
50144 - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
50145 - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
50146 - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
50147 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
50148 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
50150 -(1) IF this VLAN node is deleted, this FROM node is DELETED also
50151 -(2) IF this VLAN node is deleted, this TO node is DELETED also
50152 -(4) IF this TO node is deleted, this VLAN is DELETED also
50158 description: String that identifies the interface
50162 description: Inner VLAN tag
50166 description: Outer VLAN tag
50172 $ref: "#/patchDefinitions/vlan"
50181 description: Unique id of VNF. This is unique across the graph.
50184 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
50185 ###### Related Nodes
50186 - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
50188 -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
50193 - application-vendor
50197 description: Unique ID of this asset
50200 description: The application that the image instantiates.
50201 application-vendor:
50203 description: The vendor of the application.
50204 application-version:
50206 description: The version of the application.
50209 description: URL to endpoint where AAI can get more details
50212 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
50217 $ref: "#/patchDefinitions/vnf-image"
50220 ###### Related Nodes
50221 - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
50222 - TO vserver( vnfc HostedOn vserver, ONE2MANY)
50223 - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
50225 -(4) IF this TO node is deleted, this VNFC is DELETED also
50228 - vnfc-function-code
50231 - is-closed-loop-disabled
50235 description: Unique ID of vnfc.
50236 vnfc-function-code:
50238 description: function code
50244 description: prov status of this vnfc
50245 orchestration-status:
50247 description: Orchestration status of this VNF, mastered by APP-C
50248 ipaddress-v4-oam-vip:
50250 description: Oam V4 vip address of this vnfc
50253 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
50254 is-closed-loop-disabled:
50256 description: used to indicate whether closed loop function is enabled on this node
50259 description: Group notation of VNFC
50262 virtual network components associated with a vserver from application controller.
50267 $ref: "#/patchDefinitions/vnfc"
50270 Ephemeral Block storage volume.
50271 ###### Related Nodes
50272 - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
50274 -(3) IF this FROM node is deleted, this VOLUME is DELETED also
50281 description: Unique ID of block storage volume relative to the vserver.
50284 description: URL to endpoint where AAI can get more details
50287 Persistent block-level storage.
50288 ###### Related Nodes
50289 - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
50290 - TO complex( volume-group LocatedIn complex, MANY2ONE)
50291 - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
50292 - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
50293 - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
50297 - volume-group-name
50302 description: Unique ID of volume-group.
50305 description: Name of the volume group.
50308 description: Heat stack id corresponding to this volume-group
50311 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.
50312 orchestration-status:
50314 description: Orchestration status of this volume-group
50315 persona-model-customization-id:
50317 description: captures the id of all the configuration used to customize the resource for the service.
50318 vf-module-persona-model-customization-id:
50320 description: helps relate the volume group to the vf-module whose components will require the volume group
50323 Collection of persistent block-level storage.
50328 $ref: "#/patchDefinitions/volume-group"
50331 Collection of ephemeral Block storage volumes.
50336 $ref: "#/patchDefinitions/volume"
50339 VPLS Provider Edge routers.
50340 ###### Related Nodes
50341 - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
50342 - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
50343 - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
50344 - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
50346 -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
50354 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
50357 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
50360 description: Client should send valid enumerated value, e.g., VPLS-PE.
50364 description: Temporary location for stag to get to VCE
50367 Collection of VPLS Provider Edge routers
50372 $ref: "#/patchDefinitions/vpls-pe"
50376 ###### Related Nodes
50377 - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
50378 - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
50380 -VPN-BINDING cannot be deleted if related to L3-NETWORK,LOGICAL-LINK
50385 - global-route-target
50386 - route-target-role
50390 description: VPN ID, globally unique within A&AI
50393 description: VPN Name
50394 global-route-target:
50396 description: Number used to identify a VPN, globally unique in the network
50399 description: the platform associated with the VPN example AVPN, Mobility
50402 description: Type of the vpn, should be taken from enumerated/valid values
50403 route-distinguisher:
50405 description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
50408 description: Role assigned to this route target
50414 $ref: "#/patchDefinitions/vpn-binding"
50417 Virtual Servers, aka virtual machine or VM.
50418 ###### Related Nodes
50419 - TO tenant( vserver BelongsTo tenant, MANY2ONE)
50420 - TO flavor( vserver Uses flavor, MANY2ONE)
50421 - TO image( vserver Uses image, MANY2ONE)
50422 - TO pserver( vserver HostedOn pserver, MANY2ONE)
50423 - TO snapshot( vserver Uses snapshot, ONE2ONE)
50424 - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
50425 - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
50426 - FROM vce( vce HostedOn vserver, ONE2MANY)
50427 - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
50428 - FROM vf-module( vf-module Uses vserver, ONE2MANY)
50429 - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
50431 -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
50432 -(2) IF this VSERVER node is deleted, this TO node is DELETED also
50438 - is-closed-loop-disabled
50442 description: Unique identifier for this vserver relative to its tenant
50445 description: Name of vserver
50448 description: Alternative name of vserver
50451 description: Trigger for operational monitoring of this resource by Service Assurance systems.
50454 description: URL to endpoint where AAI can get more details
50457 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.
50458 is-closed-loop-disabled:
50460 description: Used to indicate whether closed loop function is enabled on this node
50463 Collection of virtual Servers, aka virtual machines or VMs.
50468 $ref: "#/patchDefinitions/vserver"
50471 A zone is a grouping of assets in a location homing to the same connections into the CBB
50472 ###### Related Nodes
50473 - TO complex( zone LocatedIn complex, MANY2ONE)
50474 - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
50475 - FROM pnf( pnf LocatedIn zone, MANY2ONE)
50476 - FROM pserver( pserver LocatedIn zone, MANY2ONE)
50486 description: Code assigned by AIC to the zone
50489 description: English name associated with the zone
50492 description: Design of zone [Medium/Large?]
50495 description: Context of zone [production/test]
50498 description: Status of a zone.
50501 Collection of zones
50506 $ref: "#/patchDefinitions/zone"
50515 $ref: "#/getDefinitions/action-data"
50524 APIs that are more action related than REST (e.g., notify, update).
50528 $ref: "#/getDefinitions/update"
50531 $ref: "#/getDefinitions/notify"
50534 Represents a slice or partial piece of a resource that gets separately allotted
50535 ###### Related Nodes
50536 - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
50537 - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
50538 - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
50539 - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
50540 - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
50541 - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
50542 - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
50544 -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
50545 -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
50551 description: Allotted Resource id UUID assigned to this instance.
50554 description: The descriptive information assigned to this allotted resource instance
50557 description: Link back to more information in the controller
50560 description: the ASDC model id for this resource or service model.
50561 persona-model-version:
50563 description: the ASDC model version for this resource or service model.
50566 description: the ASDC model version for this resource or service model.
50567 persona-model-customization-id:
50569 description: captures the id of all the configuration used to customize the resource for the service.
50572 description: Concurrency value
50576 $ref: "#/getDefinitions/tunnel-xconnect"
50580 $ref: "#/getDefinitions/relationship"
50581 allotted-resources:
50583 This object is used to store slices of services being offered
50588 $ref: "#/getDefinitions/allotted-resource"
50591 Availability zone, a collection of compute hosts/pservers
50592 ###### Related Nodes
50593 - TO complex( availability-zone LocatedIn complex, MANY2ONE)
50594 - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
50595 - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
50596 - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
50597 - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
50598 - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
50599 - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
50600 - FROM vce( vce Uses availability-zone, MANY2MANY)
50602 -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
50603 -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
50606 - availability-zone-name
50609 availability-zone-name:
50611 description: Name of the availability zone. Unique across a cloud region
50614 description: Type of hypervisor. Source of truth should define valid values.
50617 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
50620 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50624 $ref: "#/getDefinitions/relationship"
50625 availability-zones:
50627 Collection of availability zones
50632 $ref: "#/getDefinitions/availability-zone"
50633 az-and-dvs-switches:
50637 $ref: "#/getDefinitions/dvs-switches"
50640 $ref: "#/getDefinitions/availability-zone"
50643 Namespace for business related constructs
50648 $ref: "#/getDefinitions/connector"
50652 $ref: "#/getDefinitions/customer"
50655 ###### Related Nodes
50656 - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
50658 -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
50664 description: unique identifier of probe
50667 description: identifier of probe
50670 description: type of probe
50673 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50677 $ref: "#/getDefinitions/relationship"
50678 classes-of-service:
50680 class-of-service of probe
50685 $ref: "#/getDefinitions/class-of-service"
50686 cloud-infrastructure:
50688 Namespace for cloud infrastructure.
50693 $ref: "#/getDefinitions/complex"
50697 $ref: "#/getDefinitions/cloud-region"
50701 $ref: "#/getDefinitions/network-profile"
50705 $ref: "#/getDefinitions/pserver"
50706 virtual-data-centers:
50709 $ref: "#/getDefinitions/virtual-data-center"
50712 cloud-region designates an installation of a cloud cluster or region or instantiation.
50713 ###### Related Nodes
50714 - TO complex( cloud-region LocatedIn complex, MANY2ONE)
50715 - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
50716 - TO zone( cloud-region LocatedIn zone, MANY2ONE)
50717 - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
50718 - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
50719 - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
50720 - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
50721 - FROM image( image BelongsTo cloud-region, MANY2ONE)
50722 - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
50723 - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
50724 - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
50725 - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
50726 - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
50727 - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
50729 -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
50730 -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
50738 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
50741 description: Identifier used by the vendor for the region. Second part of composite key
50744 description: Type of the cloud (e.g., openstack)
50745 owner-defined-type:
50747 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
50748 cloud-region-version:
50750 description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
50753 description: URL of the keystone identity service
50756 description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
50759 description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
50762 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50766 $ref: "#/getDefinitions/volume-group"
50770 $ref: "#/getDefinitions/tenant"
50774 $ref: "#/getDefinitions/flavor"
50778 $ref: "#/getDefinitions/group-assignment"
50782 $ref: "#/getDefinitions/snapshot"
50786 $ref: "#/getDefinitions/image"
50790 $ref: "#/getDefinitions/dvs-switch"
50794 $ref: "#/getDefinitions/oam-network"
50795 availability-zones:
50798 $ref: "#/getDefinitions/availability-zone"
50802 $ref: "#/getDefinitions/relationship"
50808 $ref: "#/getDefinitions/cloud-region"
50811 Collection of physical locations that can house cloud-regions.
50812 ###### Related Nodes
50813 - TO l3-network( complex Uses l3-network, MANY2MANY)
50814 - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
50815 - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
50816 - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
50817 - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
50818 - FROM pnf( pnf LocatedIn complex, MANY2ONE)
50819 - FROM pserver( pserver LocatedIn complex, MANY2ONE)
50820 - FROM vce( vce LocatedIn complex, MANY2MANY)
50821 - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
50822 - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
50823 - FROM zone( zone LocatedIn complex, MANY2ONE)
50825 -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
50826 -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
50829 - physical-location-id
50830 - physical-location-type
50837 physical-location-id:
50839 description: Unique identifier for physical location, e.g., CLLI
50842 description: Data center code which can be an alternate way to identify a complex
50845 description: Gamma complex name for LCP instance.
50848 description: URL of the keystone identity service
50851 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50852 physical-location-type:
50854 description: Type, e.g., central office, data center.
50880 $ref: "#/getDefinitions/ctag-pool"
50884 $ref: "#/getDefinitions/relationship"
50887 Collection of physical locations that can house cloud-regions.
50892 $ref: "#/getDefinitions/complex"
50895 Port Mirror Configuration.
50896 ###### Related Nodes
50897 - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
50898 - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
50899 - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
50900 - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
50901 - FROM service-instance( service-instance Uses configuration, ONE2MANY)
50903 -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
50904 -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
50905 -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
50908 - configuration-type
50909 - configuration-sub-type
50910 - orchestration-status
50911 - operational-status
50912 - configuration-selflink
50913 - model-customization-id
50917 description: UUID assigned to configuration.
50920 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
50921 configuration-name:
50923 description: Name of the configuration.
50924 configuration-type:
50926 description: port-mirroring-configuration.
50927 configuration-sub-type:
50929 description: vprobe, pprobe.
50930 model-invariant-id:
50932 description: the ASDC model id for this resource or service model.
50935 description: the ASDC model version for this resource or service model.
50936 orchestration-status:
50938 description: Orchestration status of the configuration.
50939 operational-status:
50941 description: Indicator for whether the resource is considered operational.
50942 configuration-selflink:
50944 description: URL to endpoint where AAI can get more details from SDN-GC.
50945 model-customization-id:
50947 description: id of the configuration used to customize the resource
50950 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50954 $ref: "#/getDefinitions/relationship"
50958 $ref: "#/getDefinitions/metadatum"
50961 Collection of configurations
50966 $ref: "#/getDefinitions/configuration"
50969 Collection of resource instances used to connect a variety of disparate inventory widgets
50970 ###### Related Nodes
50971 - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
50972 - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
50973 - FROM service-instance( service-instance Uses connector, MANY2MANY)
50975 -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
50977 - resource-instance-id
50979 resource-instance-id:
50981 description: Unique id of resource instance.
50984 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50987 description: the ASDC model id for this resource or service model.
50988 persona-model-version:
50990 description: the ASDC model version for this resource or service model.
50993 description: the ASDC model version for this resource or service model.
50996 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
50997 widget-model-version:
50999 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
51003 $ref: "#/getDefinitions/relationship"
51007 $ref: "#/getDefinitions/metadatum"
51010 Collection of resource instances used to connect a variety of disparate inventory widgets
51015 $ref: "#/getDefinitions/connector"
51016 constrained-element-set:
51018 This is how we would capture constraints defining allowed sets of elements.
51019 ###### Related Nodes
51020 - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
51021 - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
51022 - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
51024 -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
51025 -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
51027 - constrained-element-set-uuid
51031 constrained-element-set-uuid:
51039 element-choice-sets:
51042 $ref: "#/getDefinitions/element-choice-set"
51046 $ref: "#/getDefinitions/relationship"
51047 constrained-element-sets:
51049 constrained-element-set:
51052 $ref: "#/getDefinitions/constrained-element-set"
51055 ###### Related Nodes
51056 - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
51057 - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
51059 -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
51069 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51073 $ref: "#/getDefinitions/relationship"
51079 $ref: "#/getDefinitions/ctag-assignment"
51082 A collection of C tags (vlan tags) grouped for a specific purpose.
51083 ###### Related Nodes
51084 - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
51085 - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
51086 - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
51088 -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
51091 - availability-zone-name
51092 - ctag-pool-purpose
51096 description: The Target provider edge router
51097 availability-zone-name:
51099 description: Name of the availability zone
51102 description: Describes what the intended purpose of this pool is.
51105 description: Comma separated list of ctags
51108 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51112 $ref: "#/getDefinitions/relationship"
51118 $ref: "#/getDefinitions/ctag-pool"
51121 customer identifiers to provide linkage back to BSS information.
51122 ###### Related Nodes
51123 - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
51125 -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
51127 - global-customer-id
51131 global-customer-id:
51133 description: Global customer id used across ECOMP to uniquely identify customer.
51136 description: Subscriber name, an alternate way to retrieve a customer.
51139 description: Subscriber type, a way to provide VID with only the INFRA customers.
51142 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51143 service-subscriptions:
51146 $ref: "#/getDefinitions/service-subscription"
51150 $ref: "#/getDefinitions/relationship"
51153 Collection of customer identifiers to provide linkage back to BSS information.
51158 $ref: "#/getDefinitions/customer"
51166 description: See mis-na-virtualization-platform.yang
51169 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51173 $ref: "#/getDefinitions/relationship"
51179 $ref: "#/getDefinitions/cvlan-tag-entry"
51182 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.
51183 ###### Related Nodes
51184 - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
51185 - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
51193 description: DVS switch name
51196 description: URL used to reach the vcenter
51199 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51203 $ref: "#/getDefinitions/relationship"
51206 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
51211 $ref: "#/getDefinitions/dvs-switch"
51214 Internal map to define the properties of an edge and interpret the map EdgeRules
51232 edge-tag-query-request:
51243 $ref: "#/getDefinitions/start-node-filter"
51244 include-node-filter:
51247 $ref: "#/getDefinitions/include-node-filter"
51251 $ref: "#/getDefinitions/secondary-filter"
51252 edge-tag-query-result:
51254 tagged-inventory-item-list:
51257 $ref: "#/getDefinitions/tagged-inventory-item-list"
51258 element-choice-set:
51260 This is how we would capture constraints defining allowed sets of elements.
51261 ###### Related Nodes
51262 - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
51263 - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
51265 -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
51266 -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
51268 - element-choice-set-uuid
51269 - element-choice-set-name
51271 element-choice-set-uuid:
51273 element-choice-set-name:
51282 $ref: "#/getDefinitions/model-element"
51286 $ref: "#/getDefinitions/relationship"
51287 element-choice-sets:
51289 element-choice-set:
51292 $ref: "#/getDefinitions/element-choice-set"
51295 Metadata for entitlement group.
51296 ###### Related Nodes
51297 - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
51298 - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
51300 -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
51307 description: Unique ID for the entitlement group the resource comes from, should be uuid.
51310 description: Unique ID of an entitlement resource.
51313 description: Concurrency value
51317 $ref: "#/getDefinitions/relationship"
51320 Entitlements, keyed by group-uuid and resource-uuid, related to license management
51325 $ref: "#/getDefinitions/entitlement"
51328 Persist EMS address information used by EMS driver.
51329 ###### Related Nodes
51330 - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
51332 -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
51338 description: Unique ID of EMS.
51341 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51342 esr-system-info-list:
51344 $ref: "#/getDefinitions/esr-system-info-list"
51347 $ref: "#/getDefinitions/relationship-list"
51353 $ref: "#/getDefinitions/esr-ems"
51356 Persist common address information of external systems.
51357 ###### Related Nodes
51358 - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
51359 - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
51360 - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
51361 - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
51363 -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
51365 - esr-system-info-id
51370 esr-system-info-id:
51372 description: Unique ID of esr system info.
51375 description: name of external system.
51378 description: type of external systems.
51381 description: vendor of external systems.
51384 description: version of external systems.
51387 description: url used to access external systems.
51390 description: username used to access external systems.
51393 description: password used to access external systems.
51396 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
51399 description: protocol of third party SDNC, for example netconf/snmp.
51402 description: ca file content if enabled ssl on auth-url.
51405 description: Whether to verify VIM's certificate.
51408 description: service IP of ftp server.
51411 description: service port of ftp server.
51414 description: domain info for authentication.
51417 description: default tenant of VIM.
51420 description: ftp passive mode or not.
51423 description: resource or performance data file path.
51426 description: the status of external system.
51429 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51433 $ref: "#/getDefinitions/relationship"
51434 esr-system-info-list:
51436 Collection of persistent block-level external system auth info.
51441 $ref: "#/getDefinitions/esr-system-info"
51442 esr-thirdparty-sdnc:
51444 Persist SDNC address information used by ONAP SDNC.
51445 ###### Related Nodes
51446 - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
51447 - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
51449 -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
51451 - thirdparty-sdnc-id
51453 thirdparty-sdnc-id:
51455 description: Unique ID of SDNC.
51458 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
51461 description: password used to access SDNC server.
51464 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51465 esr-system-info-list:
51467 $ref: "#/getDefinitions/esr-system-info-list"
51470 $ref: "#/getDefinitions/relationship-list"
51471 esr-thirdparty-sdnc-list:
51473 esr-thirdparty-sdnc:
51476 $ref: "#/getDefinitions/esr-thirdparty-sdnc"
51479 Persist VNFM address information used by VF-C.
51480 ###### Related Nodes
51481 - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
51483 -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
51489 description: Unique ID of VNFM.
51492 description: indecate the VIM to deploy VNF.
51495 description: certificate url of VNFM.
51498 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51499 esr-system-info-list:
51501 $ref: "#/getDefinitions/esr-system-info-list"
51504 $ref: "#/getDefinitions/relationship-list"
51510 $ref: "#/getDefinitions/esr-vnfm"
51513 evc object is an optional child object of the Configuration object.
51514 ###### Related Nodes
51515 - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
51517 -(4) IF this TO node is deleted, this EVC is DELETED also
51523 description: Unique/key field for the evc object
51524 forwarding-path-topology:
51526 description: Point-to-Point, Multi-Point
51529 description: Commited Information Rate
51532 description: CIR units
51533 connection-diversity-group-id:
51535 description: Diversity Group ID
51538 description: formerly Performance Group
51539 esp-evc-circuit-id:
51541 description: EVC Circuit ID of ESP EVC
51544 description: Committed Information Rate (For ESP)
51547 description: CIR units (For ESP)
51550 description: Identifies ESP
51551 collector-pop-clli:
51553 description: Collector POP CLLI (from the hostname of the access pnf)
51554 inter-connect-type-ingress:
51556 description: Interconnect type on ingress side of EVC.
51557 tagmode-access-ingress:
51559 description: tagode for collector side of EVC
51560 tagmode-access-egress:
51562 description: tagMode for network side of EVC
51566 $ref: "#/getDefinitions/relationship"
51569 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51575 $ref: "#/getDefinitions/evc"
51578 Namespace for external system.
51582 $ref: "#/getDefinitions/esr-ems-list"
51585 $ref: "#/getDefinitions/esr-vnfm-list"
51586 esr-thirdparty-sdnc-list:
51588 $ref: "#/getDefinitions/esr-thirdparty-sdnc-list"
51591 Extra properties for inventory item for response list
51599 ###### Related Nodes
51600 - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
51601 - FROM vserver( vserver Uses flavor, MANY2ONE)
51603 -FLAVOR cannot be deleted if related to VSERVER
51612 description: Flavor id, expected to be unique across cloud-region.
51615 description: Flavor name
51619 description: Number of CPUs
51623 description: Amount of memory
51627 description: Disk space
51631 description: Amount of ephemeral disk space
51634 description: amount of swap space allocation
51637 description: whether flavor is available to all users or private to the tenant it was created in.
51640 description: URL to endpoint where AAI can get more details
51643 description: Boolean as to whether this flavor is no longer enabled
51646 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51650 $ref: "#/getDefinitions/relationship"
51653 Collection of openstack flavors.
51658 $ref: "#/getDefinitions/flavor"
51661 Entity describing a sequenced segment of forwarding path
51662 ###### Related Nodes
51663 - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
51664 - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
51665 - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
51666 - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
51667 - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
51669 -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
51670 -(4) IF this TO node is deleted, this FORWARDER is DELETED also
51677 description: Unique ID of this segmentation
51680 description: ingress, intermediate, egress
51684 $ref: "#/getDefinitions/relationship"
51687 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51690 forwarder object is an optional child object of the Configuration object.
51691 ###### Related Nodes
51692 - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
51694 -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
51700 description: Key for forwarder-evc object
51703 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
51706 description: Internal VLAN.
51709 description: SVLAN value for ingress of egress forwarder.
51712 description: CVLAN value for ingress of egress forwarder.
51716 $ref: "#/getDefinitions/relationship"
51719 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51725 $ref: "#/getDefinitions/forwarder-evc"
51731 $ref: "#/getDefinitions/forwarder"
51734 Entity that describes the sequenced forwarding path between interfaces of services or resources
51735 ###### Related Nodes
51736 - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
51737 - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
51738 - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
51740 -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
51741 -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
51742 -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
51744 - forwarding-path-id
51745 - forwarding-path-name
51747 forwarding-path-id:
51749 description: Unique ID of this FP
51750 forwarding-path-name:
51752 description: Name of the FP
51756 $ref: "#/getDefinitions/relationship"
51759 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51762 description: the self link for this FP
51766 $ref: "#/getDefinitions/forwarder"
51772 $ref: "#/getDefinitions/forwarding-path"
51775 General purpose VNF
51776 ###### Related Nodes
51777 - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
51778 - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
51779 - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
51780 - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
51781 - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
51782 - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
51783 - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
51784 - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
51785 - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
51786 - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
51787 - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
51788 - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
51789 - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
51790 - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
51791 - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
51792 - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
51793 - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
51794 - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
51795 - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
51796 - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
51797 - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
51799 -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
51805 - is-closed-loop-disabled
51809 description: Unique id of VNF. This is unique across the graph.
51812 description: Name of VNF.
51815 description: Alternate name of VNF.
51818 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.
51821 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
51822 regional-resource-zone:
51824 description: Regional way of organizing pservers, source of truth should define values
51827 description: Trigger for operational monitoring of this resource by Service Assurance systems.
51830 description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
51833 description: OBSOLETE - do not use
51836 description: Client should send valid enumerated value
51837 orchestration-status:
51839 description: Orchestration status of this VNF, used by MSO.
51842 description: Heat stack id corresponding to this instance, managed by MSO
51845 description: Corresponds to the SDN-C catalog id used to configure this VCE
51848 description: identifier of managed by company or customer
51851 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
51852 ipv4-loopback0-address:
51854 description: v4 Loopback0 address
51857 description: v6 Loopback address
51858 management-v6-address:
51860 description: v6 management address
51864 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
51867 description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only in some usecases
51871 description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
51874 description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only in some usecases
51878 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
51881 description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases
51884 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.
51885 is-closed-loop-disabled:
51887 description: used to indicate whether closed loop function is enabled on this node
51890 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51893 description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
51894 encrypted-access-flag:
51896 description: indicates whether generic-vnf access uses SSH
51899 description: the ASDC model id for this resource or service model.
51900 persona-model-version:
51902 description: the ASDC model version for this resource or service model.
51905 description: the ASDC model version for this resource or service model.
51906 persona-model-customization-id:
51908 description: captures the id of all the configuration used to customize the resource for the service.
51911 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
51912 widget-model-version:
51914 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
51917 description: as-number of the VNF
51918 regional-resource-subzone:
51920 description: represents sub zone of the rr plane
51923 description: Path to the controller object.
51927 $ref: "#/getDefinitions/relationship"
51931 $ref: "#/getDefinitions/l-interface"
51935 $ref: "#/getDefinitions/lag-interface"
51939 $ref: "#/getDefinitions/vf-module"
51943 $ref: "#/getDefinitions/license"
51947 $ref: "#/getDefinitions/entitlement"
51955 $ref: "#/getDefinitions/generic-vnf"
51958 Openstack group-assignment used to store exclusivity groups (EG).
51959 ###### Related Nodes
51960 - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
51961 - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
51962 - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
51971 description: Group id, expected to be unique across cloud-region.
51974 description: Group type - the type of group this instance refers to
51977 description: Group name - name assigned to the group
51980 description: Group description - description of the group
51983 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51987 $ref: "#/getDefinitions/relationship"
51990 Collection of openstack group assignments
51995 $ref: "#/getDefinitions/group-assignment"
51998 ###### Related Nodes
51999 - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
52001 -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
52009 description: host-route id
52012 description: subnet prefix
52015 description: Could be ip-address, hostname, or service-instance
52018 description: Should be ip-address, hostname, or service-instance to match next-hop
52021 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52025 $ref: "#/getDefinitions/relationship"
52031 $ref: "#/getDefinitions/host-route"
52034 Collection of HPA Capabilities
52039 $ref: "#/getDefinitions/hpa-capability"
52042 Represents a HPA capability
52043 ###### Related Nodes
52044 - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
52045 - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
52046 - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
52048 -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
52050 - hpa-capability-id
52055 description: UUID to uniquely identify a HPA capability
52058 description: Name of the HPACapability
52061 description: HPA schema version
52064 description: Hardware architecture
52067 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52071 $ref: "#/getDefinitions/relationship"
52072 hpa-feature-attributes:
52075 $ref: "#/getDefinitions/hpa-feature-attributes"
52076 hpa-feature-attributes:
52078 HPA Capability Feature attributes
52079 ###### Related Nodes
52080 - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
52082 -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
52084 - hpa-attribute-key
52088 description: name of the specific HPA attribute
52089 hpa-attribute-value:
52091 description: JSON string specifying the value, unit and type of the specific HPA attribute
52094 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52098 $ref: "#/getDefinitions/relationship"
52102 ###### Related Nodes
52103 - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
52104 - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
52105 - FROM vserver( vserver Uses image, MANY2ONE)
52107 -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
52108 -IMAGE cannot be deleted if related to VSERVER
52119 description: Image id, expected to be unique across cloud region
52122 description: Image name
52123 image-architecture:
52125 description: Operating system architecture.
52128 description: The common name of the operating system distribution in lowercase
52131 description: The operating system version as specified by the distributor.
52134 description: The application that the image instantiates.
52135 application-vendor:
52137 description: The vendor of the application.
52138 application-version:
52140 description: The version of the application.
52143 description: URL to endpoint where AAI can get more details
52146 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52150 $ref: "#/getDefinitions/relationship"
52154 $ref: "#/getDefinitions/metadatum"
52157 Collectio of Openstack images.
52162 $ref: "#/getDefinitions/image"
52163 include-node-filter:
52169 InstanceFilter for performing a named-query or model query
52172 InstanceFilters for performing a named-query or model query
52177 $ref: "#/getDefinitions/instance-filter"
52180 General mechanism for grouping instances
52181 ###### Related Nodes
52182 - TO model( instance-group Targets model, MANY2MANY)
52183 - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
52184 - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
52185 - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
52186 - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
52195 description: Instance Group ID, UUID assigned to this instance.
52198 description: Descriptive text to help identify the usage of this instance-group
52201 description: Only valid value today is lower case ha for high availability
52204 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
52207 description: Concurrency value
52211 $ref: "#/getDefinitions/relationship"
52214 Collection of openstack route table references
52219 $ref: "#/getDefinitions/instance-group"
52224 $ref: "#/getDefinitions/search"
52227 $ref: "#/getDefinitions/actions"
52228 cloud-infrastructure:
52230 $ref: "#/getDefinitions/cloud-infrastructure"
52233 $ref: "#/getDefinitions/business"
52234 service-design-and-creation:
52236 $ref: "#/getDefinitions/service-design-and-creation"
52239 $ref: "#/getDefinitions/network"
52242 $ref: "#/getDefinitions/nodes"
52245 inventory-item-type:
52247 inventory-item-link:
52249 inventory-item-data:
52252 $ref: "#/getDefinitions/inventory-item-data"
52253 tagged-inventory-item-list:
52256 $ref: "#/getDefinitions/tagged-inventory-item-list"
52257 inventory-item-data:
52263 inventory-response-item:
52265 Inventory item for response list
52271 $ref: "#/getDefinitions/extra-properties"
52272 inventory-response-items:
52274 $ref: "#/getDefinitions/inventory-response-items"
52275 inventory-response-items:
52277 Container for inventory items in response list
52279 inventory-response-item:
52282 $ref: "#/getDefinitions/inventory-response-item"
52283 ipsec-configuration:
52285 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
52286 ###### Related Nodes
52287 - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
52288 - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
52290 -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
52292 - ipsec-configuration-id
52294 ipsec-configuration-id:
52296 description: UUID of this configuration
52297 requested-vig-address-type:
52299 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
52300 requested-encryption-strength:
52302 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
52303 requested-dmz-type:
52305 description: can offer a shared DMZ or a DMZ specific to a customer
52306 shared-dmz-network-address:
52308 description: Network address of shared DMZ
52309 requested-customer-name:
52311 description: If the DMZ is a custom DMZ, this field will indicate the customer information
52314 description: can be 1 or 2
52315 ikev1-authentication:
52317 description: Contains values like md5, sha1, sha256, sha384
52320 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
52323 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
52326 description: Group name defined in VIG for clients using aggressive mode
52329 description: pre-shared key for the above group name
52332 description: Lifetime for IKEv1 SA
52333 ipsec-authentication:
52335 description: md5, sha1, sha256, sha384
52338 description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
52341 description: Life time for IPSec SA
52344 description: enable PFS or not
52347 description: user ID for xAuth, sm-user, ,nmteHostName
52348 xauth-user-password:
52350 description: Encrypted using the Juniper $9$ algorithm
52353 description: The time between DPD probe
52356 description: Maximum number of DPD before claiming the tunnel is down
52359 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52363 $ref: "#/getDefinitions/relationship"
52367 $ref: "#/getDefinitions/vig-server"
52368 ipsec-configurations:
52370 ipsec-configuration:
52373 $ref: "#/getDefinitions/ipsec-configuration"
52382 Logical interfaces, e.g., a vnic.
52383 ###### Related Nodes
52384 - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
52385 - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
52386 - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
52387 - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
52388 - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
52389 - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
52390 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
52391 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
52392 - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
52393 - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
52395 -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
52396 -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
52397 -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
52403 description: Name given to the interface
52406 description: E.g., CUSTOMER, UPLINK, etc.
52409 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
52412 description: URL to endpoint where AAI can get more details
52415 description: ID of interface
52418 description: MAC address for the interface
52421 description: Name of the network
52424 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
52425 interface-description:
52427 description: Human friendly text regarding this interface.
52430 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52434 $ref: "#/getDefinitions/vlan"
52438 $ref: "#/getDefinitions/sriov-vf"
52442 $ref: "#/getDefinitions/relationship"
52443 l3-interface-ipv4-address-list:
52446 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
52447 l3-interface-ipv6-address-list:
52450 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
52453 Collection of logical interfaces.
52458 $ref: "#/getDefinitions/l-interface"
52459 l3-interface-ipv4-address-list:
52462 ###### Related Nodes
52463 - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
52464 - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
52465 - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
52466 - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
52468 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
52470 - l3-interface-ipv4-address
52472 l3-interface-ipv4-address:
52474 description: IP address
52475 l3-interface-ipv4-prefix-length:
52478 description: Prefix length, 32 for single address
52482 description: Inner VLAN tag
52486 description: Outer VLAN tag
52489 description: Indicator of fixed or floating address
52492 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52493 neutron-network-id:
52495 description: Neutron network id of the interface that address belongs to
52498 description: Neutron id of subnet that address belongs to
52502 $ref: "#/getDefinitions/relationship"
52503 l3-interface-ipv6-address-list:
52506 ###### Related Nodes
52507 - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
52508 - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
52509 - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
52510 - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
52512 -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
52514 - l3-interface-ipv6-address
52516 l3-interface-ipv6-address:
52518 description: IP address
52519 l3-interface-ipv6-prefix-length:
52522 description: Prefix length, 128 for single address
52526 description: Inner VLAN tag
52530 description: Outer VLAN tag
52533 description: Indicator of fixed or floating address
52536 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52537 neutron-network-id:
52539 description: Neutron network id of the interface that address belongs to
52542 description: Neutron id of subnet that address belongs to
52546 $ref: "#/getDefinitions/relationship"
52549 Generic network definition
52550 ###### Related Nodes
52551 - TO network-policy( l3-network Uses network-policy, MANY2MANY)
52552 - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
52553 - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
52554 - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
52555 - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
52556 - FROM complex( complex Uses l3-network, MANY2MANY)
52557 - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
52558 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
52559 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
52560 - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
52561 - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
52562 - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
52563 - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
52564 - FROM tenant( tenant Uses l3-network, MANY2MANY)
52565 - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
52567 -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
52572 - is-provider-network
52573 - is-shared-network
52574 - is-external-network
52578 description: Network ID, should be uuid. Unique across A&AI.
52581 description: Name of the network, governed by some naming convention..
52584 description: Type of the network - who defines these values?
52587 description: Role the network plans - who defines these values?
52588 network-technology:
52590 description: Network technology - who defines these values?
52591 neutron-network-id:
52593 description: Neutron network id of this Interface
52596 description: Set to true if bound to VPN
52599 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
52600 network-role-instance:
52603 description: network role instance
52606 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52607 orchestration-status:
52609 description: Orchestration status of this VNF, mastered by MSO
52612 description: Heat stack id corresponding to this instance, managed by MSO
52615 description: Corresponds to the SDN-C catalog id used to configure this VCE
52616 contrail-network-fqdn:
52618 description: Contrail FQDN for the network
52621 description: the ASDC model id for this resource or service model.
52622 persona-model-version:
52624 description: the ASDC model version for this resource or service model.
52627 description: the ASDC model version for this resource or service model.
52628 persona-model-customization-id:
52630 description: captures the id of all the configuration used to customize the resource for the service.
52633 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
52634 widget-model-version:
52636 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
52637 physical-network-name:
52639 description: Name associated with the physical network.
52640 is-provider-network:
52642 description: boolean indicatating whether or not network is a provider network.
52645 description: boolean indicatating whether or not network is a shared network.
52646 is-external-network:
52648 description: boolean indicatating whether or not network is an external network.
52651 description: Path to the controller object.
52655 $ref: "#/getDefinitions/subnet"
52659 $ref: "#/getDefinitions/ctag-assignment"
52660 segmentation-assignments:
52663 $ref: "#/getDefinitions/segmentation-assignment"
52667 $ref: "#/getDefinitions/relationship"
52668 description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
52674 $ref: "#/getDefinitions/l3-network"
52677 Link aggregate interface
52678 ###### Related Nodes
52679 - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
52680 - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
52681 - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
52682 - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
52683 - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
52684 - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
52685 - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
52687 -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
52688 -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
52689 -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
52695 description: Name that identifies the link aggregate interface
52696 interface-description:
52698 description: Human friendly text regarding this interface.
52701 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52704 description: Captures the numeric part of the speed
52707 description: Captures the units corresponding to the speed
52710 description: ID of interface
52713 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
52716 description: Trigger for operational monitoring of this resource by Service Assurance systems.
52720 $ref: "#/getDefinitions/relationship"
52724 $ref: "#/getDefinitions/l-interface"
52727 Collection of link aggregate interfaces.
52732 $ref: "#/getDefinitions/lag-interface"
52735 LAG links can connect lag-interfaces
52736 ###### Related Nodes
52737 - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
52738 - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
52740 -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
52746 description: Alphabetical concatenation of lag-interface names
52749 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52753 $ref: "#/getDefinitions/relationship"
52756 Collection of link aggregation connections
52761 $ref: "#/getDefinitions/lag-link"
52764 Metadata for license group.
52765 ###### Related Nodes
52766 - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
52767 - TO vce( license BelongsTo vce, MANY2ONE)(4)
52769 -(4) IF this TO node is deleted, this LICENSE is DELETED also
52776 description: Unique ID for the license group the resource belongs to, should be uuid.
52779 description: Unique ID of a license resource.
52782 description: Concurrency value
52786 $ref: "#/getDefinitions/relationship"
52789 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
52794 $ref: "#/getDefinitions/license"
52797 describes a line-of-business
52798 ###### Related Nodes
52799 - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
52802 - line-of-business-name
52804 line-of-business-name:
52806 description: Name of the line-of-business (product)
52809 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52813 $ref: "#/getDefinitions/relationship"
52816 Collection of lines-of-business
52821 $ref: "#/getDefinitions/line-of-business"
52824 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
52825 ###### Related Nodes
52826 - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
52827 - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
52828 - TO lag-link( logical-link Uses lag-link, MANY2MANY)
52829 - TO logical-link( logical-link Uses logical-link, ONE2MANY)
52830 - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
52831 - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
52832 - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
52833 - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
52834 - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
52835 - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
52836 - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
52837 - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
52838 - FROM logical-link( logical-link Uses logical-link, ONE2MANY)
52840 -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
52847 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
52850 description: Type of logical link, e.g., evc
52853 description: Captures the numeric part of the speed
52856 description: Captures the units corresponding to the speed
52859 description: v4, v6, or ds for dual stack
52862 description: For example, static or BGP
52865 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52868 description: the ASDC model id for this resource or service model.
52869 persona-model-version:
52871 description: the ASDC model version for this resource or service model.
52874 description: the ASDC model version for this resource or service model.
52877 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
52878 widget-model-version:
52880 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
52881 operational-status:
52883 description: Indication of operational status of the logical link.
52886 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
52889 description: Indication of the network use of the logical link.
52892 description: Alias or alternate name (CLCI or D1 name).
52895 description: UUID of the logical-link, SDNC generates this.
52898 description: Circuit id
52901 description: Reason for this entity, role it is playing
52905 $ref: "#/getDefinitions/relationship"
52908 Collection of logical connections
52913 $ref: "#/getDefinitions/logical-link"
52916 Collection of metadatum (key/value pairs)
52921 $ref: "#/getDefinitions/metadatum"
52925 ###### Related Nodes
52926 - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
52927 - TO image( metadatum BelongsTo image, MANY2ONE)(4)
52928 - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
52929 - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
52931 -(4) IF this TO node is deleted, this METADATUM is DELETED also
52942 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52945 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
52946 ###### Related Nodes
52947 - TO model( model-ver BelongsTo model, MANY2ONE)(1)
52948 - FROM instance-group( instance-group Targets model, MANY2MANY)
52949 - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
52950 - FROM named-query( named-query AppliesTo model, ONE2MANY)
52951 - FROM named-query-element( named-query-element IsA model, MANY2ONE)
52953 -(1) IF this MODEL node is deleted, this FROM node is DELETED also
52954 -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
52957 - model-invariant-id
52960 model-invariant-id:
52962 description: Unique identifier corresponding to the main definition of a model in ASDC
52965 description: Type of the model, e.g., service, resource, widget, etc.
52968 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52972 $ref: "#/getDefinitions/model-ver"
52976 $ref: "#/getDefinitions/relationship"
52977 model-and-named-query-search:
52979 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
52983 $ref: "#/getDefinitions/query-parameters"
52986 $ref: "#/getDefinitions/instance-filters"
52989 $ref: "#/getDefinitions/secondary-filts"
52992 secondary-filter-cut-point:
52996 This is how we would capture constraints defining allowed sets of elements.
52997 ###### Related Nodes
52998 - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
52999 - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
53001 -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
53002 -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
53004 - model-constraint-uuid
53005 - constrained-element-set-uuid-to-replace
53007 model-constraint-uuid:
53009 constrained-element-set-uuid-to-replace:
53011 constrained-element-sets:
53014 $ref: "#/getDefinitions/constrained-element-set"
53017 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53023 $ref: "#/getDefinitions/model-constraint"
53026 Defines how other models combine to make up a higher-level model.
53027 ###### Related Nodes
53028 - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
53029 - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
53030 - TO model-ver( model-element IsA model-ver, MANY2ONE)
53031 - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
53032 - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
53033 - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
53034 - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
53036 -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
53037 -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
53039 - model-element-uuid
53040 - new-data-del-flag
53043 model-element-uuid:
53047 description: Indicates whether this element was created as part of instantiation from this model
53050 description: How many of this type of element are required/allowed
53055 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53059 $ref: "#/getDefinitions/model-element"
53060 description: Defines how other models combine to make up a higher-level model
53064 $ref: "#/getDefinitions/model-constraint"
53065 description: Describes new constraints on this model element that are not part of that model's definition
53069 $ref: "#/getDefinitions/relationship"
53075 $ref: "#/getDefinitions/model-element"
53078 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
53079 ###### Related Nodes
53080 - TO model( model-ver BelongsTo model, MANY2ONE)(4)
53081 - FROM model-element( model-element IsA model-ver, MANY2ONE)
53082 - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
53083 - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
53085 -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
53086 -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
53087 -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
53096 description: Unique identifier corresponding to one version of a model in ASDC
53099 description: Name of the model, which can change from version to version.
53102 description: Version
53105 description: Description
53108 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53112 $ref: "#/getDefinitions/model-element"
53116 $ref: "#/getDefinitions/metadatum"
53120 $ref: "#/getDefinitions/relationship"
53126 $ref: "#/getDefinitions/model-ver"
53129 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
53134 $ref: "#/getDefinitions/model"
53135 multicast-configuration:
53137 ###### Related Nodes
53138 - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
53141 - multicast-configuration-id
53142 - multicast-protocol
53145 multicast-configuration-id:
53147 description: Unique id of multicast configuration.
53148 multicast-protocol:
53150 description: protocol of multicast configuration
53153 description: rp type of multicast configuration
53156 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53160 $ref: "#/getDefinitions/relationship"
53161 multicast-configurations:
53163 multicast configuration of generic-vnf ip-address
53165 multicast-configuration:
53168 $ref: "#/getDefinitions/multicast-configuration"
53174 $ref: "#/getDefinitions/named-query"
53178 ###### Related Nodes
53179 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
53180 - TO model( named-query AppliesTo model, ONE2MANY)
53181 - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
53183 -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
53187 - named-query-version
53193 named-query-version:
53195 required-input-param:
53201 named-query-elements:
53204 $ref: "#/getDefinitions/named-query-element"
53208 $ref: "#/getDefinitions/relationship"
53209 named-query-element:
53212 ###### Related Nodes
53213 - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
53214 - TO model( named-query-element IsA model, MANY2ONE)
53215 - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
53216 - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
53217 - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
53218 - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
53220 -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
53221 -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
53223 - named-query-element-uuid
53225 named-query-element-uuid:
53227 property-collect-list:
53231 property-limit-desc:
53235 named-query-elements:
53238 $ref: "#/getDefinitions/named-query-element"
53242 $ref: "#/getDefinitions/related-lookup"
53243 property-constraints:
53246 $ref: "#/getDefinitions/property-constraint"
53250 $ref: "#/getDefinitions/relationship"
53251 named-query-elements:
53253 named-query-element:
53256 $ref: "#/getDefinitions/named-query-element"
53259 Namespace for network inventory resources.
53264 $ref: "#/getDefinitions/logical-link"
53268 $ref: "#/getDefinitions/site-pair-set"
53272 $ref: "#/getDefinitions/vpn-binding"
53276 $ref: "#/getDefinitions/vpls-pe"
53277 multicast-configurations:
53280 $ref: "#/getDefinitions/multicast-configuration"
53284 $ref: "#/getDefinitions/vce"
53288 $ref: "#/getDefinitions/vnfc"
53292 $ref: "#/getDefinitions/l3-network"
53296 $ref: "#/getDefinitions/network-policy"
53300 $ref: "#/getDefinitions/generic-vnf"
53304 $ref: "#/getDefinitions/lag-link"
53308 $ref: "#/getDefinitions/newvce"
53312 $ref: "#/getDefinitions/pnf"
53316 $ref: "#/getDefinitions/physical-link"
53317 ipsec-configurations:
53320 $ref: "#/getDefinitions/ipsec-configuration"
53321 route-table-references:
53324 $ref: "#/getDefinitions/route-table-reference"
53328 $ref: "#/getDefinitions/instance-group"
53332 $ref: "#/getDefinitions/zone"
53338 $ref: "#/getDefinitions/network-policy"
53341 ###### Related Nodes
53342 - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
53345 - network-policy-id
53349 description: UUID representing unique key to this instance
53350 network-policy-fqdn:
53352 description: Contrail FQDN for the policy
53355 description: ID for the openStack Heat instance
53358 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53362 $ref: "#/getDefinitions/relationship"
53365 Network profile populated by SDN-GP for SNMP
53366 ###### Related Nodes
53367 - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
53374 description: Unique name of network profile.
53377 description: Encrypted SNMP community string
53380 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53384 $ref: "#/getDefinitions/relationship"
53387 Collection of network profiles
53392 $ref: "#/getDefinitions/network-profile"
53395 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
53396 ###### Related Nodes
53397 - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
53399 -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
53407 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
53410 description: Name of VNF.
53413 description: Alternate name of VNF.
53416 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.
53419 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
53422 description: Indicator for whether the resource is considered operational
53425 description: OBSOLETE - do not use
53428 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
53431 description: Client should send valid enumerated value.
53434 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53435 ipv4-loopback0-address:
53437 description: v4 Loopback0 address
53438 orchestration-status:
53440 description: Orchestration status of this VNF, mastered by MSO.
53443 description: Heat stack id corresponding to this instance, managed by MSO
53446 description: Corresponds to the SDN-C catalog id used to configure this VCE
53450 $ref: "#/getDefinitions/relationship"
53454 $ref: "#/getDefinitions/l-interface"
53457 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
53462 $ref: "#/getDefinitions/newvce"
53465 inventory-item-data:
53468 $ref: "#/getDefinitions/inventory-item-data"
53469 notification-event:
53473 notification-event-header:
53475 $ref: "#/getDefinitions/notification-event-header"
53476 notification-event-header:
53517 $ref: "#/getDefinitions/key-data"
53522 OAM network, to be deprecated shortly. Do not use for new purposes.
53523 ###### Related Nodes
53524 - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
53525 - TO complex( oam-network AppliesTo complex, MANY2MANY)
53526 - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
53535 description: UUID of the network. Unique across a cloud-region
53538 description: Name of the network.
53542 description: cvlan-id
53543 ipv4-oam-gateway-address:
53545 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
53546 ipv4-oam-gateway-address-prefix-length:
53549 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
53552 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53556 $ref: "#/getDefinitions/relationship"
53559 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
53564 $ref: "#/getDefinitions/oam-network"
53565 operational-environment:
53567 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
53568 ###### Related Nodes
53569 - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
53570 - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
53573 - operational-environment-id
53574 - operational-environment-name
53575 - operational-environment-type
53576 - operational-environment-status
53580 operational-environment-id:
53582 description: UUID of an operational environment
53583 operational-environment-name:
53585 description: Operational Environment name
53586 operational-environment-type:
53588 description: Operational Environment Type.
53589 operational-environment-status:
53591 description: Status
53594 description: Tenant Context.
53597 description: Workload Context.
53600 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53604 $ref: "#/getDefinitions/relationship"
53605 operational-environments:
53607 a logical partition of the cloud which allows to have multiple environments in the production AIC.
53609 operational-environment:
53612 $ref: "#/getDefinitions/operational-environment"
53615 Allows for legacy POST of old-style and new-style models
53617 - model-invariant-id
53618 - model-name-version-id
53624 model-invariant-id:
53626 description: Unique identifier corresponding to the main definition of a model in ASDC
53627 model-name-version-id:
53629 description: Unique identifier corresponding to one version of a model in ASDC
53632 description: Type of the model, e.g., service, resource, widget, etc.
53635 description: Name of the model, which can change from version to version.
53638 description: Invariant unique ID which does not change from version to version
53641 description: Version
53644 description: Description
53647 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53650 $ref: "#/getDefinitions/model-vers"
53653 $ref: "#/getDefinitions/relationship-list"
53656 Collection of owning-entities
53661 $ref: "#/getDefinitions/owning-entity"
53664 describes an owning-entity
53665 ###### Related Nodes
53666 - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
53670 - owning-entity-name
53674 description: UUID of an owning entity
53675 owning-entity-name:
53677 description: Owning entity name
53680 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53684 $ref: "#/getDefinitions/relationship"
53687 Physical interface (e.g., nic)
53688 ###### Related Nodes
53689 - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
53690 - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
53691 - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
53692 - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
53693 - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
53694 - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
53695 - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
53697 -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
53698 -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
53699 -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
53705 description: Name that identifies the physical interface
53708 description: Captures the numeric part of the speed
53711 description: Captures the units corresponding to the speed
53714 description: Nature of the services and connectivity on this port.
53715 equipment-identifier:
53717 description: CLEI or other specification for p-interface hardware.
53720 description: Role specification for p-interface hardware.
53723 description: Indicates the physical properties of the interface.
53726 description: Trigger for operational monitoring of this resource by Service Assurance systems.
53729 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53733 $ref: "#/getDefinitions/relationship"
53737 $ref: "#/getDefinitions/l-interface"
53740 Collection of physical interfaces.
53745 $ref: "#/getDefinitions/p-interface"
53748 Collection of physical connections, typically between p-interfaces
53749 ###### Related Nodes
53750 - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
53752 -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
53758 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
53761 description: Captures the numeric part of the speed
53764 description: Captures the units corresponding to the speed
53767 description: Circuit it
53770 description: Dual access mode (e.g., primary, secondary
53773 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
53774 service-provider-name:
53776 description: Name of the service Provider on this link.
53779 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53783 $ref: "#/getDefinitions/relationship"
53786 Collection of physical connections, typically between p-interfaces
53791 $ref: "#/getDefinitions/physical-link"
53794 describes a platform
53795 ###### Related Nodes
53796 - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
53803 description: Name of the platform
53806 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53810 $ref: "#/getDefinitions/relationship"
53813 Collection of platforms
53818 $ref: "#/getDefinitions/platform"
53821 PNF represents a physical network function. typically equipment used in the D1 world.
53822 ###### Related Nodes
53823 - TO complex( pnf LocatedIn complex, MANY2ONE)
53824 - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
53825 - TO zone( pnf LocatedIn zone, MANY2ONE)
53826 - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
53827 - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
53828 - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
53829 - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
53831 -(1) IF this PNF node is deleted, this FROM node is DELETED also
53838 description: unique name of Physical Network Function.
53841 description: name of Physical Network Function.
53844 description: source of name2
53847 description: id of pnf
53850 description: Equipment type. Source of truth should define valid values.
53853 description: Equipment vendor. Source of truth should define valid values.
53856 description: Equipment model. Source of truth should define valid values.
53859 description: identifier of managed by company or customer
53862 description: ipv4-oam-address with new naming convention for IP addresses
53865 description: sw-version is the version of SW for the hosted application on the PNF.
53868 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.
53871 description: ID of the physical frame (relay rack) where pnf is installed.
53874 description: Serial number of the device
53875 ipaddress-v4-loopback-0:
53877 description: IPV4 Loopback 0 address
53878 ipaddress-v6-loopback-0:
53880 description: IPV6 Loopback 0 address
53883 description: IPV4 AIM address
53886 description: IPV6 AIM address
53889 description: IPV6 OAM address
53892 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
53895 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53898 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
53901 description: Nf Role is the role performed by this instance in the network.
53905 $ref: "#/getDefinitions/relationship"
53909 $ref: "#/getDefinitions/p-interface"
53913 $ref: "#/getDefinitions/lag-interface"
53916 Collection of Physical Network Functions.
53921 $ref: "#/getDefinitions/pnf"
53924 Used to capture the network interfaces of this VCE
53925 ###### Related Nodes
53926 - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
53927 - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
53929 -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
53930 -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
53933 - orchestration-status
53937 description: Unique ID of the interface
53938 neutron-network-id:
53940 description: Neutron network id of this Interface
53941 neutron-network-name:
53943 description: Neutron network name of this Interface
53946 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
53949 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53952 description: Unique ID for port group in vmware
53955 description: Likely to duplicate value of neutron network name
53958 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
53959 orchestration-status:
53961 description: Orchestration status of this VNF, mastered by MSO
53964 description: Heat stack id corresponding to this instance, managed by MSO
53967 description: Corresponds to the SDN-C catalog id used to configure this VCE
53971 $ref: "#/getDefinitions/cvlan-tag-entry"
53975 $ref: "#/getDefinitions/relationship"
53981 $ref: "#/getDefinitions/port-group"
53984 describes the project
53985 ###### Related Nodes
53986 - TO service-instance( project Uses service-instance, ONE2MANY)
53993 description: Name of the project deploying a service
53996 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54000 $ref: "#/getDefinitions/relationship"
54003 Collection of projects
54008 $ref: "#/getDefinitions/project"
54011 Property holder for query properties or instance properties
54017 property-constraint:
54020 ###### Related Nodes
54021 - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
54023 -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
54025 - property-constraint-uuid
54030 property-constraint-uuid:
54040 property-constraints:
54042 property-constraint:
54045 $ref: "#/getDefinitions/property-constraint"
54048 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
54049 ###### Related Nodes
54050 - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
54051 - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
54052 - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
54053 - TO complex( pserver LocatedIn complex, MANY2ONE)
54054 - TO zone( pserver LocatedIn zone, MANY2ONE)
54055 - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
54056 - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
54057 - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
54058 - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
54059 - FROM vserver( vserver HostedOn pserver, MANY2ONE)
54061 -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
54062 -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
54070 description: Value from executing hostname on the compute node.
54073 description: PTNII name
54077 description: Number of cpus
54081 description: Disk size, in GBs
54085 description: RAM size, in MBs
54088 description: Equipment type. Source of truth should define valid values.
54091 description: Equipment vendor. Source of truth should define valid values.
54094 description: Equipment model. Source of truth should define valid values.
54097 description: Fully-qualified domain name
54100 description: URL to endpoint where AAI can get more details
54103 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
54106 description: Serial number, may be queried
54107 ipaddress-v4-loopback-0:
54109 description: IPV4 Loopback 0 address
54110 ipaddress-v6-loopback-0:
54112 description: IPV6 Loopback 0 address
54115 description: IPV4 AIM address
54118 description: IPV6 AIM address
54121 description: IPV6 OAM address
54124 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
54127 description: ID of Pserver
54130 description: internet topology of Pserver
54133 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.
54136 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54139 description: alternative pserver name
54142 description: purpose of pserver
54145 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
54149 $ref: "#/getDefinitions/relationship"
54153 $ref: "#/getDefinitions/p-interface"
54157 $ref: "#/getDefinitions/lag-interface"
54160 Collection of compute hosts.
54165 $ref: "#/getDefinitions/pserver"
54168 QueryParameters for performing a named-query or model query
54172 $ref: "#/getDefinitions/named-query"
54175 $ref: "#/getDefinitions/overloaded-model"
54179 ###### Related Nodes
54180 - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
54182 -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
54184 - related-lookup-uuid
54186 - source-node-property
54188 - target-node-property
54190 related-lookup-uuid:
54194 source-node-property:
54198 target-node-property:
54200 property-collect-list:
54207 $ref: "#/getDefinitions/relationship"
54213 $ref: "#/getDefinitions/related-lookup"
54214 related-to-property:
54218 description: Key part of a key/value pair
54221 description: Value part of a key/value pair
54226 description: A keyword provided by A&AI to indicate type of node.
54229 description: URL to the object in A&AI.
54233 $ref: "#/getDefinitions/relationship-data"
54234 related-to-property:
54237 $ref: "#/getDefinitions/related-to-property"
54241 - relationship-value
54245 description: A keyword provided by A&AI to indicate an attribute.
54246 relationship-value:
54248 description: Value of the attribute.
54254 $ref: "#/getDefinitions/relationship"
54255 reserved-prop-names:
54257 Internal map to define some reserved properties of a vertex
54259 last-mod-source-of-truth:
54277 Response container for the results of a named-query or model query
54279 inventory-response-items:
54281 $ref: "#/getDefinitions/inventory-response-items"
54286 description: The specific type of node in the A&AI graph
54289 description: The URL to the specific resource
54290 route-table-reference:
54292 Openstack route table reference.
54293 ###### Related Nodes
54294 - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
54297 - route-table-reference-id
54298 - route-table-reference-fqdn
54300 route-table-reference-id:
54302 description: Route Table Reference id, UUID assigned to this instance.
54303 route-table-reference-fqdn:
54305 description: FQDN entry in the route table.
54308 description: Concurrency value
54312 $ref: "#/getDefinitions/relationship"
54313 route-table-references:
54315 Collection of openstack route table references
54317 route-table-reference:
54320 $ref: "#/getDefinitions/route-table-reference"
54323 Route target information
54324 ###### Related Nodes
54325 - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
54327 -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
54329 - global-route-target
54330 - route-target-role
54332 global-route-target:
54334 description: Number used to identify an RT, globally unique in the network
54337 description: Role assigned to this route target
54340 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54344 $ref: "#/getDefinitions/relationship"
54347 Collection of route target information
54352 $ref: "#/getDefinitions/route-target"
54355 ###### Related Nodes
54356 - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
54357 - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
54359 -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
54360 -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
54362 - routing-instance-id
54364 routing-instance-id:
54366 description: Unique id of routing instance
54369 description: rpm owner
54372 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54376 $ref: "#/getDefinitions/site-pair"
54380 $ref: "#/getDefinitions/relationship"
54383 set of probes related to generic-vnf routing instance
54388 $ref: "#/getDefinitions/routing-instance"
54393 $ref: "#/getDefinitions/oam-networks"
54394 az-and-dvs-switches:
54397 $ref: "#/getDefinitions/az-and-dvs-switches"
54400 edge-tag-query-result:
54402 $ref: "#/getDefinitions/edge-tag-query-result"
54403 edge-tag-query-request:
54405 $ref: "#/getDefinitions/edge-tag-query-request"
54408 $ref: "#/getDefinitions/search-results"
54411 $ref: "#/getDefinitions/sdn-zone-response"
54417 $ref: "#/getDefinitions/result-data"
54420 SecondaryFilt for performing a named-query or model query
54431 SecondaryFilts for performing a named-query or model query
54436 $ref: "#/getDefinitions/secondary-filt"
54437 segmentation-assignment:
54439 Openstack segmentation assignment.
54440 ###### Related Nodes
54441 - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
54443 -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
54449 description: Route Table Reference id, UUID assigned to this instance.
54452 description: Concurrency value
54456 $ref: "#/getDefinitions/relationship"
54457 segmentation-assignments:
54459 Collection of openstack segmentation assignments
54461 segmentation-assignment:
54464 $ref: "#/getDefinitions/segmentation-assignment"
54467 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
54470 - service-description
54474 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
54475 service-description:
54477 description: Description of the service
54480 description: URL to endpoint where AAI can get more details
54483 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54486 description: service version
54490 $ref: "#/getDefinitions/relationship"
54491 service-capabilities:
54493 Collection of service capabilities.
54495 service-capability:
54498 $ref: "#/getDefinitions/service-capability"
54499 service-capability:
54501 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
54502 ###### Related Nodes
54503 - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
54504 - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
54506 -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
54514 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
54517 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.
54520 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54524 $ref: "#/getDefinitions/relationship"
54525 service-design-and-creation:
54527 Namespace for objects managed by ASDC
54532 $ref: "#/getDefinitions/vnf-image"
54536 $ref: "#/getDefinitions/service"
54537 service-capabilities:
54540 $ref: "#/getDefinitions/service-capability"
54544 $ref: "#/getDefinitions/model"
54548 $ref: "#/getDefinitions/named-query"
54551 Instance of a service
54552 ###### Related Nodes
54553 - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
54554 - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
54555 - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
54556 - TO connector( service-instance Uses connector, MANY2MANY)
54557 - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
54558 - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
54559 - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
54560 - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
54561 - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
54562 - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
54563 - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
54564 - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
54565 - TO vce( service-instance ComposedOf vce, ONE2MANY)
54566 - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
54567 - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
54568 - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
54570 -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
54571 -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
54572 -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
54574 - service-instance-id
54576 service-instance-id:
54578 description: Uniquely identifies this instance of a service
54579 service-instance-name:
54581 description: This field will store a name assigned to the service-instance.
54584 description: the ASDC model id for this resource or service model.
54585 persona-model-version:
54587 description: the ASDC model version for this resource or service model.
54590 description: the ASDC model version for this resource or service model.
54593 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
54594 widget-model-version:
54596 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
54599 description: Indicates the total bandwidth to be used for this service.
54602 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
54603 bandwidth-down-wan1:
54605 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
54608 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
54609 bandwidth-down-wan2:
54611 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
54614 description: URL customers will use to access the vHN Portal.
54615 service-instance-location-id:
54617 description: An identifier that customers assign to the location where this service is being used.
54620 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54623 description: Path to the controller object.
54624 orchestration-status:
54626 description: Orchestration status of this service.
54630 $ref: "#/getDefinitions/relationship"
54634 $ref: "#/getDefinitions/metadatum"
54635 allotted-resources:
54638 $ref: "#/getDefinitions/allotted-resource"
54641 Collection of service instances
54646 $ref: "#/getDefinitions/service-instance"
54647 service-subscription:
54649 Object that group service instances.
54650 ###### Related Nodes
54651 - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
54652 - TO tenant( service-subscription Uses tenant, MANY2MANY)
54653 - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
54655 -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
54656 -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
54662 description: Value defined by orchestration to identify this service across ECOMP.
54663 temp-ub-sub-account-id:
54665 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
54668 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54672 $ref: "#/getDefinitions/service-instance"
54676 $ref: "#/getDefinitions/relationship"
54677 service-subscriptions:
54679 Collection of objects that group service instances.
54681 service-subscription:
54684 $ref: "#/getDefinitions/service-subscription"
54687 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
54692 $ref: "#/getDefinitions/service"
54695 ###### Related Nodes
54696 - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
54697 - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
54699 -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
54700 -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
54706 description: unique identifier of probe
54709 description: Prefix address
54712 description: Prefix address
54715 description: ip version, v4, v6
54716 destination-hostname:
54718 description: Hostname of the destination equipment to which SLAs are measured against.
54719 destination-equip-type:
54721 description: The type of destinatination equipment. Could be Router, etc.
54724 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54725 classes-of-service:
54728 $ref: "#/getDefinitions/class-of-service"
54732 $ref: "#/getDefinitions/relationship"
54735 Set of instances for probes used to measure service level agreements
54736 ###### Related Nodes
54737 - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
54738 - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
54740 -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
54746 description: Unique id of site pair set.
54749 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54753 $ref: "#/getDefinitions/routing-instance"
54757 $ref: "#/getDefinitions/relationship"
54760 Collection of sets of instances for probes related to generic-vnf
54765 $ref: "#/getDefinitions/site-pair-set"
54773 $ref: "#/getDefinitions/site-pair"
54777 ###### Related Nodes
54778 - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
54779 - FROM vserver( vserver Uses snapshot, ONE2ONE)
54786 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
54789 description: Snapshot name
54790 snapshot-architecture:
54792 description: Operating system architecture
54793 snapshot-os-distro:
54795 description: The common name of the operating system distribution in lowercase
54796 snapshot-os-version:
54798 description: The operating system version as specified by the distributor.
54801 description: The application that the image instantiates.
54802 application-vendor:
54804 description: The vendor of the application.
54805 application-version:
54807 description: The version of the application.
54810 description: URL to endpoint where AAI can get more details
54813 description: This field contains the UUID of the previous snapshot (if any).
54816 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54820 $ref: "#/getDefinitions/relationship"
54823 Collection of openstack snapshots
54828 $ref: "#/getDefinitions/snapshot"
54831 SR-IOV Physical Function
54832 ###### Related Nodes
54833 - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
54834 - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
54836 -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
54842 description: Identifier for the sriov-pf
54845 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54849 $ref: "#/getDefinitions/relationship"
54852 Collection of SR-IOV Physical Functions.
54857 $ref: "#/getDefinitions/sriov-pf"
54860 SR-IOV Virtual Function (not to be confused with virtual network function)
54861 ###### Related Nodes
54862 - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
54864 -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
54870 description: PCI ID used to identify the sriov-vf
54873 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
54876 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
54879 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
54880 vf-vlan-anti-spoof-check:
54882 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.
54883 vf-mac-anti-spoof-check:
54885 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.
54888 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
54889 vf-broadcast-allow:
54891 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
54892 vf-unknown-multicast-allow:
54894 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
54895 vf-unknown-unicast-allow:
54897 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
54900 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
54903 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
54906 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54907 neutron-network-id:
54909 description: Neutron network id of the interface
54913 $ref: "#/getDefinitions/relationship"
54916 Collection of SR-IOV Virtual Functions.
54921 $ref: "#/getDefinitions/sriov-vf"
54930 ###### Related Nodes
54931 - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
54932 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
54933 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
54935 -(4) IF this TO node is deleted, this SUBNET is DELETED also
54936 -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
54944 description: Subnet ID, should be UUID.
54947 description: Name associated with the subnet.
54950 description: Neutron id of this subnet
54953 description: gateway ip address
54954 network-start-address:
54956 description: network start address
54959 description: cidr mask
54962 description: ip version
54963 orchestration-status:
54965 description: Orchestration status of this VNF, mastered by MSO
54968 description: dhcp enabled
54971 description: the start address reserved for use by dhcp
54974 description: the last address reserved for use by dhcp
54977 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54981 $ref: "#/getDefinitions/relationship"
54987 $ref: "#/getDefinitions/subnet"
54988 tagged-inventory-item-list:
54993 $ref: "#/getDefinitions/inventory-item"
54997 ###### Related Nodes
54998 - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
54999 - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
55000 - TO l3-network( tenant Uses l3-network, MANY2MANY)
55001 - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
55002 - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
55003 - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
55005 -TENANT cannot be deleted if related to VSERVER
55013 description: Unique id relative to the cloud-region.
55016 description: Readable name of tenant
55019 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55023 $ref: "#/getDefinitions/vserver"
55027 $ref: "#/getDefinitions/relationship"
55030 Collection of openstack tenants.
55035 $ref: "#/getDefinitions/tenant"
55038 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
55039 ###### Related Nodes
55040 - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
55042 -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
55045 - bandwidth-up-wan1
55046 - bandwidth-down-wan1
55047 - bandwidth-up-wan2
55048 - bandwidth-down-wan2
55052 description: Allotted Resource id UUID assigned to this instance.
55055 description: The WAN uplink bandwidth for WAN1
55056 bandwidth-down-wan1:
55058 description: The WAN downlink bandwidth for WAN1
55061 description: The WAN uplink bandwidth for WAN2
55062 bandwidth-down-wan2:
55064 description: The WAN downlink bandwidth for WAN2
55067 description: Concurrency value
55071 $ref: "#/getDefinitions/relationship"
55074 This object is used to store the specific tunnel cross connect aspects of an allotted resource
55079 $ref: "#/getDefinitions/tunnel-xconnect"
55082 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
55091 $ref: "#/getDefinitions/update-node-key"
55097 $ref: "#/getDefinitions/action"
55106 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
55107 ###### Related Nodes
55108 - TO availability-zone( vce Uses availability-zone, MANY2MANY)
55109 - TO complex( vce LocatedIn complex, MANY2MANY)
55110 - TO vserver( vce HostedOn vserver, ONE2MANY)
55111 - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
55112 - FROM license( license BelongsTo vce, MANY2ONE)(1)
55113 - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
55114 - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
55116 -(1) IF this VCE node is deleted, this FROM node is DELETED also
55124 description: Unique id of VNF. This is unique across the graph.
55127 description: Name of VNF.
55130 description: Alternate name of VNF.
55133 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.
55136 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
55137 regional-resource-zone:
55139 description: Regional way of organizing pservers, source of truth should define values
55142 description: Trigger for operational monitoring of this resource by Service Assurance systems.
55145 description: Indicator for whether the resource is considered operational
55148 description: OBSOLETE - do not use
55151 description: Network role being played by this VNF
55152 orchestration-status:
55154 description: Orchestration status of this VNF, mastered by MSO
55157 description: Heat stack id corresponding to this instance, managed by MSO
55160 description: Corresponds to the SDN-C catalog id used to configure this VCE
55163 description: Unique ID of VPE connected to this VCE.
55164 v6-vce-wan-address:
55166 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
55169 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
55172 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55173 ipv4-loopback0-address:
55175 description: Loopback0 address
55176 entitlement-resource-uuid:
55178 description: OBSOLETE - see child relationships
55182 $ref: "#/getDefinitions/port-group"
55186 $ref: "#/getDefinitions/license"
55190 $ref: "#/getDefinitions/entitlement"
55194 $ref: "#/getDefinitions/relationship"
55197 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
55202 $ref: "#/getDefinitions/vce"
55205 a deployment unit of VNFCs
55206 ###### Related Nodes
55207 - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
55208 - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
55209 - TO vnfc( vf-module Uses vnfc, ONE2MANY)
55210 - TO volume-group( vf-module Uses volume-group, ONE2ONE)
55211 - TO vserver( vf-module Uses vserver, ONE2MANY)
55213 -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
55214 -VF-MODULE cannot be deleted if related to VNFC
55218 - is-base-vf-module
55222 description: Unique ID of vf-module.
55225 description: Name of vf-module
55228 description: Heat stack id corresponding to this instance.
55229 orchestration-status:
55231 description: orchestration status of this vf-module, mastered by MSO
55234 description: used to indicate whether or not this object is base vf module
55237 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55240 description: the ASDC model id for this resource or service model.
55241 persona-model-version:
55243 description: the ASDC model version for this resource or service model.
55246 description: the ASDC model version for this resource or service model.
55247 persona-model-customization-id:
55249 description: captures the id of all the configuration used to customize the resource for the service.
55252 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
55253 widget-model-version:
55255 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
55256 contrail-service-instance-fqdn:
55258 description: the Contrail unique ID for a service-instance
55262 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
55265 description: Path to the controller object.
55269 $ref: "#/getDefinitions/relationship"
55272 Collection of vf-modules, a deployment unit of VNFCs
55277 $ref: "#/getDefinitions/vf-module"
55280 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
55281 ###### Related Nodes
55282 - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
55284 -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
55290 description: indicates whether the VIG is for AVPN or INTERNET
55293 description: v4 IP of the vig server
55296 description: v6 IP of the vig server
55299 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55303 $ref: "#/getDefinitions/relationship"
55309 $ref: "#/getDefinitions/vig-server"
55310 vip-ipv4-address-list:
55313 ###### Related Nodes
55314 - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
55315 - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
55316 - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
55317 - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
55324 description: IP address
55325 vip-ipv4-prefix-length:
55328 description: Prefix length, 32 for single address
55332 description: Inner VLAN tag
55336 description: Outer VLAN tag
55339 description: Indicator of fixed or floating address
55342 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55343 neutron-network-id:
55345 description: Neutron network id of the interface that address belongs to
55348 description: Neutron id of subnet that address belongs to
55352 $ref: "#/getDefinitions/relationship"
55353 vip-ipv6-address-list:
55356 ###### Related Nodes
55357 - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
55358 - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
55359 - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
55360 - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
55367 description: IP address
55368 vip-ipv6-prefix-length:
55371 description: Prefix length, 128 for single address
55375 description: Inner VLAN tag
55379 description: Outer VLAN tag
55382 description: Indicator of fixed or floating address
55385 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55386 neutron-network-id:
55388 description: Neutron network id of the interface that address belongs to
55391 description: Neutron id of subnet that address belongs to
55395 $ref: "#/getDefinitions/relationship"
55396 virtual-data-center:
55398 Virtual organization of cloud infrastructure elements in a data center context
55399 ###### Related Nodes
55400 - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
55401 - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
55402 - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
55410 description: Unique ID of the vdc
55413 description: Name of the virtual data center
55416 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55420 $ref: "#/getDefinitions/relationship"
55421 virtual-data-centers:
55423 Virtual organization of cloud infrastructure elements in a data center context
55425 virtual-data-center:
55428 $ref: "#/getDefinitions/virtual-data-center"
55432 ###### Related Nodes
55433 - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
55434 - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
55435 - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
55436 - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
55437 - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
55438 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
55439 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
55441 -(1) IF this VLAN node is deleted, this FROM node is DELETED also
55442 -(2) IF this VLAN node is deleted, this TO node is DELETED also
55443 -(4) IF this TO node is deleted, this VLAN is DELETED also
55449 description: String that identifies the interface
55453 description: Inner VLAN tag
55457 description: Outer VLAN tag
55460 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55463 description: Captures the numeric part of the speed
55466 description: Captures the units corresponding to the speed
55469 description: Used to describe (the service associated with) the vlan
55470 backdoor-connection:
55472 description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
55475 description: This indicates the customers VPN ID associated with this vlan
55476 orchestration-status:
55478 description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
55482 $ref: "#/getDefinitions/relationship"
55483 l3-interface-ipv4-address-list:
55486 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
55487 l3-interface-ipv6-address-list:
55490 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
55496 $ref: "#/getDefinitions/vlan"
55505 description: Unique id of VNF. This is unique across the graph.
55508 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
55509 ###### Related Nodes
55510 - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
55512 -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
55517 - application-vendor
55521 description: Unique ID of this asset
55524 description: The application that the image instantiates.
55525 application-vendor:
55527 description: The vendor of the application.
55528 application-version:
55530 description: The version of the application.
55533 description: URL to endpoint where AAI can get more details
55536 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55540 $ref: "#/getDefinitions/relationship"
55543 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
55548 $ref: "#/getDefinitions/vnf-image"
55551 ###### Related Nodes
55552 - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
55553 - TO vserver( vnfc HostedOn vserver, ONE2MANY)
55554 - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
55556 -(4) IF this TO node is deleted, this VNFC is DELETED also
55559 - vnfc-function-code
55562 - is-closed-loop-disabled
55566 description: Unique ID of vnfc.
55567 vnfc-function-code:
55569 description: function code
55575 description: prov status of this vnfc
55576 orchestration-status:
55578 description: Orchestration status of this VNF, mastered by APP-C
55579 ipaddress-v4-oam-vip:
55581 description: Oam V4 vip address of this vnfc
55584 description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
55585 is-closed-loop-disabled:
55587 description: used to indicate whether closed loop function is enabled on this node
55590 description: Group notation of VNFC
55593 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55597 $ref: "#/getDefinitions/relationship"
55600 virtual network components associated with a vserver from application controller.
55605 $ref: "#/getDefinitions/vnfc"
55608 Ephemeral Block storage volume.
55609 ###### Related Nodes
55610 - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
55612 -(3) IF this FROM node is deleted, this VOLUME is DELETED also
55619 description: Unique ID of block storage volume relative to the vserver.
55622 description: URL to endpoint where AAI can get more details
55625 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55629 $ref: "#/getDefinitions/relationship"
55632 Persistent block-level storage.
55633 ###### Related Nodes
55634 - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
55635 - TO complex( volume-group LocatedIn complex, MANY2ONE)
55636 - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
55637 - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
55638 - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
55642 - volume-group-name
55647 description: Unique ID of volume-group.
55650 description: Name of the volume group.
55653 description: Heat stack id corresponding to this volume-group
55656 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.
55657 orchestration-status:
55659 description: Orchestration status of this volume-group
55660 persona-model-customization-id:
55662 description: captures the id of all the configuration used to customize the resource for the service.
55663 vf-module-persona-model-customization-id:
55665 description: helps relate the volume group to the vf-module whose components will require the volume group
55668 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55672 $ref: "#/getDefinitions/relationship"
55675 Collection of persistent block-level storage.
55680 $ref: "#/getDefinitions/volume-group"
55683 Collection of ephemeral Block storage volumes.
55688 $ref: "#/getDefinitions/volume"
55691 VPLS Provider Edge routers.
55692 ###### Related Nodes
55693 - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
55694 - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
55695 - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
55696 - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
55698 -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
55706 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
55709 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
55712 description: Client should send valid enumerated value, e.g., VPLS-PE.
55716 description: Temporary location for stag to get to VCE
55719 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55723 $ref: "#/getDefinitions/relationship"
55727 $ref: "#/getDefinitions/p-interface"
55731 $ref: "#/getDefinitions/lag-interface"
55734 Collection of VPLS Provider Edge routers
55739 $ref: "#/getDefinitions/vpls-pe"
55743 ###### Related Nodes
55744 - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
55745 - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
55747 -VPN-BINDING cannot be deleted if related to L3-NETWORK,LOGICAL-LINK
55752 - global-route-target
55753 - route-target-role
55757 description: VPN ID, globally unique within A&AI
55760 description: VPN Name
55761 global-route-target:
55763 description: Number used to identify a VPN, globally unique in the network
55766 description: the platform associated with the VPN example AVPN, Mobility
55769 description: Type of the vpn, should be taken from enumerated/valid values
55770 route-distinguisher:
55772 description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
55775 description: Role assigned to this route target
55778 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55782 $ref: "#/getDefinitions/relationship"
55783 description: l3-networks relate to vpn-bindings
55789 $ref: "#/getDefinitions/vpn-binding"
55792 Virtual Servers, aka virtual machine or VM.
55793 ###### Related Nodes
55794 - TO tenant( vserver BelongsTo tenant, MANY2ONE)
55795 - TO flavor( vserver Uses flavor, MANY2ONE)
55796 - TO image( vserver Uses image, MANY2ONE)
55797 - TO pserver( vserver HostedOn pserver, MANY2ONE)
55798 - TO snapshot( vserver Uses snapshot, ONE2ONE)
55799 - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
55800 - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
55801 - FROM vce( vce HostedOn vserver, ONE2MANY)
55802 - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
55803 - FROM vf-module( vf-module Uses vserver, ONE2MANY)
55804 - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
55806 -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
55807 -(2) IF this VSERVER node is deleted, this TO node is DELETED also
55813 - is-closed-loop-disabled
55817 description: Unique identifier for this vserver relative to its tenant
55820 description: Name of vserver
55823 description: Alternative name of vserver
55826 description: Trigger for operational monitoring of this resource by Service Assurance systems.
55829 description: URL to endpoint where AAI can get more details
55832 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.
55833 is-closed-loop-disabled:
55835 description: Used to indicate whether closed loop function is enabled on this node
55838 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55842 $ref: "#/getDefinitions/volume"
55846 $ref: "#/getDefinitions/relationship"
55850 $ref: "#/getDefinitions/l-interface"
55853 Collection of virtual Servers, aka virtual machines or VMs.
55858 $ref: "#/getDefinitions/vserver"
55861 A zone is a grouping of assets in a location homing to the same connections into the CBB
55862 ###### Related Nodes
55863 - TO complex( zone LocatedIn complex, MANY2ONE)
55864 - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
55865 - FROM pnf( pnf LocatedIn zone, MANY2ONE)
55866 - FROM pserver( pserver LocatedIn zone, MANY2ONE)
55876 description: Code assigned by AIC to the zone
55879 description: English name associated with the zone
55882 description: Design of zone [Medium/Large?]
55885 description: Context of zone [production/test]
55888 description: Status of a zone.
55891 description: Concurrency value
55895 $ref: "#/getDefinitions/relationship"
55898 Collection of zones
55903 $ref: "#/getDefinitions/zone"