5 [Differences versus the previous schema version](apidocs/aai_swagger_v10.diff)
7 Copyright © 2017 AT&T Intellectual Property. All rights reserved.
9 Licensed under the Creative Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except in compliance with the License.
11 You may obtain a copy of the License at
13 (https://creativecommons.org/licenses/by/4.0/)
15 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
17 ECOMP and OpenECOMP are trademarks and service marks of AT&T Intellectual Property.
19 This document is best viewed with Firefox or Chrome. Nodes can be found by appending /#/definitions/node-type-to-find to the path to this document. Edge definitions can be found with the node definitions.
21 title: Active and Available Inventory REST API
24 url: http://www.apache.org/licenses/LICENSE-2.0.html
34 /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship:
38 summary: see node definition for valid relationships
39 operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship
48 description: Response codes found in [response codes](https://wiki.onap.org/).
50 - name: physical-location-id
52 description: Unique identifier for physical location, e.g., CLLI
55 example: __PHYSICAL-LOCATION-ID__
58 description: The Target provider edge router
61 example: __TARGET-PE__
62 - name: availability-zone-name
64 description: Name of the availability zone
67 example: __AVAILABILITY-ZONE-NAME__
70 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)
73 $ref: "#/definitions/relationship"
77 summary: delete an existing relationship
78 description: delete an existing relationship
79 operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship
88 description: Response codes found in [response codes](https://wiki.onap.org/).
90 - name: physical-location-id
92 description: Unique identifier for physical location, e.g., CLLI
95 example: __PHYSICAL-LOCATION-ID__
98 description: The Target provider edge router
101 example: __TARGET-PE__
102 - name: availability-zone-name
104 description: Name of the availability zone
107 example: __AVAILABILITY-ZONE-NAME__
108 /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}:
111 - CloudInfrastructure
112 summary: returns ctag-pool
113 description: returns ctag-pool
114 operationId: getCloudInfrastructureComplexesComplexCtagPoolsCtagPool
120 description: successful operation
122 $ref: "#/getDefinitions/ctag-pool"
124 description: Response codes found in [response codes](https://wiki.onap.org/).
126 - name: physical-location-id
128 description: Unique identifier for physical location, e.g., CLLI
131 example: __PHYSICAL-LOCATION-ID__
134 description: The Target provider edge router
137 example: __TARGET-PE__
138 - name: availability-zone-name
140 description: Name of the availability zone
143 example: __AVAILABILITY-ZONE-NAME__
144 - name: data-center-code
146 description: Data center code which can be an alternate way to identify a complex
151 description: Gamma complex name for LCP instance.
156 description: URL of the keystone identity service
161 - CloudInfrastructure
162 summary: create or update an existing ctag-pool
164 Create or update an existing ctag-pool.
166 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
167 operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool
176 description: Response codes found in [response codes](https://wiki.onap.org/).
178 - name: physical-location-id
180 description: Unique identifier for physical location, e.g., CLLI
183 example: __PHYSICAL-LOCATION-ID__
186 description: The Target provider edge router
189 example: __TARGET-PE__
190 - name: availability-zone-name
192 description: Name of the availability zone
195 example: __AVAILABILITY-ZONE-NAME__
198 description: ctag-pool object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)
201 $ref: "#/definitions/ctag-pool"
204 - CloudInfrastructure
205 summary: update an existing ctag-pool
207 Update an existing ctag-pool
209 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
210 The PUT operation will entirely replace an existing object.
211 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
213 Other differences between PUT and PATCH are:
215 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
216 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
217 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
218 operationId: UpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool
227 description: Response codes found in [response codes](https://wiki.onap.org/).
229 - name: physical-location-id
231 description: Unique identifier for physical location, e.g., CLLI
234 example: __PHYSICAL-LOCATION-ID__
237 description: The Target provider edge router
240 example: __TARGET-PE__
241 - name: availability-zone-name
243 description: Name of the availability zone
246 example: __AVAILABILITY-ZONE-NAME__
249 description: ctag-pool object that needs to be created or updated.
252 $ref: "#/patchDefinitions/ctag-pool"
255 - CloudInfrastructure
256 summary: delete an existing ctag-pool
257 description: delete an existing ctag-pool
258 operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPool
267 description: Response codes found in [response codes](https://wiki.onap.org/).
269 - name: physical-location-id
271 description: Unique identifier for physical location, e.g., CLLI
274 example: __PHYSICAL-LOCATION-ID__
277 description: The Target provider edge router
280 example: __TARGET-PE__
281 - name: availability-zone-name
283 description: Name of the availability zone
286 example: __AVAILABILITY-ZONE-NAME__
287 - name: resource-version
289 description: resource-version for concurrency
292 /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools:
295 - CloudInfrastructure
296 summary: returns ctag-pools
297 description: returns ctag-pools
298 operationId: getCloudInfrastructureComplexesComplexCtagPools
304 description: successful operation
306 $ref: "#/getDefinitions/ctag-pools"
308 description: Response codes found in [response codes](https://wiki.onap.org/).
310 - name: physical-location-id
312 description: Unique identifier for physical location, e.g., CLLI
315 example: __PHYSICAL-LOCATION-ID__
316 - name: data-center-code
318 description: Data center code which can be an alternate way to identify a complex
323 description: Gamma complex name for LCP instance.
328 description: URL of the keystone identity service
331 /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship:
334 - CloudInfrastructure
335 summary: see node definition for valid relationships
336 operationId: createOrUpdateCloudInfrastructureComplexesComplexRelationshipListRelationship
345 description: Response codes found in [response codes](https://wiki.onap.org/).
347 - name: physical-location-id
349 description: Unique identifier for physical location, e.g., CLLI
352 example: __PHYSICAL-LOCATION-ID__
355 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureComplexesComplex.json)
358 $ref: "#/definitions/relationship"
361 - CloudInfrastructure
362 summary: delete an existing relationship
363 description: delete an existing relationship
364 operationId: deleteCloudInfrastructureComplexesComplexRelationshipListRelationship
373 description: Response codes found in [response codes](https://wiki.onap.org/).
375 - name: physical-location-id
377 description: Unique identifier for physical location, e.g., CLLI
380 example: __PHYSICAL-LOCATION-ID__
381 /cloud-infrastructure/complexes/complex/{physical-location-id}:
384 - CloudInfrastructure
385 summary: returns complex
386 description: returns complex
387 operationId: getCloudInfrastructureComplexesComplex
393 description: successful operation
395 $ref: "#/getDefinitions/complex"
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__
405 - name: data-center-code
407 description: Data center code which can be an alternate way to identify a complex
412 description: Gamma complex name for LCP instance.
417 description: URL of the keystone identity service
422 - CloudInfrastructure
423 summary: create or update an existing complex
425 Create or update an existing complex.
427 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
428 operationId: createOrUpdateCloudInfrastructureComplexesComplex
437 description: Response codes found in [response codes](https://wiki.onap.org/).
439 - name: physical-location-id
441 description: Unique identifier for physical location, e.g., CLLI
444 example: __PHYSICAL-LOCATION-ID__
447 description: complex object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureComplexesComplex.json)
450 $ref: "#/definitions/complex"
453 - CloudInfrastructure
454 summary: update an existing complex
456 Update an existing complex
458 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
459 The PUT operation will entirely replace an existing object.
460 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
462 Other differences between PUT and PATCH are:
464 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
465 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
466 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
467 operationId: UpdateCloudInfrastructureComplexesComplex
476 description: Response codes found in [response codes](https://wiki.onap.org/).
478 - name: physical-location-id
480 description: Unique identifier for physical location, e.g., CLLI
483 example: __PHYSICAL-LOCATION-ID__
486 description: complex object that needs to be created or updated.
489 $ref: "#/patchDefinitions/complex"
492 - CloudInfrastructure
493 summary: delete an existing complex
494 description: delete an existing complex
495 operationId: deleteCloudInfrastructureComplexesComplex
504 description: Response codes found in [response codes](https://wiki.onap.org/).
506 - name: physical-location-id
508 description: Unique identifier for physical location, e.g., CLLI
511 example: __PHYSICAL-LOCATION-ID__
512 - name: resource-version
514 description: resource-version for concurrency
517 /cloud-infrastructure/complexes:
520 - CloudInfrastructure
521 summary: returns complexes
522 description: returns complexes
523 operationId: getCloudInfrastructureComplexes
529 description: successful operation
531 $ref: "#/getDefinitions/complexes"
533 description: Response codes found in [response codes](https://wiki.onap.org/).
534 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship:
537 - CloudInfrastructure
538 summary: see node definition for valid relationships
539 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship
548 description: Response codes found in [response codes](https://wiki.onap.org/).
552 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
555 example: __CLOUD-OWNER__
556 - name: cloud-region-id
558 description: Identifier used by the vendor for the region. Second part of composite key
561 example: __CLOUD-REGION-ID__
562 - name: volume-group-id
564 description: Unique ID of volume-group.
567 example: __VOLUME-GROUP-ID__
570 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)
573 $ref: "#/definitions/relationship"
576 - CloudInfrastructure
577 summary: delete an existing relationship
578 description: delete an existing relationship
579 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship
588 description: Response codes found in [response codes](https://wiki.onap.org/).
592 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
595 example: __CLOUD-OWNER__
596 - name: cloud-region-id
598 description: Identifier used by the vendor for the region. Second part of composite key
601 example: __CLOUD-REGION-ID__
602 - name: volume-group-id
604 description: Unique ID of volume-group.
607 example: __VOLUME-GROUP-ID__
608 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}:
611 - CloudInfrastructure
612 summary: returns volume-group
613 description: returns volume-group
614 operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
620 description: successful operation
622 $ref: "#/getDefinitions/volume-group"
624 description: Response codes found in [response codes](https://wiki.onap.org/).
628 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
631 example: __CLOUD-OWNER__
632 - name: cloud-region-id
634 description: Identifier used by the vendor for the region. Second part of composite key
637 example: __CLOUD-REGION-ID__
638 - name: volume-group-id
640 description: Unique ID of volume-group.
643 example: __VOLUME-GROUP-ID__
646 description: Type of the cloud (e.g., openstack)
649 - name: owner-defined-type
651 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
654 - name: volume-group-name
656 description: Name of the volume group.
659 - name: heat-stack-id
661 description: Heat stack id corresponding to this volume-group
666 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.
671 - CloudInfrastructure
672 summary: create or update an existing volume-group
674 Create or update an existing volume-group.
676 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
677 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
686 description: Response codes found in [response codes](https://wiki.onap.org/).
690 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
693 example: __CLOUD-OWNER__
694 - name: cloud-region-id
696 description: Identifier used by the vendor for the region. Second part of composite key
699 example: __CLOUD-REGION-ID__
700 - name: volume-group-id
702 description: Unique ID of volume-group.
705 example: __VOLUME-GROUP-ID__
708 description: volume-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)
711 $ref: "#/definitions/volume-group"
714 - CloudInfrastructure
715 summary: update an existing volume-group
717 Update an existing volume-group
719 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
720 The PUT operation will entirely replace an existing object.
721 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
723 Other differences between PUT and PATCH are:
725 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
726 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
727 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
728 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
737 description: Response codes found in [response codes](https://wiki.onap.org/).
741 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
744 example: __CLOUD-OWNER__
745 - name: cloud-region-id
747 description: Identifier used by the vendor for the region. Second part of composite key
750 example: __CLOUD-REGION-ID__
751 - name: volume-group-id
753 description: Unique ID of volume-group.
756 example: __VOLUME-GROUP-ID__
759 description: volume-group object that needs to be created or updated.
762 $ref: "#/patchDefinitions/volume-group"
765 - CloudInfrastructure
766 summary: delete an existing volume-group
767 description: delete an existing volume-group
768 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
777 description: Response codes found in [response codes](https://wiki.onap.org/).
781 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
784 example: __CLOUD-OWNER__
785 - name: cloud-region-id
787 description: Identifier used by the vendor for the region. Second part of composite key
790 example: __CLOUD-REGION-ID__
791 - name: volume-group-id
793 description: Unique ID of volume-group.
796 example: __VOLUME-GROUP-ID__
797 - name: resource-version
799 description: resource-version for concurrency
802 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups:
805 - CloudInfrastructure
806 summary: returns volume-groups
807 description: returns volume-groups
808 operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroups
814 description: successful operation
816 $ref: "#/getDefinitions/volume-groups"
818 description: Response codes found in [response codes](https://wiki.onap.org/).
822 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
825 example: __CLOUD-OWNER__
826 - name: cloud-region-id
828 description: Identifier used by the vendor for the region. Second part of composite key
831 example: __CLOUD-REGION-ID__
834 description: Type of the cloud (e.g., openstack)
837 - name: owner-defined-type
839 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
842 /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:
845 - CloudInfrastructure
846 summary: see node definition for valid relationships
847 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship
856 description: Response codes found in [response codes](https://wiki.onap.org/).
860 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
863 example: __CLOUD-OWNER__
864 - name: cloud-region-id
866 description: Identifier used by the vendor for the region. Second part of composite key
869 example: __CLOUD-REGION-ID__
872 description: Unique id relative to the cloud-region.
875 example: __TENANT-ID__
878 description: Unique identifier for this vserver relative to its tenant
881 example: __VSERVER-ID__
884 description: Unique ID of block storage volume relative to the vserver.
887 example: __VOLUME-ID__
890 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
893 $ref: "#/definitions/relationship"
896 - CloudInfrastructure
897 summary: delete an existing relationship
898 description: delete an existing relationship
899 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship
908 description: Response codes found in [response codes](https://wiki.onap.org/).
912 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
915 example: __CLOUD-OWNER__
916 - name: cloud-region-id
918 description: Identifier used by the vendor for the region. Second part of composite key
921 example: __CLOUD-REGION-ID__
924 description: Unique id relative to the cloud-region.
927 example: __TENANT-ID__
930 description: Unique identifier for this vserver relative to its tenant
933 example: __VSERVER-ID__
936 description: Unique ID of block storage volume relative to the vserver.
939 example: __VOLUME-ID__
940 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}:
943 - CloudInfrastructure
944 summary: returns volume
945 description: returns volume
946 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
952 description: successful operation
954 $ref: "#/getDefinitions/volume"
956 description: Response codes found in [response codes](https://wiki.onap.org/).
960 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
963 example: __CLOUD-OWNER__
964 - name: cloud-region-id
966 description: Identifier used by the vendor for the region. Second part of composite key
969 example: __CLOUD-REGION-ID__
972 description: Unique id relative to the cloud-region.
975 example: __TENANT-ID__
978 description: Unique identifier for this vserver relative to its tenant
981 example: __VSERVER-ID__
984 description: Unique ID of block storage volume relative to the vserver.
987 example: __VOLUME-ID__
990 description: Type of the cloud (e.g., openstack)
993 - name: owner-defined-type
995 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
1000 description: Readable name of tenant
1003 - name: vserver-name
1005 description: Name of vserver
1008 - name: vserver-name2
1010 description: Alternative name of vserver
1015 description: Trigger for operational monitoring of this resource by Service Assurance systems.
1022 - name: is-closed-loop-disabled
1028 - CloudInfrastructure
1029 summary: create or update an existing volume
1031 Create or update an existing volume.
1033 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
1034 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
1043 description: Response codes found in [response codes](https://wiki.onap.org/).
1047 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1050 example: __CLOUD-OWNER__
1051 - name: cloud-region-id
1053 description: Identifier used by the vendor for the region. Second part of composite key
1056 example: __CLOUD-REGION-ID__
1059 description: Unique id relative to the cloud-region.
1062 example: __TENANT-ID__
1065 description: Unique identifier for this vserver relative to its tenant
1068 example: __VSERVER-ID__
1071 description: Unique ID of block storage volume relative to the vserver.
1074 example: __VOLUME-ID__
1077 description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
1080 $ref: "#/definitions/volume"
1083 - CloudInfrastructure
1084 summary: update an existing volume
1086 Update an existing volume
1088 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
1089 The PUT operation will entirely replace an existing object.
1090 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
1092 Other differences between PUT and PATCH are:
1094 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
1095 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
1096 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
1097 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
1106 description: Response codes found in [response codes](https://wiki.onap.org/).
1110 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1113 example: __CLOUD-OWNER__
1114 - name: cloud-region-id
1116 description: Identifier used by the vendor for the region. Second part of composite key
1119 example: __CLOUD-REGION-ID__
1122 description: Unique id relative to the cloud-region.
1125 example: __TENANT-ID__
1128 description: Unique identifier for this vserver relative to its tenant
1131 example: __VSERVER-ID__
1134 description: Unique ID of block storage volume relative to the vserver.
1137 example: __VOLUME-ID__
1140 description: volume object that needs to be created or updated.
1143 $ref: "#/patchDefinitions/volume"
1146 - CloudInfrastructure
1147 summary: delete an existing volume
1148 description: delete an existing volume
1149 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
1158 description: Response codes found in [response codes](https://wiki.onap.org/).
1162 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1165 example: __CLOUD-OWNER__
1166 - name: cloud-region-id
1168 description: Identifier used by the vendor for the region. Second part of composite key
1171 example: __CLOUD-REGION-ID__
1174 description: Unique id relative to the cloud-region.
1177 example: __TENANT-ID__
1180 description: Unique identifier for this vserver relative to its tenant
1183 example: __VSERVER-ID__
1186 description: Unique ID of block storage volume relative to the vserver.
1189 example: __VOLUME-ID__
1190 - name: resource-version
1192 description: resource-version for concurrency
1195 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes:
1198 - CloudInfrastructure
1199 summary: returns volumes
1200 description: returns volumes
1201 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumes
1207 description: successful operation
1209 $ref: "#/getDefinitions/volumes"
1211 description: Response codes found in [response codes](https://wiki.onap.org/).
1215 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1218 example: __CLOUD-OWNER__
1219 - name: cloud-region-id
1221 description: Identifier used by the vendor for the region. Second part of composite key
1224 example: __CLOUD-REGION-ID__
1227 description: Unique id relative to the cloud-region.
1230 example: __TENANT-ID__
1233 description: Unique identifier for this vserver relative to its tenant
1236 example: __VSERVER-ID__
1239 description: Type of the cloud (e.g., openstack)
1242 - name: owner-defined-type
1244 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
1249 description: Readable name of tenant
1252 - name: vserver-name
1254 description: Name of vserver
1257 - name: vserver-name2
1259 description: Alternative name of vserver
1264 description: Trigger for operational monitoring of this resource by Service Assurance systems.
1271 - name: is-closed-loop-disabled
1275 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship:
1278 - CloudInfrastructure
1279 summary: see node definition for valid relationships
1280 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship
1289 description: Response codes found in [response codes](https://wiki.onap.org/).
1293 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1296 example: __CLOUD-OWNER__
1297 - name: cloud-region-id
1299 description: Identifier used by the vendor for the region. Second part of composite key
1302 example: __CLOUD-REGION-ID__
1305 description: Unique id relative to the cloud-region.
1308 example: __TENANT-ID__
1311 description: Unique identifier for this vserver relative to its tenant
1314 example: __VSERVER-ID__
1317 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)
1320 $ref: "#/definitions/relationship"
1323 - CloudInfrastructure
1324 summary: delete an existing relationship
1325 description: delete an existing relationship
1326 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship
1335 description: Response codes found in [response codes](https://wiki.onap.org/).
1339 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1342 example: __CLOUD-OWNER__
1343 - name: cloud-region-id
1345 description: Identifier used by the vendor for the region. Second part of composite key
1348 example: __CLOUD-REGION-ID__
1351 description: Unique id relative to the cloud-region.
1354 example: __TENANT-ID__
1357 description: Unique identifier for this vserver relative to its tenant
1360 example: __VSERVER-ID__
1361 /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:
1364 - CloudInfrastructure
1365 summary: see node definition for valid relationships
1366 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship
1375 description: Response codes found in [response codes](https://wiki.onap.org/).
1379 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1382 example: __CLOUD-OWNER__
1383 - name: cloud-region-id
1385 description: Identifier used by the vendor for the region. Second part of composite key
1388 example: __CLOUD-REGION-ID__
1391 description: Unique id relative to the cloud-region.
1394 example: __TENANT-ID__
1397 description: Unique identifier for this vserver relative to its tenant
1400 example: __VSERVER-ID__
1401 - name: interface-name
1403 description: Name given to the interface
1406 example: __INTERFACE-NAME__
1407 - name: vlan-interface
1409 description: String that identifies the interface
1412 example: __VLAN-INTERFACE__
1415 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)
1418 $ref: "#/definitions/relationship"
1421 - CloudInfrastructure
1422 summary: delete an existing relationship
1423 description: delete an existing relationship
1424 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship
1433 description: Response codes found in [response codes](https://wiki.onap.org/).
1437 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1440 example: __CLOUD-OWNER__
1441 - name: cloud-region-id
1443 description: Identifier used by the vendor for the region. Second part of composite key
1446 example: __CLOUD-REGION-ID__
1449 description: Unique id relative to the cloud-region.
1452 example: __TENANT-ID__
1455 description: Unique identifier for this vserver relative to its tenant
1458 example: __VSERVER-ID__
1459 - name: interface-name
1461 description: Name given to the interface
1464 example: __INTERFACE-NAME__
1465 - name: vlan-interface
1467 description: String that identifies the interface
1470 example: __VLAN-INTERFACE__
1471 /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:
1474 - CloudInfrastructure
1475 summary: see node definition for valid relationships
1476 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
1485 description: Response codes found in [response codes](https://wiki.onap.org/).
1489 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1492 example: __CLOUD-OWNER__
1493 - name: cloud-region-id
1495 description: Identifier used by the vendor for the region. Second part of composite key
1498 example: __CLOUD-REGION-ID__
1501 description: Unique id relative to the cloud-region.
1504 example: __TENANT-ID__
1507 description: Unique identifier for this vserver relative to its tenant
1510 example: __VSERVER-ID__
1511 - name: interface-name
1513 description: Name given to the interface
1516 example: __INTERFACE-NAME__
1517 - name: vlan-interface
1519 description: String that identifies the interface
1522 example: __VLAN-INTERFACE__
1523 - name: l3-interface-ipv4-address
1525 description: IP address
1528 example: __L3-INTERFACE-IPV4-ADDRESS__
1531 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
1534 $ref: "#/definitions/relationship"
1537 - CloudInfrastructure
1538 summary: delete an existing relationship
1539 description: delete an existing relationship
1540 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
1549 description: Response codes found in [response codes](https://wiki.onap.org/).
1553 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1556 example: __CLOUD-OWNER__
1557 - name: cloud-region-id
1559 description: Identifier used by the vendor for the region. Second part of composite key
1562 example: __CLOUD-REGION-ID__
1565 description: Unique id relative to the cloud-region.
1568 example: __TENANT-ID__
1571 description: Unique identifier for this vserver relative to its tenant
1574 example: __VSERVER-ID__
1575 - name: interface-name
1577 description: Name given to the interface
1580 example: __INTERFACE-NAME__
1581 - name: vlan-interface
1583 description: String that identifies the interface
1586 example: __VLAN-INTERFACE__
1587 - name: l3-interface-ipv4-address
1589 description: IP address
1592 example: __L3-INTERFACE-IPV4-ADDRESS__
1593 /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}:
1596 - CloudInfrastructure
1597 summary: returns l3-interface-ipv4-address-list
1598 description: returns l3-interface-ipv4-address-list
1599 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1605 description: successful operation
1607 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
1609 description: Response codes found in [response codes](https://wiki.onap.org/).
1613 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1616 example: __CLOUD-OWNER__
1617 - name: cloud-region-id
1619 description: Identifier used by the vendor for the region. Second part of composite key
1622 example: __CLOUD-REGION-ID__
1625 description: Unique id relative to the cloud-region.
1628 example: __TENANT-ID__
1631 description: Unique identifier for this vserver relative to its tenant
1634 example: __VSERVER-ID__
1635 - name: interface-name
1637 description: Name given to the interface
1640 example: __INTERFACE-NAME__
1641 - name: vlan-interface
1643 description: String that identifies the interface
1646 example: __VLAN-INTERFACE__
1647 - name: l3-interface-ipv4-address
1649 description: IP address
1652 example: __L3-INTERFACE-IPV4-ADDRESS__
1655 description: Type of the cloud (e.g., openstack)
1658 - name: owner-defined-type
1660 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
1665 description: Readable name of tenant
1668 - name: vserver-name
1670 description: Name of vserver
1673 - name: vserver-name2
1675 description: Alternative name of vserver
1680 description: Trigger for operational monitoring of this resource by Service Assurance systems.
1687 - name: is-closed-loop-disabled
1691 - name: interface-id
1693 description: ID of interface
1698 description: MAC address for the interface
1701 - name: network-name
1703 description: Name of the network
1706 - name: vlan-id-inner
1708 description: Inner VLAN tag
1714 description: This indicates the customers VPN ID associated with this vlan
1717 - name: vlan-id-inner
1719 description: Inner VLAN tag
1723 - name: neutron-network-id
1725 description: Neutron network id of the interface that address belongs to
1728 - name: neutron-subnet-id
1730 description: Neutron id of subnet that address belongs to
1735 - CloudInfrastructure
1736 summary: create or update an existing l3-interface-ipv4-address-list
1738 Create or update an existing l3-interface-ipv4-address-list.
1740 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
1741 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1750 description: Response codes found in [response codes](https://wiki.onap.org/).
1754 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1757 example: __CLOUD-OWNER__
1758 - name: cloud-region-id
1760 description: Identifier used by the vendor for the region. Second part of composite key
1763 example: __CLOUD-REGION-ID__
1766 description: Unique id relative to the cloud-region.
1769 example: __TENANT-ID__
1772 description: Unique identifier for this vserver relative to its tenant
1775 example: __VSERVER-ID__
1776 - name: interface-name
1778 description: Name given to the interface
1781 example: __INTERFACE-NAME__
1782 - name: vlan-interface
1784 description: String that identifies the interface
1787 example: __VLAN-INTERFACE__
1788 - name: l3-interface-ipv4-address
1790 description: IP address
1793 example: __L3-INTERFACE-IPV4-ADDRESS__
1796 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
1799 $ref: "#/definitions/l3-interface-ipv4-address-list"
1802 - CloudInfrastructure
1803 summary: update an existing l3-interface-ipv4-address-list
1805 Update an existing l3-interface-ipv4-address-list
1807 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
1808 The PUT operation will entirely replace an existing object.
1809 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
1811 Other differences between PUT and PATCH are:
1813 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
1814 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
1815 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
1816 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1825 description: Response codes found in [response codes](https://wiki.onap.org/).
1829 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1832 example: __CLOUD-OWNER__
1833 - name: cloud-region-id
1835 description: Identifier used by the vendor for the region. Second part of composite key
1838 example: __CLOUD-REGION-ID__
1841 description: Unique id relative to the cloud-region.
1844 example: __TENANT-ID__
1847 description: Unique identifier for this vserver relative to its tenant
1850 example: __VSERVER-ID__
1851 - name: interface-name
1853 description: Name given to the interface
1856 example: __INTERFACE-NAME__
1857 - name: vlan-interface
1859 description: String that identifies the interface
1862 example: __VLAN-INTERFACE__
1863 - name: l3-interface-ipv4-address
1865 description: IP address
1868 example: __L3-INTERFACE-IPV4-ADDRESS__
1871 description: l3-interface-ipv4-address-list object that needs to be created or updated.
1874 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
1877 - CloudInfrastructure
1878 summary: delete an existing l3-interface-ipv4-address-list
1879 description: delete an existing l3-interface-ipv4-address-list
1880 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1889 description: Response codes found in [response codes](https://wiki.onap.org/).
1893 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1896 example: __CLOUD-OWNER__
1897 - name: cloud-region-id
1899 description: Identifier used by the vendor for the region. Second part of composite key
1902 example: __CLOUD-REGION-ID__
1905 description: Unique id relative to the cloud-region.
1908 example: __TENANT-ID__
1911 description: Unique identifier for this vserver relative to its tenant
1914 example: __VSERVER-ID__
1915 - name: interface-name
1917 description: Name given to the interface
1920 example: __INTERFACE-NAME__
1921 - name: vlan-interface
1923 description: String that identifies the interface
1926 example: __VLAN-INTERFACE__
1927 - name: l3-interface-ipv4-address
1929 description: IP address
1932 example: __L3-INTERFACE-IPV4-ADDRESS__
1933 - name: resource-version
1935 description: resource-version for concurrency
1938 /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:
1941 - CloudInfrastructure
1942 summary: see node definition for valid relationships
1943 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
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: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
2001 $ref: "#/definitions/relationship"
2004 - CloudInfrastructure
2005 summary: delete an existing relationship
2006 description: delete an existing relationship
2007 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
2016 description: Response codes found in [response codes](https://wiki.onap.org/).
2020 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2023 example: __CLOUD-OWNER__
2024 - name: cloud-region-id
2026 description: Identifier used by the vendor for the region. Second part of composite key
2029 example: __CLOUD-REGION-ID__
2032 description: Unique id relative to the cloud-region.
2035 example: __TENANT-ID__
2038 description: Unique identifier for this vserver relative to its tenant
2041 example: __VSERVER-ID__
2042 - name: interface-name
2044 description: Name given to the interface
2047 example: __INTERFACE-NAME__
2048 - name: vlan-interface
2050 description: String that identifies the interface
2053 example: __VLAN-INTERFACE__
2054 - name: l3-interface-ipv6-address
2056 description: IP address
2059 example: __L3-INTERFACE-IPV6-ADDRESS__
2060 /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}:
2063 - CloudInfrastructure
2064 summary: returns l3-interface-ipv6-address-list
2065 description: returns l3-interface-ipv6-address-list
2066 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
2072 description: successful operation
2074 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
2076 description: Response codes found in [response codes](https://wiki.onap.org/).
2080 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2083 example: __CLOUD-OWNER__
2084 - name: cloud-region-id
2086 description: Identifier used by the vendor for the region. Second part of composite key
2089 example: __CLOUD-REGION-ID__
2092 description: Unique id relative to the cloud-region.
2095 example: __TENANT-ID__
2098 description: Unique identifier for this vserver relative to its tenant
2101 example: __VSERVER-ID__
2102 - name: interface-name
2104 description: Name given to the interface
2107 example: __INTERFACE-NAME__
2108 - name: vlan-interface
2110 description: String that identifies the interface
2113 example: __VLAN-INTERFACE__
2114 - name: l3-interface-ipv6-address
2116 description: IP address
2119 example: __L3-INTERFACE-IPV6-ADDRESS__
2122 description: Type of the cloud (e.g., openstack)
2125 - name: owner-defined-type
2127 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
2132 description: Readable name of tenant
2135 - name: vserver-name
2137 description: Name of vserver
2140 - name: vserver-name2
2142 description: Alternative name of vserver
2147 description: Trigger for operational monitoring of this resource by Service Assurance systems.
2154 - name: is-closed-loop-disabled
2158 - name: interface-id
2160 description: ID of interface
2165 description: MAC address for the interface
2168 - name: network-name
2170 description: Name of the network
2173 - name: vlan-id-inner
2175 description: Inner VLAN tag
2181 description: This indicates the customers VPN ID associated with this vlan
2184 - name: vlan-id-inner
2186 description: Inner VLAN tag
2190 - name: neutron-network-id
2192 description: Neutron network id of the interface that address belongs to
2195 - name: neutron-subnet-id
2197 description: Neutron id of subnet that address belongs to
2202 - CloudInfrastructure
2203 summary: create or update an existing l3-interface-ipv6-address-list
2205 Create or update an existing l3-interface-ipv6-address-list.
2207 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
2208 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
2217 description: Response codes found in [response codes](https://wiki.onap.org/).
2221 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2224 example: __CLOUD-OWNER__
2225 - name: cloud-region-id
2227 description: Identifier used by the vendor for the region. Second part of composite key
2230 example: __CLOUD-REGION-ID__
2233 description: Unique id relative to the cloud-region.
2236 example: __TENANT-ID__
2239 description: Unique identifier for this vserver relative to its tenant
2242 example: __VSERVER-ID__
2243 - name: interface-name
2245 description: Name given to the interface
2248 example: __INTERFACE-NAME__
2249 - name: vlan-interface
2251 description: String that identifies the interface
2254 example: __VLAN-INTERFACE__
2255 - name: l3-interface-ipv6-address
2257 description: IP address
2260 example: __L3-INTERFACE-IPV6-ADDRESS__
2263 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
2266 $ref: "#/definitions/l3-interface-ipv6-address-list"
2269 - CloudInfrastructure
2270 summary: update an existing l3-interface-ipv6-address-list
2272 Update an existing l3-interface-ipv6-address-list
2274 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
2275 The PUT operation will entirely replace an existing object.
2276 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
2278 Other differences between PUT and PATCH are:
2280 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
2281 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
2282 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
2283 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
2292 description: Response codes found in [response codes](https://wiki.onap.org/).
2296 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2299 example: __CLOUD-OWNER__
2300 - name: cloud-region-id
2302 description: Identifier used by the vendor for the region. Second part of composite key
2305 example: __CLOUD-REGION-ID__
2308 description: Unique id relative to the cloud-region.
2311 example: __TENANT-ID__
2314 description: Unique identifier for this vserver relative to its tenant
2317 example: __VSERVER-ID__
2318 - name: interface-name
2320 description: Name given to the interface
2323 example: __INTERFACE-NAME__
2324 - name: vlan-interface
2326 description: String that identifies the interface
2329 example: __VLAN-INTERFACE__
2330 - name: l3-interface-ipv6-address
2332 description: IP address
2335 example: __L3-INTERFACE-IPV6-ADDRESS__
2338 description: l3-interface-ipv6-address-list object that needs to be created or updated.
2341 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
2344 - CloudInfrastructure
2345 summary: delete an existing l3-interface-ipv6-address-list
2346 description: delete an existing l3-interface-ipv6-address-list
2347 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
2356 description: Response codes found in [response codes](https://wiki.onap.org/).
2360 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2363 example: __CLOUD-OWNER__
2364 - name: cloud-region-id
2366 description: Identifier used by the vendor for the region. Second part of composite key
2369 example: __CLOUD-REGION-ID__
2372 description: Unique id relative to the cloud-region.
2375 example: __TENANT-ID__
2378 description: Unique identifier for this vserver relative to its tenant
2381 example: __VSERVER-ID__
2382 - name: interface-name
2384 description: Name given to the interface
2387 example: __INTERFACE-NAME__
2388 - name: vlan-interface
2390 description: String that identifies the interface
2393 example: __VLAN-INTERFACE__
2394 - name: l3-interface-ipv6-address
2396 description: IP address
2399 example: __L3-INTERFACE-IPV6-ADDRESS__
2400 - name: resource-version
2402 description: resource-version for concurrency
2405 /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}:
2408 - CloudInfrastructure
2409 summary: returns vlan
2410 description: returns vlan
2411 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2417 description: successful operation
2419 $ref: "#/getDefinitions/vlan"
2421 description: Response codes found in [response codes](https://wiki.onap.org/).
2425 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2428 example: __CLOUD-OWNER__
2429 - name: cloud-region-id
2431 description: Identifier used by the vendor for the region. Second part of composite key
2434 example: __CLOUD-REGION-ID__
2437 description: Unique id relative to the cloud-region.
2440 example: __TENANT-ID__
2443 description: Unique identifier for this vserver relative to its tenant
2446 example: __VSERVER-ID__
2447 - name: interface-name
2449 description: Name given to the interface
2452 example: __INTERFACE-NAME__
2453 - name: vlan-interface
2455 description: String that identifies the interface
2458 example: __VLAN-INTERFACE__
2461 description: Type of the cloud (e.g., openstack)
2464 - name: owner-defined-type
2466 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
2471 description: Readable name of tenant
2474 - name: vserver-name
2476 description: Name of vserver
2479 - name: vserver-name2
2481 description: Alternative name of vserver
2486 description: Trigger for operational monitoring of this resource by Service Assurance systems.
2493 - name: is-closed-loop-disabled
2497 - name: interface-id
2499 description: ID of interface
2504 description: MAC address for the interface
2507 - name: network-name
2509 description: Name of the network
2512 - name: vlan-id-inner
2514 description: Inner VLAN tag
2520 description: This indicates the customers VPN ID associated with this vlan
2525 - CloudInfrastructure
2526 summary: create or update an existing vlan
2528 Create or update an existing vlan.
2530 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
2531 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2540 description: Response codes found in [response codes](https://wiki.onap.org/).
2544 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2547 example: __CLOUD-OWNER__
2548 - name: cloud-region-id
2550 description: Identifier used by the vendor for the region. Second part of composite key
2553 example: __CLOUD-REGION-ID__
2556 description: Unique id relative to the cloud-region.
2559 example: __TENANT-ID__
2562 description: Unique identifier for this vserver relative to its tenant
2565 example: __VSERVER-ID__
2566 - name: interface-name
2568 description: Name given to the interface
2571 example: __INTERFACE-NAME__
2572 - name: vlan-interface
2574 description: String that identifies the interface
2577 example: __VLAN-INTERFACE__
2580 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)
2583 $ref: "#/definitions/vlan"
2586 - CloudInfrastructure
2587 summary: update an existing vlan
2589 Update an existing vlan
2591 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
2592 The PUT operation will entirely replace an existing object.
2593 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
2595 Other differences between PUT and PATCH are:
2597 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
2598 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
2599 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
2600 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2609 description: Response codes found in [response codes](https://wiki.onap.org/).
2613 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2616 example: __CLOUD-OWNER__
2617 - name: cloud-region-id
2619 description: Identifier used by the vendor for the region. Second part of composite key
2622 example: __CLOUD-REGION-ID__
2625 description: Unique id relative to the cloud-region.
2628 example: __TENANT-ID__
2631 description: Unique identifier for this vserver relative to its tenant
2634 example: __VSERVER-ID__
2635 - name: interface-name
2637 description: Name given to the interface
2640 example: __INTERFACE-NAME__
2641 - name: vlan-interface
2643 description: String that identifies the interface
2646 example: __VLAN-INTERFACE__
2649 description: vlan object that needs to be created or updated.
2652 $ref: "#/patchDefinitions/vlan"
2655 - CloudInfrastructure
2656 summary: delete an existing vlan
2657 description: delete an existing vlan
2658 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2667 description: Response codes found in [response codes](https://wiki.onap.org/).
2671 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2674 example: __CLOUD-OWNER__
2675 - name: cloud-region-id
2677 description: Identifier used by the vendor for the region. Second part of composite key
2680 example: __CLOUD-REGION-ID__
2683 description: Unique id relative to the cloud-region.
2686 example: __TENANT-ID__
2689 description: Unique identifier for this vserver relative to its tenant
2692 example: __VSERVER-ID__
2693 - name: interface-name
2695 description: Name given to the interface
2698 example: __INTERFACE-NAME__
2699 - name: vlan-interface
2701 description: String that identifies the interface
2704 example: __VLAN-INTERFACE__
2705 - name: resource-version
2707 description: resource-version for concurrency
2710 /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:
2713 - CloudInfrastructure
2714 summary: returns vlans
2715 description: returns vlans
2716 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlans
2722 description: successful operation
2724 $ref: "#/getDefinitions/vlans"
2726 description: Response codes found in [response codes](https://wiki.onap.org/).
2730 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2733 example: __CLOUD-OWNER__
2734 - name: cloud-region-id
2736 description: Identifier used by the vendor for the region. Second part of composite key
2739 example: __CLOUD-REGION-ID__
2742 description: Unique id relative to the cloud-region.
2745 example: __TENANT-ID__
2748 description: Unique identifier for this vserver relative to its tenant
2751 example: __VSERVER-ID__
2752 - name: interface-name
2754 description: Name given to the interface
2757 example: __INTERFACE-NAME__
2760 description: Type of the cloud (e.g., openstack)
2763 - name: owner-defined-type
2765 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
2770 description: Readable name of tenant
2773 - name: vserver-name
2775 description: Name of vserver
2778 - name: vserver-name2
2780 description: Alternative name of vserver
2785 description: Trigger for operational monitoring of this resource by Service Assurance systems.
2792 - name: is-closed-loop-disabled
2796 - name: interface-id
2798 description: ID of interface
2803 description: MAC address for the interface
2806 - name: network-name
2808 description: Name of the network
2811 /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:
2814 - CloudInfrastructure
2815 summary: see node definition for valid relationships
2816 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
2825 description: Response codes found in [response codes](https://wiki.onap.org/).
2829 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2832 example: __CLOUD-OWNER__
2833 - name: cloud-region-id
2835 description: Identifier used by the vendor for the region. Second part of composite key
2838 example: __CLOUD-REGION-ID__
2841 description: Unique id relative to the cloud-region.
2844 example: __TENANT-ID__
2847 description: Unique identifier for this vserver relative to its tenant
2850 example: __VSERVER-ID__
2851 - name: interface-name
2853 description: Name given to the interface
2856 example: __INTERFACE-NAME__
2859 description: PCI ID used to identify the sriov-vf
2865 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)
2868 $ref: "#/definitions/relationship"
2871 - CloudInfrastructure
2872 summary: delete an existing relationship
2873 description: delete an existing relationship
2874 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
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: PCI ID used to identify the sriov-vf
2921 /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}:
2924 - CloudInfrastructure
2925 summary: returns sriov-vf
2926 description: returns sriov-vf
2927 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
2933 description: successful operation
2935 $ref: "#/getDefinitions/sriov-vf"
2937 description: Response codes found in [response codes](https://wiki.onap.org/).
2941 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2944 example: __CLOUD-OWNER__
2945 - name: cloud-region-id
2947 description: Identifier used by the vendor for the region. Second part of composite key
2950 example: __CLOUD-REGION-ID__
2953 description: Unique id relative to the cloud-region.
2956 example: __TENANT-ID__
2959 description: Unique identifier for this vserver relative to its tenant
2962 example: __VSERVER-ID__
2963 - name: interface-name
2965 description: Name given to the interface
2968 example: __INTERFACE-NAME__
2971 description: PCI ID used to identify the sriov-vf
2977 description: Type of the cloud (e.g., openstack)
2980 - name: owner-defined-type
2982 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
2987 description: Readable name of tenant
2990 - name: vserver-name
2992 description: Name of vserver
2995 - name: vserver-name2
2997 description: Alternative name of vserver
3002 description: Trigger for operational monitoring of this resource by Service Assurance systems.
3009 - name: is-closed-loop-disabled
3013 - name: interface-id
3015 description: ID of interface
3020 description: MAC address for the interface
3023 - name: network-name
3025 description: Name of the network
3028 - name: vf-vlan-filter
3030 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
3033 - name: vf-mac-filter
3035 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
3038 - name: vf-vlan-strip
3040 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
3043 - name: neutron-network-id
3045 description: Neutron network id of the interface
3050 - CloudInfrastructure
3051 summary: create or update an existing sriov-vf
3053 Create or update an existing sriov-vf.
3055 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
3056 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
3065 description: Response codes found in [response codes](https://wiki.onap.org/).
3069 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3072 example: __CLOUD-OWNER__
3073 - name: cloud-region-id
3075 description: Identifier used by the vendor for the region. Second part of composite key
3078 example: __CLOUD-REGION-ID__
3081 description: Unique id relative to the cloud-region.
3084 example: __TENANT-ID__
3087 description: Unique identifier for this vserver relative to its tenant
3090 example: __VSERVER-ID__
3091 - name: interface-name
3093 description: Name given to the interface
3096 example: __INTERFACE-NAME__
3099 description: PCI ID used to identify the sriov-vf
3105 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)
3108 $ref: "#/definitions/sriov-vf"
3111 - CloudInfrastructure
3112 summary: update an existing sriov-vf
3114 Update an existing sriov-vf
3116 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
3117 The PUT operation will entirely replace an existing object.
3118 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
3120 Other differences between PUT and PATCH are:
3122 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
3123 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
3124 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
3125 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
3134 description: Response codes found in [response codes](https://wiki.onap.org/).
3138 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3141 example: __CLOUD-OWNER__
3142 - name: cloud-region-id
3144 description: Identifier used by the vendor for the region. Second part of composite key
3147 example: __CLOUD-REGION-ID__
3150 description: Unique id relative to the cloud-region.
3153 example: __TENANT-ID__
3156 description: Unique identifier for this vserver relative to its tenant
3159 example: __VSERVER-ID__
3160 - name: interface-name
3162 description: Name given to the interface
3165 example: __INTERFACE-NAME__
3168 description: PCI ID used to identify the sriov-vf
3174 description: sriov-vf object that needs to be created or updated.
3177 $ref: "#/patchDefinitions/sriov-vf"
3180 - CloudInfrastructure
3181 summary: delete an existing sriov-vf
3182 description: delete an existing sriov-vf
3183 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
3192 description: Response codes found in [response codes](https://wiki.onap.org/).
3196 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3199 example: __CLOUD-OWNER__
3200 - name: cloud-region-id
3202 description: Identifier used by the vendor for the region. Second part of composite key
3205 example: __CLOUD-REGION-ID__
3208 description: Unique id relative to the cloud-region.
3211 example: __TENANT-ID__
3214 description: Unique identifier for this vserver relative to its tenant
3217 example: __VSERVER-ID__
3218 - name: interface-name
3220 description: Name given to the interface
3223 example: __INTERFACE-NAME__
3226 description: PCI ID used to identify the sriov-vf
3230 - name: resource-version
3232 description: resource-version for concurrency
3235 /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:
3238 - CloudInfrastructure
3239 summary: returns sriov-vfs
3240 description: returns sriov-vfs
3241 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfs
3247 description: successful operation
3249 $ref: "#/getDefinitions/sriov-vfs"
3251 description: Response codes found in [response codes](https://wiki.onap.org/).
3255 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3258 example: __CLOUD-OWNER__
3259 - name: cloud-region-id
3261 description: Identifier used by the vendor for the region. Second part of composite key
3264 example: __CLOUD-REGION-ID__
3267 description: Unique id relative to the cloud-region.
3270 example: __TENANT-ID__
3273 description: Unique identifier for this vserver relative to its tenant
3276 example: __VSERVER-ID__
3277 - name: interface-name
3279 description: Name given to the interface
3282 example: __INTERFACE-NAME__
3285 description: Type of the cloud (e.g., openstack)
3288 - name: owner-defined-type
3290 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
3295 description: Readable name of tenant
3298 - name: vserver-name
3300 description: Name of vserver
3303 - name: vserver-name2
3305 description: Alternative name of vserver
3310 description: Trigger for operational monitoring of this resource by Service Assurance systems.
3317 - name: is-closed-loop-disabled
3321 - name: interface-id
3323 description: ID of interface
3328 description: MAC address for the interface
3331 - name: network-name
3333 description: Name of the network
3336 /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:
3339 - CloudInfrastructure
3340 summary: see node definition for valid relationships
3341 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship
3350 description: Response codes found in [response codes](https://wiki.onap.org/).
3354 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3357 example: __CLOUD-OWNER__
3358 - name: cloud-region-id
3360 description: Identifier used by the vendor for the region. Second part of composite key
3363 example: __CLOUD-REGION-ID__
3366 description: Unique id relative to the cloud-region.
3369 example: __TENANT-ID__
3372 description: Unique identifier for this vserver relative to its tenant
3375 example: __VSERVER-ID__
3376 - name: interface-name
3378 description: Name given to the interface
3381 example: __INTERFACE-NAME__
3384 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)
3387 $ref: "#/definitions/relationship"
3390 - CloudInfrastructure
3391 summary: delete an existing relationship
3392 description: delete an existing relationship
3393 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship
3402 description: Response codes found in [response codes](https://wiki.onap.org/).
3406 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3409 example: __CLOUD-OWNER__
3410 - name: cloud-region-id
3412 description: Identifier used by the vendor for the region. Second part of composite key
3415 example: __CLOUD-REGION-ID__
3418 description: Unique id relative to the cloud-region.
3421 example: __TENANT-ID__
3424 description: Unique identifier for this vserver relative to its tenant
3427 example: __VSERVER-ID__
3428 - name: interface-name
3430 description: Name given to the interface
3433 example: __INTERFACE-NAME__
3434 /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:
3437 - CloudInfrastructure
3438 summary: see node definition for valid relationships
3439 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
3448 description: Response codes found in [response codes](https://wiki.onap.org/).
3452 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3455 example: __CLOUD-OWNER__
3456 - name: cloud-region-id
3458 description: Identifier used by the vendor for the region. Second part of composite key
3461 example: __CLOUD-REGION-ID__
3464 description: Unique id relative to the cloud-region.
3467 example: __TENANT-ID__
3470 description: Unique identifier for this vserver relative to its tenant
3473 example: __VSERVER-ID__
3474 - name: interface-name
3476 description: Name given to the interface
3479 example: __INTERFACE-NAME__
3480 - name: l3-interface-ipv4-address
3482 description: IP address
3485 example: __L3-INTERFACE-IPV4-ADDRESS__
3488 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
3491 $ref: "#/definitions/relationship"
3494 - CloudInfrastructure
3495 summary: delete an existing relationship
3496 description: delete an existing relationship
3497 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
3506 description: Response codes found in [response codes](https://wiki.onap.org/).
3510 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3513 example: __CLOUD-OWNER__
3514 - name: cloud-region-id
3516 description: Identifier used by the vendor for the region. Second part of composite key
3519 example: __CLOUD-REGION-ID__
3522 description: Unique id relative to the cloud-region.
3525 example: __TENANT-ID__
3528 description: Unique identifier for this vserver relative to its tenant
3531 example: __VSERVER-ID__
3532 - name: interface-name
3534 description: Name given to the interface
3537 example: __INTERFACE-NAME__
3538 - name: l3-interface-ipv4-address
3540 description: IP address
3543 example: __L3-INTERFACE-IPV4-ADDRESS__
3544 /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}:
3547 - CloudInfrastructure
3548 summary: returns l3-interface-ipv4-address-list
3549 description: returns l3-interface-ipv4-address-list
3550 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3556 description: successful operation
3558 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
3560 description: Response codes found in [response codes](https://wiki.onap.org/).
3564 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3567 example: __CLOUD-OWNER__
3568 - name: cloud-region-id
3570 description: Identifier used by the vendor for the region. Second part of composite key
3573 example: __CLOUD-REGION-ID__
3576 description: Unique id relative to the cloud-region.
3579 example: __TENANT-ID__
3582 description: Unique identifier for this vserver relative to its tenant
3585 example: __VSERVER-ID__
3586 - name: interface-name
3588 description: Name given to the interface
3591 example: __INTERFACE-NAME__
3592 - name: l3-interface-ipv4-address
3594 description: IP address
3597 example: __L3-INTERFACE-IPV4-ADDRESS__
3600 description: Type of the cloud (e.g., openstack)
3603 - name: owner-defined-type
3605 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
3610 description: Readable name of tenant
3613 - name: vserver-name
3615 description: Name of vserver
3618 - name: vserver-name2
3620 description: Alternative name of vserver
3625 description: Trigger for operational monitoring of this resource by Service Assurance systems.
3632 - name: is-closed-loop-disabled
3636 - name: interface-id
3638 description: ID of interface
3643 description: MAC address for the interface
3646 - name: network-name
3648 description: Name of the network
3651 - name: vlan-id-inner
3653 description: Inner VLAN tag
3657 - name: neutron-network-id
3659 description: Neutron network id of the interface that address belongs to
3662 - name: neutron-subnet-id
3664 description: Neutron id of subnet that address belongs to
3669 - CloudInfrastructure
3670 summary: create or update an existing l3-interface-ipv4-address-list
3672 Create or update an existing l3-interface-ipv4-address-list.
3674 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
3675 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3684 description: Response codes found in [response codes](https://wiki.onap.org/).
3688 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3691 example: __CLOUD-OWNER__
3692 - name: cloud-region-id
3694 description: Identifier used by the vendor for the region. Second part of composite key
3697 example: __CLOUD-REGION-ID__
3700 description: Unique id relative to the cloud-region.
3703 example: __TENANT-ID__
3706 description: Unique identifier for this vserver relative to its tenant
3709 example: __VSERVER-ID__
3710 - name: interface-name
3712 description: Name given to the interface
3715 example: __INTERFACE-NAME__
3716 - name: l3-interface-ipv4-address
3718 description: IP address
3721 example: __L3-INTERFACE-IPV4-ADDRESS__
3724 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
3727 $ref: "#/definitions/l3-interface-ipv4-address-list"
3730 - CloudInfrastructure
3731 summary: update an existing l3-interface-ipv4-address-list
3733 Update an existing l3-interface-ipv4-address-list
3735 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
3736 The PUT operation will entirely replace an existing object.
3737 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
3739 Other differences between PUT and PATCH are:
3741 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
3742 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
3743 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
3744 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3753 description: Response codes found in [response codes](https://wiki.onap.org/).
3757 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3760 example: __CLOUD-OWNER__
3761 - name: cloud-region-id
3763 description: Identifier used by the vendor for the region. Second part of composite key
3766 example: __CLOUD-REGION-ID__
3769 description: Unique id relative to the cloud-region.
3772 example: __TENANT-ID__
3775 description: Unique identifier for this vserver relative to its tenant
3778 example: __VSERVER-ID__
3779 - name: interface-name
3781 description: Name given to the interface
3784 example: __INTERFACE-NAME__
3785 - name: l3-interface-ipv4-address
3787 description: IP address
3790 example: __L3-INTERFACE-IPV4-ADDRESS__
3793 description: l3-interface-ipv4-address-list object that needs to be created or updated.
3796 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
3799 - CloudInfrastructure
3800 summary: delete an existing l3-interface-ipv4-address-list
3801 description: delete an existing l3-interface-ipv4-address-list
3802 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3811 description: Response codes found in [response codes](https://wiki.onap.org/).
3815 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3818 example: __CLOUD-OWNER__
3819 - name: cloud-region-id
3821 description: Identifier used by the vendor for the region. Second part of composite key
3824 example: __CLOUD-REGION-ID__
3827 description: Unique id relative to the cloud-region.
3830 example: __TENANT-ID__
3833 description: Unique identifier for this vserver relative to its tenant
3836 example: __VSERVER-ID__
3837 - name: interface-name
3839 description: Name given to the interface
3842 example: __INTERFACE-NAME__
3843 - name: l3-interface-ipv4-address
3845 description: IP address
3848 example: __L3-INTERFACE-IPV4-ADDRESS__
3849 - name: resource-version
3851 description: resource-version for concurrency
3854 /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:
3857 - CloudInfrastructure
3858 summary: see node definition for valid relationships
3859 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
3868 description: Response codes found in [response codes](https://wiki.onap.org/).
3872 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3875 example: __CLOUD-OWNER__
3876 - name: cloud-region-id
3878 description: Identifier used by the vendor for the region. Second part of composite key
3881 example: __CLOUD-REGION-ID__
3884 description: Unique id relative to the cloud-region.
3887 example: __TENANT-ID__
3890 description: Unique identifier for this vserver relative to its tenant
3893 example: __VSERVER-ID__
3894 - name: interface-name
3896 description: Name given to the interface
3899 example: __INTERFACE-NAME__
3900 - name: l3-interface-ipv6-address
3902 description: IP address
3905 example: __L3-INTERFACE-IPV6-ADDRESS__
3908 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
3911 $ref: "#/definitions/relationship"
3914 - CloudInfrastructure
3915 summary: delete an existing relationship
3916 description: delete an existing relationship
3917 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
3926 description: Response codes found in [response codes](https://wiki.onap.org/).
3930 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3933 example: __CLOUD-OWNER__
3934 - name: cloud-region-id
3936 description: Identifier used by the vendor for the region. Second part of composite key
3939 example: __CLOUD-REGION-ID__
3942 description: Unique id relative to the cloud-region.
3945 example: __TENANT-ID__
3948 description: Unique identifier for this vserver relative to its tenant
3951 example: __VSERVER-ID__
3952 - name: interface-name
3954 description: Name given to the interface
3957 example: __INTERFACE-NAME__
3958 - name: l3-interface-ipv6-address
3960 description: IP address
3963 example: __L3-INTERFACE-IPV6-ADDRESS__
3964 /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}:
3967 - CloudInfrastructure
3968 summary: returns l3-interface-ipv6-address-list
3969 description: returns l3-interface-ipv6-address-list
3970 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
3976 description: successful operation
3978 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
3980 description: Response codes found in [response codes](https://wiki.onap.org/).
3984 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3987 example: __CLOUD-OWNER__
3988 - name: cloud-region-id
3990 description: Identifier used by the vendor for the region. Second part of composite key
3993 example: __CLOUD-REGION-ID__
3996 description: Unique id relative to the cloud-region.
3999 example: __TENANT-ID__
4002 description: Unique identifier for this vserver relative to its tenant
4005 example: __VSERVER-ID__
4006 - name: interface-name
4008 description: Name given to the interface
4011 example: __INTERFACE-NAME__
4012 - name: l3-interface-ipv6-address
4014 description: IP address
4017 example: __L3-INTERFACE-IPV6-ADDRESS__
4020 description: Type of the cloud (e.g., openstack)
4023 - name: owner-defined-type
4025 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
4030 description: Readable name of tenant
4033 - name: vserver-name
4035 description: Name of vserver
4038 - name: vserver-name2
4040 description: Alternative name of vserver
4045 description: Trigger for operational monitoring of this resource by Service Assurance systems.
4052 - name: is-closed-loop-disabled
4056 - name: interface-id
4058 description: ID of interface
4063 description: MAC address for the interface
4066 - name: network-name
4068 description: Name of the network
4071 - name: vlan-id-inner
4073 description: Inner VLAN tag
4077 - name: neutron-network-id
4079 description: Neutron network id of the interface that address belongs to
4082 - name: neutron-subnet-id
4084 description: Neutron id of subnet that address belongs to
4089 - CloudInfrastructure
4090 summary: create or update an existing l3-interface-ipv6-address-list
4092 Create or update an existing l3-interface-ipv6-address-list.
4094 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
4095 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
4104 description: Response codes found in [response codes](https://wiki.onap.org/).
4108 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4111 example: __CLOUD-OWNER__
4112 - name: cloud-region-id
4114 description: Identifier used by the vendor for the region. Second part of composite key
4117 example: __CLOUD-REGION-ID__
4120 description: Unique id relative to the cloud-region.
4123 example: __TENANT-ID__
4126 description: Unique identifier for this vserver relative to its tenant
4129 example: __VSERVER-ID__
4130 - name: interface-name
4132 description: Name given to the interface
4135 example: __INTERFACE-NAME__
4136 - name: l3-interface-ipv6-address
4138 description: IP address
4141 example: __L3-INTERFACE-IPV6-ADDRESS__
4144 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
4147 $ref: "#/definitions/l3-interface-ipv6-address-list"
4150 - CloudInfrastructure
4151 summary: update an existing l3-interface-ipv6-address-list
4153 Update an existing l3-interface-ipv6-address-list
4155 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4156 The PUT operation will entirely replace an existing object.
4157 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
4159 Other differences between PUT and PATCH are:
4161 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
4162 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4163 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4164 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
4173 description: Response codes found in [response codes](https://wiki.onap.org/).
4177 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4180 example: __CLOUD-OWNER__
4181 - name: cloud-region-id
4183 description: Identifier used by the vendor for the region. Second part of composite key
4186 example: __CLOUD-REGION-ID__
4189 description: Unique id relative to the cloud-region.
4192 example: __TENANT-ID__
4195 description: Unique identifier for this vserver relative to its tenant
4198 example: __VSERVER-ID__
4199 - name: interface-name
4201 description: Name given to the interface
4204 example: __INTERFACE-NAME__
4205 - name: l3-interface-ipv6-address
4207 description: IP address
4210 example: __L3-INTERFACE-IPV6-ADDRESS__
4213 description: l3-interface-ipv6-address-list object that needs to be created or updated.
4216 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
4219 - CloudInfrastructure
4220 summary: delete an existing l3-interface-ipv6-address-list
4221 description: delete an existing l3-interface-ipv6-address-list
4222 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
4231 description: Response codes found in [response codes](https://wiki.onap.org/).
4235 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4238 example: __CLOUD-OWNER__
4239 - name: cloud-region-id
4241 description: Identifier used by the vendor for the region. Second part of composite key
4244 example: __CLOUD-REGION-ID__
4247 description: Unique id relative to the cloud-region.
4250 example: __TENANT-ID__
4253 description: Unique identifier for this vserver relative to its tenant
4256 example: __VSERVER-ID__
4257 - name: interface-name
4259 description: Name given to the interface
4262 example: __INTERFACE-NAME__
4263 - name: l3-interface-ipv6-address
4265 description: IP address
4268 example: __L3-INTERFACE-IPV6-ADDRESS__
4269 - name: resource-version
4271 description: resource-version for concurrency
4274 /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}:
4277 - CloudInfrastructure
4278 summary: returns l-interface
4279 description: returns l-interface
4280 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
4286 description: successful operation
4288 $ref: "#/getDefinitions/l-interface"
4290 description: Response codes found in [response codes](https://wiki.onap.org/).
4294 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4297 example: __CLOUD-OWNER__
4298 - name: cloud-region-id
4300 description: Identifier used by the vendor for the region. Second part of composite key
4303 example: __CLOUD-REGION-ID__
4306 description: Unique id relative to the cloud-region.
4309 example: __TENANT-ID__
4312 description: Unique identifier for this vserver relative to its tenant
4315 example: __VSERVER-ID__
4316 - name: interface-name
4318 description: Name given to the interface
4321 example: __INTERFACE-NAME__
4324 description: Type of the cloud (e.g., openstack)
4327 - name: owner-defined-type
4329 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
4334 description: Readable name of tenant
4337 - name: vserver-name
4339 description: Name of vserver
4342 - name: vserver-name2
4344 description: Alternative name of vserver
4349 description: Trigger for operational monitoring of this resource by Service Assurance systems.
4356 - name: is-closed-loop-disabled
4360 - name: interface-id
4362 description: ID of interface
4367 description: MAC address for the interface
4370 - name: network-name
4372 description: Name of the network
4377 - CloudInfrastructure
4378 summary: create or update an existing l-interface
4380 Create or update an existing l-interface.
4382 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
4383 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
4392 description: Response codes found in [response codes](https://wiki.onap.org/).
4396 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4399 example: __CLOUD-OWNER__
4400 - name: cloud-region-id
4402 description: Identifier used by the vendor for the region. Second part of composite key
4405 example: __CLOUD-REGION-ID__
4408 description: Unique id relative to the cloud-region.
4411 example: __TENANT-ID__
4414 description: Unique identifier for this vserver relative to its tenant
4417 example: __VSERVER-ID__
4418 - name: interface-name
4420 description: Name given to the interface
4423 example: __INTERFACE-NAME__
4426 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)
4429 $ref: "#/definitions/l-interface"
4432 - CloudInfrastructure
4433 summary: update an existing l-interface
4435 Update an existing l-interface
4437 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4438 The PUT operation will entirely replace an existing object.
4439 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
4441 Other differences between PUT and PATCH are:
4443 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
4444 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4445 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4446 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
4455 description: Response codes found in [response codes](https://wiki.onap.org/).
4459 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4462 example: __CLOUD-OWNER__
4463 - name: cloud-region-id
4465 description: Identifier used by the vendor for the region. Second part of composite key
4468 example: __CLOUD-REGION-ID__
4471 description: Unique id relative to the cloud-region.
4474 example: __TENANT-ID__
4477 description: Unique identifier for this vserver relative to its tenant
4480 example: __VSERVER-ID__
4481 - name: interface-name
4483 description: Name given to the interface
4486 example: __INTERFACE-NAME__
4489 description: l-interface object that needs to be created or updated.
4492 $ref: "#/patchDefinitions/l-interface"
4495 - CloudInfrastructure
4496 summary: delete an existing l-interface
4497 description: delete an existing l-interface
4498 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
4507 description: Response codes found in [response codes](https://wiki.onap.org/).
4511 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4514 example: __CLOUD-OWNER__
4515 - name: cloud-region-id
4517 description: Identifier used by the vendor for the region. Second part of composite key
4520 example: __CLOUD-REGION-ID__
4523 description: Unique id relative to the cloud-region.
4526 example: __TENANT-ID__
4529 description: Unique identifier for this vserver relative to its tenant
4532 example: __VSERVER-ID__
4533 - name: interface-name
4535 description: Name given to the interface
4538 example: __INTERFACE-NAME__
4539 - name: resource-version
4541 description: resource-version for concurrency
4544 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces:
4547 - CloudInfrastructure
4548 summary: returns l-interfaces
4549 description: returns l-interfaces
4550 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfaces
4556 description: successful operation
4558 $ref: "#/getDefinitions/l-interfaces"
4560 description: Response codes found in [response codes](https://wiki.onap.org/).
4564 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4567 example: __CLOUD-OWNER__
4568 - name: cloud-region-id
4570 description: Identifier used by the vendor for the region. Second part of composite key
4573 example: __CLOUD-REGION-ID__
4576 description: Unique id relative to the cloud-region.
4579 example: __TENANT-ID__
4582 description: Unique identifier for this vserver relative to its tenant
4585 example: __VSERVER-ID__
4588 description: Type of the cloud (e.g., openstack)
4591 - name: owner-defined-type
4593 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
4598 description: Readable name of tenant
4601 - name: vserver-name
4603 description: Name of vserver
4606 - name: vserver-name2
4608 description: Alternative name of vserver
4613 description: Trigger for operational monitoring of this resource by Service Assurance systems.
4620 - name: is-closed-loop-disabled
4624 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}:
4627 - CloudInfrastructure
4628 summary: returns vserver
4629 description: returns vserver
4630 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4636 description: successful operation
4638 $ref: "#/getDefinitions/vserver"
4640 description: Response codes found in [response codes](https://wiki.onap.org/).
4644 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4647 example: __CLOUD-OWNER__
4648 - name: cloud-region-id
4650 description: Identifier used by the vendor for the region. Second part of composite key
4653 example: __CLOUD-REGION-ID__
4656 description: Unique id relative to the cloud-region.
4659 example: __TENANT-ID__
4662 description: Unique identifier for this vserver relative to its tenant
4665 example: __VSERVER-ID__
4668 description: Type of the cloud (e.g., openstack)
4671 - name: owner-defined-type
4673 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
4678 description: Readable name of tenant
4681 - name: vserver-name
4683 description: Name of vserver
4686 - name: vserver-name2
4688 description: Alternative name of vserver
4693 description: Trigger for operational monitoring of this resource by Service Assurance systems.
4700 - name: is-closed-loop-disabled
4706 - CloudInfrastructure
4707 summary: create or update an existing vserver
4709 Create or update an existing vserver.
4711 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
4712 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4721 description: Response codes found in [response codes](https://wiki.onap.org/).
4725 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4728 example: __CLOUD-OWNER__
4729 - name: cloud-region-id
4731 description: Identifier used by the vendor for the region. Second part of composite key
4734 example: __CLOUD-REGION-ID__
4737 description: Unique id relative to the cloud-region.
4740 example: __TENANT-ID__
4743 description: Unique identifier for this vserver relative to its tenant
4746 example: __VSERVER-ID__
4749 description: vserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)
4752 $ref: "#/definitions/vserver"
4755 - CloudInfrastructure
4756 summary: update an existing vserver
4758 Update an existing vserver
4760 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4761 The PUT operation will entirely replace an existing object.
4762 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
4764 Other differences between PUT and PATCH are:
4766 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
4767 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4768 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4769 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4778 description: Response codes found in [response codes](https://wiki.onap.org/).
4782 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4785 example: __CLOUD-OWNER__
4786 - name: cloud-region-id
4788 description: Identifier used by the vendor for the region. Second part of composite key
4791 example: __CLOUD-REGION-ID__
4794 description: Unique id relative to the cloud-region.
4797 example: __TENANT-ID__
4800 description: Unique identifier for this vserver relative to its tenant
4803 example: __VSERVER-ID__
4806 description: vserver object that needs to be created or updated.
4809 $ref: "#/patchDefinitions/vserver"
4812 - CloudInfrastructure
4813 summary: delete an existing vserver
4814 description: delete an existing vserver
4815 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4824 description: Response codes found in [response codes](https://wiki.onap.org/).
4828 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4831 example: __CLOUD-OWNER__
4832 - name: cloud-region-id
4834 description: Identifier used by the vendor for the region. Second part of composite key
4837 example: __CLOUD-REGION-ID__
4840 description: Unique id relative to the cloud-region.
4843 example: __TENANT-ID__
4846 description: Unique identifier for this vserver relative to its tenant
4849 example: __VSERVER-ID__
4850 - name: resource-version
4852 description: resource-version for concurrency
4855 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers:
4858 - CloudInfrastructure
4859 summary: returns vservers
4860 description: returns vservers
4861 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVservers
4867 description: successful operation
4869 $ref: "#/getDefinitions/vservers"
4871 description: Response codes found in [response codes](https://wiki.onap.org/).
4875 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4878 example: __CLOUD-OWNER__
4879 - name: cloud-region-id
4881 description: Identifier used by the vendor for the region. Second part of composite key
4884 example: __CLOUD-REGION-ID__
4887 description: Unique id relative to the cloud-region.
4890 example: __TENANT-ID__
4893 description: Type of the cloud (e.g., openstack)
4896 - name: owner-defined-type
4898 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
4903 description: Readable name of tenant
4906 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship:
4909 - CloudInfrastructure
4910 summary: see node definition for valid relationships
4911 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship
4920 description: Response codes found in [response codes](https://wiki.onap.org/).
4924 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4927 example: __CLOUD-OWNER__
4928 - name: cloud-region-id
4930 description: Identifier used by the vendor for the region. Second part of composite key
4933 example: __CLOUD-REGION-ID__
4936 description: Unique id relative to the cloud-region.
4939 example: __TENANT-ID__
4942 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)
4945 $ref: "#/definitions/relationship"
4948 - CloudInfrastructure
4949 summary: delete an existing relationship
4950 description: delete an existing relationship
4951 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship
4960 description: Response codes found in [response codes](https://wiki.onap.org/).
4964 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4967 example: __CLOUD-OWNER__
4968 - name: cloud-region-id
4970 description: Identifier used by the vendor for the region. Second part of composite key
4973 example: __CLOUD-REGION-ID__
4976 description: Unique id relative to the cloud-region.
4979 example: __TENANT-ID__
4980 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}:
4983 - CloudInfrastructure
4984 summary: returns tenant
4985 description: returns tenant
4986 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
4992 description: successful operation
4994 $ref: "#/getDefinitions/tenant"
4996 description: Response codes found in [response codes](https://wiki.onap.org/).
5000 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5003 example: __CLOUD-OWNER__
5004 - name: cloud-region-id
5006 description: Identifier used by the vendor for the region. Second part of composite key
5009 example: __CLOUD-REGION-ID__
5012 description: Unique id relative to the cloud-region.
5015 example: __TENANT-ID__
5018 description: Type of the cloud (e.g., openstack)
5021 - name: owner-defined-type
5023 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5028 description: Readable name of tenant
5033 - CloudInfrastructure
5034 summary: create or update an existing tenant
5036 Create or update an existing tenant.
5038 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
5039 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
5048 description: Response codes found in [response codes](https://wiki.onap.org/).
5052 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5055 example: __CLOUD-OWNER__
5056 - name: cloud-region-id
5058 description: Identifier used by the vendor for the region. Second part of composite key
5061 example: __CLOUD-REGION-ID__
5064 description: Unique id relative to the cloud-region.
5067 example: __TENANT-ID__
5070 description: tenant object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)
5073 $ref: "#/definitions/tenant"
5076 - CloudInfrastructure
5077 summary: update an existing tenant
5079 Update an existing tenant
5081 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5082 The PUT operation will entirely replace an existing object.
5083 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
5085 Other differences between PUT and PATCH are:
5087 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
5088 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5089 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5090 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
5099 description: Response codes found in [response codes](https://wiki.onap.org/).
5103 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5106 example: __CLOUD-OWNER__
5107 - name: cloud-region-id
5109 description: Identifier used by the vendor for the region. Second part of composite key
5112 example: __CLOUD-REGION-ID__
5115 description: Unique id relative to the cloud-region.
5118 example: __TENANT-ID__
5121 description: tenant object that needs to be created or updated.
5124 $ref: "#/patchDefinitions/tenant"
5127 - CloudInfrastructure
5128 summary: delete an existing tenant
5129 description: delete an existing tenant
5130 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
5139 description: Response codes found in [response codes](https://wiki.onap.org/).
5143 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5146 example: __CLOUD-OWNER__
5147 - name: cloud-region-id
5149 description: Identifier used by the vendor for the region. Second part of composite key
5152 example: __CLOUD-REGION-ID__
5155 description: Unique id relative to the cloud-region.
5158 example: __TENANT-ID__
5159 - name: resource-version
5161 description: resource-version for concurrency
5164 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants:
5167 - CloudInfrastructure
5168 summary: returns tenants
5169 description: returns tenants
5170 operationId: getCloudInfrastructureCloudRegionsCloudRegionTenants
5176 description: successful operation
5178 $ref: "#/getDefinitions/tenants"
5180 description: Response codes found in [response codes](https://wiki.onap.org/).
5184 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5187 example: __CLOUD-OWNER__
5188 - name: cloud-region-id
5190 description: Identifier used by the vendor for the region. Second part of composite key
5193 example: __CLOUD-REGION-ID__
5196 description: Type of the cloud (e.g., openstack)
5199 - name: owner-defined-type
5201 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5204 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship:
5207 - CloudInfrastructure
5208 summary: see node definition for valid relationships
5209 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
5218 description: Response codes found in [response codes](https://wiki.onap.org/).
5222 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5225 example: __CLOUD-OWNER__
5226 - name: cloud-region-id
5228 description: Identifier used by the vendor for the region. Second part of composite key
5231 example: __CLOUD-REGION-ID__
5234 description: Flavor id, expected to be unique across cloud-region.
5237 example: __FLAVOR-ID__
5240 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
5243 $ref: "#/definitions/relationship"
5246 - CloudInfrastructure
5247 summary: delete an existing relationship
5248 description: delete an existing relationship
5249 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
5258 description: Response codes found in [response codes](https://wiki.onap.org/).
5262 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5265 example: __CLOUD-OWNER__
5266 - name: cloud-region-id
5268 description: Identifier used by the vendor for the region. Second part of composite key
5271 example: __CLOUD-REGION-ID__
5274 description: Flavor id, expected to be unique across cloud-region.
5277 example: __FLAVOR-ID__
5278 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}:
5281 - CloudInfrastructure
5282 summary: returns flavor
5283 description: returns flavor
5284 operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5290 description: successful operation
5292 $ref: "#/getDefinitions/flavor"
5294 description: Response codes found in [response codes](https://wiki.onap.org/).
5298 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5301 example: __CLOUD-OWNER__
5302 - name: cloud-region-id
5304 description: Identifier used by the vendor for the region. Second part of composite key
5307 example: __CLOUD-REGION-ID__
5310 description: Flavor id, expected to be unique across cloud-region.
5313 example: __FLAVOR-ID__
5316 description: Type of the cloud (e.g., openstack)
5319 - name: owner-defined-type
5321 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5326 description: Flavor name
5331 - CloudInfrastructure
5332 summary: create or update an existing flavor
5334 Create or update an existing flavor.
5336 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
5337 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5346 description: Response codes found in [response codes](https://wiki.onap.org/).
5350 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5353 example: __CLOUD-OWNER__
5354 - name: cloud-region-id
5356 description: Identifier used by the vendor for the region. Second part of composite key
5359 example: __CLOUD-REGION-ID__
5362 description: Flavor id, expected to be unique across cloud-region.
5365 example: __FLAVOR-ID__
5368 description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
5371 $ref: "#/definitions/flavor"
5374 - CloudInfrastructure
5375 summary: update an existing flavor
5377 Update an existing flavor
5379 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5380 The PUT operation will entirely replace an existing object.
5381 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
5383 Other differences between PUT and PATCH are:
5385 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
5386 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5387 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5388 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5397 description: Response codes found in [response codes](https://wiki.onap.org/).
5401 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5404 example: __CLOUD-OWNER__
5405 - name: cloud-region-id
5407 description: Identifier used by the vendor for the region. Second part of composite key
5410 example: __CLOUD-REGION-ID__
5413 description: Flavor id, expected to be unique across cloud-region.
5416 example: __FLAVOR-ID__
5419 description: flavor object that needs to be created or updated.
5422 $ref: "#/patchDefinitions/flavor"
5425 - CloudInfrastructure
5426 summary: delete an existing flavor
5427 description: delete an existing flavor
5428 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5437 description: Response codes found in [response codes](https://wiki.onap.org/).
5441 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5444 example: __CLOUD-OWNER__
5445 - name: cloud-region-id
5447 description: Identifier used by the vendor for the region. Second part of composite key
5450 example: __CLOUD-REGION-ID__
5453 description: Flavor id, expected to be unique across cloud-region.
5456 example: __FLAVOR-ID__
5457 - name: resource-version
5459 description: resource-version for concurrency
5462 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors:
5465 - CloudInfrastructure
5466 summary: returns flavors
5467 description: returns flavors
5468 operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavors
5474 description: successful operation
5476 $ref: "#/getDefinitions/flavors"
5478 description: Response codes found in [response codes](https://wiki.onap.org/).
5482 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5485 example: __CLOUD-OWNER__
5486 - name: cloud-region-id
5488 description: Identifier used by the vendor for the region. Second part of composite key
5491 example: __CLOUD-REGION-ID__
5494 description: Type of the cloud (e.g., openstack)
5497 - name: owner-defined-type
5499 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5502 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship:
5505 - CloudInfrastructure
5506 summary: see node definition for valid relationships
5507 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
5516 description: Response codes found in [response codes](https://wiki.onap.org/).
5520 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5523 example: __CLOUD-OWNER__
5524 - name: cloud-region-id
5526 description: Identifier used by the vendor for the region. Second part of composite key
5529 example: __CLOUD-REGION-ID__
5532 description: Group id, expected to be unique across cloud-region.
5535 example: __GROUP-ID__
5538 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
5541 $ref: "#/definitions/relationship"
5544 - CloudInfrastructure
5545 summary: delete an existing relationship
5546 description: delete an existing relationship
5547 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
5556 description: Response codes found in [response codes](https://wiki.onap.org/).
5560 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5563 example: __CLOUD-OWNER__
5564 - name: cloud-region-id
5566 description: Identifier used by the vendor for the region. Second part of composite key
5569 example: __CLOUD-REGION-ID__
5572 description: Group id, expected to be unique across cloud-region.
5575 example: __GROUP-ID__
5576 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}:
5579 - CloudInfrastructure
5580 summary: returns group-assignment
5581 description: returns group-assignment
5582 operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5588 description: successful operation
5590 $ref: "#/getDefinitions/group-assignment"
5592 description: Response codes found in [response codes](https://wiki.onap.org/).
5596 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5599 example: __CLOUD-OWNER__
5600 - name: cloud-region-id
5602 description: Identifier used by the vendor for the region. Second part of composite key
5605 example: __CLOUD-REGION-ID__
5608 description: Group id, expected to be unique across cloud-region.
5611 example: __GROUP-ID__
5614 description: Type of the cloud (e.g., openstack)
5617 - name: owner-defined-type
5619 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5624 description: Group type - the type of group this instance refers to
5629 description: Group name - name assigned to the group
5634 - CloudInfrastructure
5635 summary: create or update an existing group-assignment
5637 Create or update an existing group-assignment.
5639 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
5640 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5649 description: Response codes found in [response codes](https://wiki.onap.org/).
5653 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5656 example: __CLOUD-OWNER__
5657 - name: cloud-region-id
5659 description: Identifier used by the vendor for the region. Second part of composite key
5662 example: __CLOUD-REGION-ID__
5665 description: Group id, expected to be unique across cloud-region.
5668 example: __GROUP-ID__
5671 description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
5674 $ref: "#/definitions/group-assignment"
5677 - CloudInfrastructure
5678 summary: update an existing group-assignment
5680 Update an existing group-assignment
5682 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5683 The PUT operation will entirely replace an existing object.
5684 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
5686 Other differences between PUT and PATCH are:
5688 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
5689 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5690 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5691 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5700 description: Response codes found in [response codes](https://wiki.onap.org/).
5704 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5707 example: __CLOUD-OWNER__
5708 - name: cloud-region-id
5710 description: Identifier used by the vendor for the region. Second part of composite key
5713 example: __CLOUD-REGION-ID__
5716 description: Group id, expected to be unique across cloud-region.
5719 example: __GROUP-ID__
5722 description: group-assignment object that needs to be created or updated.
5725 $ref: "#/patchDefinitions/group-assignment"
5728 - CloudInfrastructure
5729 summary: delete an existing group-assignment
5730 description: delete an existing group-assignment
5731 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5740 description: Response codes found in [response codes](https://wiki.onap.org/).
5744 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5747 example: __CLOUD-OWNER__
5748 - name: cloud-region-id
5750 description: Identifier used by the vendor for the region. Second part of composite key
5753 example: __CLOUD-REGION-ID__
5756 description: Group id, expected to be unique across cloud-region.
5759 example: __GROUP-ID__
5760 - name: resource-version
5762 description: resource-version for concurrency
5765 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments:
5768 - CloudInfrastructure
5769 summary: returns group-assignments
5770 description: returns group-assignments
5771 operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments
5777 description: successful operation
5779 $ref: "#/getDefinitions/group-assignments"
5781 description: Response codes found in [response codes](https://wiki.onap.org/).
5785 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5788 example: __CLOUD-OWNER__
5789 - name: cloud-region-id
5791 description: Identifier used by the vendor for the region. Second part of composite key
5794 example: __CLOUD-REGION-ID__
5797 description: Type of the cloud (e.g., openstack)
5800 - name: owner-defined-type
5802 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5805 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship:
5808 - CloudInfrastructure
5809 summary: see node definition for valid relationships
5810 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5819 description: Response codes found in [response codes](https://wiki.onap.org/).
5823 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5826 example: __CLOUD-OWNER__
5827 - name: cloud-region-id
5829 description: Identifier used by the vendor for the region. Second part of composite key
5832 example: __CLOUD-REGION-ID__
5835 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5838 example: __SNAPSHOT-ID__
5841 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
5844 $ref: "#/definitions/relationship"
5847 - CloudInfrastructure
5848 summary: delete an existing relationship
5849 description: delete an existing relationship
5850 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5859 description: Response codes found in [response codes](https://wiki.onap.org/).
5863 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5866 example: __CLOUD-OWNER__
5867 - name: cloud-region-id
5869 description: Identifier used by the vendor for the region. Second part of composite key
5872 example: __CLOUD-REGION-ID__
5875 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5878 example: __SNAPSHOT-ID__
5879 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}:
5882 - CloudInfrastructure
5883 summary: returns snapshot
5884 description: returns snapshot
5885 operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5891 description: successful operation
5893 $ref: "#/getDefinitions/snapshot"
5895 description: Response codes found in [response codes](https://wiki.onap.org/).
5899 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5902 example: __CLOUD-OWNER__
5903 - name: cloud-region-id
5905 description: Identifier used by the vendor for the region. Second part of composite key
5908 example: __CLOUD-REGION-ID__
5911 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5914 example: __SNAPSHOT-ID__
5917 description: Type of the cloud (e.g., openstack)
5920 - name: owner-defined-type
5922 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5925 - name: snapshot-name
5927 description: Snapshot name
5932 description: The application that the image instantiates.
5935 - name: application-vendor
5937 description: The vendor of the application.
5940 - name: application-version
5942 description: The version of the application.
5945 - name: prev-snapshot-id
5947 description: This field contains the UUID of the previous snapshot (if any).
5952 - CloudInfrastructure
5953 summary: create or update an existing snapshot
5955 Create or update an existing snapshot.
5957 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
5958 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5967 description: Response codes found in [response codes](https://wiki.onap.org/).
5971 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5974 example: __CLOUD-OWNER__
5975 - name: cloud-region-id
5977 description: Identifier used by the vendor for the region. Second part of composite key
5980 example: __CLOUD-REGION-ID__
5983 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5986 example: __SNAPSHOT-ID__
5989 description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
5992 $ref: "#/definitions/snapshot"
5995 - CloudInfrastructure
5996 summary: update an existing snapshot
5998 Update an existing snapshot
6000 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6001 The PUT operation will entirely replace an existing object.
6002 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6004 Other differences between PUT and PATCH are:
6006 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6007 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6008 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6009 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
6018 description: Response codes found in [response codes](https://wiki.onap.org/).
6022 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6025 example: __CLOUD-OWNER__
6026 - name: cloud-region-id
6028 description: Identifier used by the vendor for the region. Second part of composite key
6031 example: __CLOUD-REGION-ID__
6034 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
6037 example: __SNAPSHOT-ID__
6040 description: snapshot object that needs to be created or updated.
6043 $ref: "#/patchDefinitions/snapshot"
6046 - CloudInfrastructure
6047 summary: delete an existing snapshot
6048 description: delete an existing snapshot
6049 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
6058 description: Response codes found in [response codes](https://wiki.onap.org/).
6062 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6065 example: __CLOUD-OWNER__
6066 - name: cloud-region-id
6068 description: Identifier used by the vendor for the region. Second part of composite key
6071 example: __CLOUD-REGION-ID__
6074 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
6077 example: __SNAPSHOT-ID__
6078 - name: resource-version
6080 description: resource-version for concurrency
6083 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots:
6086 - CloudInfrastructure
6087 summary: returns snapshots
6088 description: returns snapshots
6089 operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots
6095 description: successful operation
6097 $ref: "#/getDefinitions/snapshots"
6099 description: Response codes found in [response codes](https://wiki.onap.org/).
6103 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6106 example: __CLOUD-OWNER__
6107 - name: cloud-region-id
6109 description: Identifier used by the vendor for the region. Second part of composite key
6112 example: __CLOUD-REGION-ID__
6115 description: Type of the cloud (e.g., openstack)
6118 - name: owner-defined-type
6120 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6123 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship:
6126 - CloudInfrastructure
6127 summary: see node definition for valid relationships
6128 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
6137 description: Response codes found in [response codes](https://wiki.onap.org/).
6141 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6144 example: __CLOUD-OWNER__
6145 - name: cloud-region-id
6147 description: Identifier used by the vendor for the region. Second part of composite key
6150 example: __CLOUD-REGION-ID__
6153 description: Image id, expected to be unique across cloud region
6156 example: __IMAGE-ID__
6159 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
6162 $ref: "#/definitions/relationship"
6165 - CloudInfrastructure
6166 summary: delete an existing relationship
6167 description: delete an existing relationship
6168 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
6177 description: Response codes found in [response codes](https://wiki.onap.org/).
6181 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6184 example: __CLOUD-OWNER__
6185 - name: cloud-region-id
6187 description: Identifier used by the vendor for the region. Second part of composite key
6190 example: __CLOUD-REGION-ID__
6193 description: Image id, expected to be unique across cloud region
6196 example: __IMAGE-ID__
6197 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}:
6200 - CloudInfrastructure
6201 summary: returns metadatum
6202 description: returns metadatum
6203 operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6209 description: successful operation
6211 $ref: "#/getDefinitions/metadatum"
6213 description: Response codes found in [response codes](https://wiki.onap.org/).
6217 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6220 example: __CLOUD-OWNER__
6221 - name: cloud-region-id
6223 description: Identifier used by the vendor for the region. Second part of composite key
6226 example: __CLOUD-REGION-ID__
6229 description: Image id, expected to be unique across cloud region
6232 example: __IMAGE-ID__
6237 example: __METANAME__
6240 description: Type of the cloud (e.g., openstack)
6243 - name: owner-defined-type
6245 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6250 description: Image name
6255 description: The application that the image instantiates.
6258 - name: application-vendor
6260 description: The vendor of the application.
6263 - name: application-version
6265 description: The version of the application.
6270 - CloudInfrastructure
6271 summary: create or update an existing metadatum
6273 Create or update an existing metadatum.
6275 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6276 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6285 description: Response codes found in [response codes](https://wiki.onap.org/).
6289 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6292 example: __CLOUD-OWNER__
6293 - name: cloud-region-id
6295 description: Identifier used by the vendor for the region. Second part of composite key
6298 example: __CLOUD-REGION-ID__
6301 description: Image id, expected to be unique across cloud region
6304 example: __IMAGE-ID__
6309 example: __METANAME__
6312 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)
6315 $ref: "#/definitions/metadatum"
6318 - CloudInfrastructure
6319 summary: update an existing metadatum
6321 Update an existing metadatum
6323 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6324 The PUT operation will entirely replace an existing object.
6325 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6327 Other differences between PUT and PATCH are:
6329 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6330 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6331 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6332 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6341 description: Response codes found in [response codes](https://wiki.onap.org/).
6345 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6348 example: __CLOUD-OWNER__
6349 - name: cloud-region-id
6351 description: Identifier used by the vendor for the region. Second part of composite key
6354 example: __CLOUD-REGION-ID__
6357 description: Image id, expected to be unique across cloud region
6360 example: __IMAGE-ID__
6365 example: __METANAME__
6368 description: metadatum object that needs to be created or updated.
6371 $ref: "#/patchDefinitions/metadatum"
6374 - CloudInfrastructure
6375 summary: delete an existing metadatum
6376 description: delete an existing metadatum
6377 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6386 description: Response codes found in [response codes](https://wiki.onap.org/).
6390 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6393 example: __CLOUD-OWNER__
6394 - name: cloud-region-id
6396 description: Identifier used by the vendor for the region. Second part of composite key
6399 example: __CLOUD-REGION-ID__
6402 description: Image id, expected to be unique across cloud region
6405 example: __IMAGE-ID__
6410 example: __METANAME__
6411 - name: resource-version
6413 description: resource-version for concurrency
6416 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata:
6419 - CloudInfrastructure
6420 summary: returns metadata
6421 description: returns metadata
6422 operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata
6428 description: successful operation
6430 $ref: "#/getDefinitions/metadata"
6432 description: Response codes found in [response codes](https://wiki.onap.org/).
6436 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6439 example: __CLOUD-OWNER__
6440 - name: cloud-region-id
6442 description: Identifier used by the vendor for the region. Second part of composite key
6445 example: __CLOUD-REGION-ID__
6448 description: Image id, expected to be unique across cloud region
6451 example: __IMAGE-ID__
6454 description: Type of the cloud (e.g., openstack)
6457 - name: owner-defined-type
6459 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6464 description: Image name
6469 description: The application that the image instantiates.
6472 - name: application-vendor
6474 description: The vendor of the application.
6477 - name: application-version
6479 description: The version of the application.
6482 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}:
6485 - CloudInfrastructure
6486 summary: returns image
6487 description: returns image
6488 operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImage
6494 description: successful operation
6496 $ref: "#/getDefinitions/image"
6498 description: Response codes found in [response codes](https://wiki.onap.org/).
6502 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6505 example: __CLOUD-OWNER__
6506 - name: cloud-region-id
6508 description: Identifier used by the vendor for the region. Second part of composite key
6511 example: __CLOUD-REGION-ID__
6514 description: Image id, expected to be unique across cloud region
6517 example: __IMAGE-ID__
6520 description: Type of the cloud (e.g., openstack)
6523 - name: owner-defined-type
6525 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6530 description: Image name
6535 description: The application that the image instantiates.
6538 - name: application-vendor
6540 description: The vendor of the application.
6543 - name: application-version
6545 description: The version of the application.
6550 - CloudInfrastructure
6551 summary: create or update an existing image
6553 Create or update an existing image.
6555 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6556 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
6565 description: Response codes found in [response codes](https://wiki.onap.org/).
6569 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6572 example: __CLOUD-OWNER__
6573 - name: cloud-region-id
6575 description: Identifier used by the vendor for the region. Second part of composite key
6578 example: __CLOUD-REGION-ID__
6581 description: Image id, expected to be unique across cloud region
6584 example: __IMAGE-ID__
6587 description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
6590 $ref: "#/definitions/image"
6593 - CloudInfrastructure
6594 summary: update an existing image
6596 Update an existing image
6598 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6599 The PUT operation will entirely replace an existing object.
6600 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6602 Other differences between PUT and PATCH are:
6604 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6605 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6606 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6607 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
6616 description: Response codes found in [response codes](https://wiki.onap.org/).
6620 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6623 example: __CLOUD-OWNER__
6624 - name: cloud-region-id
6626 description: Identifier used by the vendor for the region. Second part of composite key
6629 example: __CLOUD-REGION-ID__
6632 description: Image id, expected to be unique across cloud region
6635 example: __IMAGE-ID__
6638 description: image object that needs to be created or updated.
6641 $ref: "#/patchDefinitions/image"
6644 - CloudInfrastructure
6645 summary: delete an existing image
6646 description: delete an existing image
6647 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage
6656 description: Response codes found in [response codes](https://wiki.onap.org/).
6660 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6663 example: __CLOUD-OWNER__
6664 - name: cloud-region-id
6666 description: Identifier used by the vendor for the region. Second part of composite key
6669 example: __CLOUD-REGION-ID__
6672 description: Image id, expected to be unique across cloud region
6675 example: __IMAGE-ID__
6676 - name: resource-version
6678 description: resource-version for concurrency
6681 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images:
6684 - CloudInfrastructure
6685 summary: returns images
6686 description: returns images
6687 operationId: getCloudInfrastructureCloudRegionsCloudRegionImages
6693 description: successful operation
6695 $ref: "#/getDefinitions/images"
6697 description: Response codes found in [response codes](https://wiki.onap.org/).
6701 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6704 example: __CLOUD-OWNER__
6705 - name: cloud-region-id
6707 description: Identifier used by the vendor for the region. Second part of composite key
6710 example: __CLOUD-REGION-ID__
6713 description: Type of the cloud (e.g., openstack)
6716 - name: owner-defined-type
6718 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6721 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship:
6724 - CloudInfrastructure
6725 summary: see node definition for valid relationships
6726 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
6735 description: Response codes found in [response codes](https://wiki.onap.org/).
6739 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6742 example: __CLOUD-OWNER__
6743 - name: cloud-region-id
6745 description: Identifier used by the vendor for the region. Second part of composite key
6748 example: __CLOUD-REGION-ID__
6751 description: DVS switch name
6754 example: __SWITCH-NAME__
6757 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
6760 $ref: "#/definitions/relationship"
6763 - CloudInfrastructure
6764 summary: delete an existing relationship
6765 description: delete an existing relationship
6766 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
6775 description: Response codes found in [response codes](https://wiki.onap.org/).
6779 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6782 example: __CLOUD-OWNER__
6783 - name: cloud-region-id
6785 description: Identifier used by the vendor for the region. Second part of composite key
6788 example: __CLOUD-REGION-ID__
6791 description: DVS switch name
6794 example: __SWITCH-NAME__
6795 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}:
6798 - CloudInfrastructure
6799 summary: returns dvs-switch
6800 description: returns dvs-switch
6801 operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6807 description: successful operation
6809 $ref: "#/getDefinitions/dvs-switch"
6811 description: Response codes found in [response codes](https://wiki.onap.org/).
6815 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6818 example: __CLOUD-OWNER__
6819 - name: cloud-region-id
6821 description: Identifier used by the vendor for the region. Second part of composite key
6824 example: __CLOUD-REGION-ID__
6827 description: DVS switch name
6830 example: __SWITCH-NAME__
6833 description: Type of the cloud (e.g., openstack)
6836 - name: owner-defined-type
6838 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6843 description: URL used to reach the vcenter
6848 - CloudInfrastructure
6849 summary: create or update an existing dvs-switch
6851 Create or update an existing dvs-switch.
6853 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
6854 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6863 description: Response codes found in [response codes](https://wiki.onap.org/).
6867 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6870 example: __CLOUD-OWNER__
6871 - name: cloud-region-id
6873 description: Identifier used by the vendor for the region. Second part of composite key
6876 example: __CLOUD-REGION-ID__
6879 description: DVS switch name
6882 example: __SWITCH-NAME__
6885 description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
6888 $ref: "#/definitions/dvs-switch"
6891 - CloudInfrastructure
6892 summary: update an existing dvs-switch
6894 Update an existing dvs-switch
6896 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6897 The PUT operation will entirely replace an existing object.
6898 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
6900 Other differences between PUT and PATCH are:
6902 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
6903 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6904 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6905 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6914 description: Response codes found in [response codes](https://wiki.onap.org/).
6918 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6921 example: __CLOUD-OWNER__
6922 - name: cloud-region-id
6924 description: Identifier used by the vendor for the region. Second part of composite key
6927 example: __CLOUD-REGION-ID__
6930 description: DVS switch name
6933 example: __SWITCH-NAME__
6936 description: dvs-switch object that needs to be created or updated.
6939 $ref: "#/patchDefinitions/dvs-switch"
6942 - CloudInfrastructure
6943 summary: delete an existing dvs-switch
6944 description: delete an existing dvs-switch
6945 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6954 description: Response codes found in [response codes](https://wiki.onap.org/).
6958 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6961 example: __CLOUD-OWNER__
6962 - name: cloud-region-id
6964 description: Identifier used by the vendor for the region. Second part of composite key
6967 example: __CLOUD-REGION-ID__
6970 description: DVS switch name
6973 example: __SWITCH-NAME__
6974 - name: resource-version
6976 description: resource-version for concurrency
6979 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches:
6982 - CloudInfrastructure
6983 summary: returns dvs-switches
6984 description: returns dvs-switches
6985 operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches
6991 description: successful operation
6993 $ref: "#/getDefinitions/dvs-switches"
6995 description: Response codes found in [response codes](https://wiki.onap.org/).
6999 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7002 example: __CLOUD-OWNER__
7003 - name: cloud-region-id
7005 description: Identifier used by the vendor for the region. Second part of composite key
7008 example: __CLOUD-REGION-ID__
7011 description: Type of the cloud (e.g., openstack)
7014 - name: owner-defined-type
7016 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7019 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship:
7022 - CloudInfrastructure
7023 summary: see node definition for valid relationships
7024 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
7033 description: Response codes found in [response codes](https://wiki.onap.org/).
7037 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7040 example: __CLOUD-OWNER__
7041 - name: cloud-region-id
7043 description: Identifier used by the vendor for the region. Second part of composite key
7046 example: __CLOUD-REGION-ID__
7047 - name: network-uuid
7049 description: UUID of the network. Unique across a cloud-region
7052 example: __NETWORK-UUID__
7055 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
7058 $ref: "#/definitions/relationship"
7061 - CloudInfrastructure
7062 summary: delete an existing relationship
7063 description: delete an existing relationship
7064 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
7073 description: Response codes found in [response codes](https://wiki.onap.org/).
7077 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7080 example: __CLOUD-OWNER__
7081 - name: cloud-region-id
7083 description: Identifier used by the vendor for the region. Second part of composite key
7086 example: __CLOUD-REGION-ID__
7087 - name: network-uuid
7089 description: UUID of the network. Unique across a cloud-region
7092 example: __NETWORK-UUID__
7093 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}:
7096 - CloudInfrastructure
7097 summary: returns oam-network
7098 description: returns oam-network
7099 operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7105 description: successful operation
7107 $ref: "#/getDefinitions/oam-network"
7109 description: Response codes found in [response codes](https://wiki.onap.org/).
7113 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7116 example: __CLOUD-OWNER__
7117 - name: cloud-region-id
7119 description: Identifier used by the vendor for the region. Second part of composite key
7122 example: __CLOUD-REGION-ID__
7123 - name: network-uuid
7125 description: UUID of the network. Unique across a cloud-region
7128 example: __NETWORK-UUID__
7131 description: Type of the cloud (e.g., openstack)
7134 - name: owner-defined-type
7136 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7139 - name: network-name
7141 description: Name of the network.
7146 description: cvlan-id
7152 - CloudInfrastructure
7153 summary: create or update an existing oam-network
7155 Create or update an existing oam-network.
7157 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
7158 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7167 description: Response codes found in [response codes](https://wiki.onap.org/).
7171 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7174 example: __CLOUD-OWNER__
7175 - name: cloud-region-id
7177 description: Identifier used by the vendor for the region. Second part of composite key
7180 example: __CLOUD-REGION-ID__
7181 - name: network-uuid
7183 description: UUID of the network. Unique across a cloud-region
7186 example: __NETWORK-UUID__
7189 description: oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
7192 $ref: "#/definitions/oam-network"
7195 - CloudInfrastructure
7196 summary: update an existing oam-network
7198 Update an existing oam-network
7200 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7201 The PUT operation will entirely replace an existing object.
7202 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
7204 Other differences between PUT and PATCH are:
7206 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
7207 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7208 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7209 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7218 description: Response codes found in [response codes](https://wiki.onap.org/).
7222 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7225 example: __CLOUD-OWNER__
7226 - name: cloud-region-id
7228 description: Identifier used by the vendor for the region. Second part of composite key
7231 example: __CLOUD-REGION-ID__
7232 - name: network-uuid
7234 description: UUID of the network. Unique across a cloud-region
7237 example: __NETWORK-UUID__
7240 description: oam-network object that needs to be created or updated.
7243 $ref: "#/patchDefinitions/oam-network"
7246 - CloudInfrastructure
7247 summary: delete an existing oam-network
7248 description: delete an existing oam-network
7249 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7258 description: Response codes found in [response codes](https://wiki.onap.org/).
7262 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7265 example: __CLOUD-OWNER__
7266 - name: cloud-region-id
7268 description: Identifier used by the vendor for the region. Second part of composite key
7271 example: __CLOUD-REGION-ID__
7272 - name: network-uuid
7274 description: UUID of the network. Unique across a cloud-region
7277 example: __NETWORK-UUID__
7278 - name: resource-version
7280 description: resource-version for concurrency
7283 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks:
7286 - CloudInfrastructure
7287 summary: returns oam-networks
7288 description: returns oam-networks
7289 operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworks
7295 description: successful operation
7297 $ref: "#/getDefinitions/oam-networks"
7299 description: Response codes found in [response codes](https://wiki.onap.org/).
7303 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7306 example: __CLOUD-OWNER__
7307 - name: cloud-region-id
7309 description: Identifier used by the vendor for the region. Second part of composite key
7312 example: __CLOUD-REGION-ID__
7315 description: Type of the cloud (e.g., openstack)
7318 - name: owner-defined-type
7320 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7323 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship:
7326 - CloudInfrastructure
7327 summary: see node definition for valid relationships
7328 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
7337 description: Response codes found in [response codes](https://wiki.onap.org/).
7341 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7344 example: __CLOUD-OWNER__
7345 - name: cloud-region-id
7347 description: Identifier used by the vendor for the region. Second part of composite key
7350 example: __CLOUD-REGION-ID__
7351 - name: availability-zone-name
7353 description: Name of the availability zone. Unique across a cloud region
7356 example: __AVAILABILITY-ZONE-NAME__
7359 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
7362 $ref: "#/definitions/relationship"
7365 - CloudInfrastructure
7366 summary: delete an existing relationship
7367 description: delete an existing relationship
7368 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
7377 description: Response codes found in [response codes](https://wiki.onap.org/).
7381 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7384 example: __CLOUD-OWNER__
7385 - name: cloud-region-id
7387 description: Identifier used by the vendor for the region. Second part of composite key
7390 example: __CLOUD-REGION-ID__
7391 - name: availability-zone-name
7393 description: Name of the availability zone. Unique across a cloud region
7396 example: __AVAILABILITY-ZONE-NAME__
7397 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}:
7400 - CloudInfrastructure
7401 summary: returns availability-zone
7402 description: returns availability-zone
7403 operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7409 description: successful operation
7411 $ref: "#/getDefinitions/availability-zone"
7413 description: Response codes found in [response codes](https://wiki.onap.org/).
7417 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7420 example: __CLOUD-OWNER__
7421 - name: cloud-region-id
7423 description: Identifier used by the vendor for the region. Second part of composite key
7426 example: __CLOUD-REGION-ID__
7427 - name: availability-zone-name
7429 description: Name of the availability zone. Unique across a cloud region
7432 example: __AVAILABILITY-ZONE-NAME__
7435 description: Type of the cloud (e.g., openstack)
7438 - name: owner-defined-type
7440 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7445 - CloudInfrastructure
7446 summary: create or update an existing availability-zone
7448 Create or update an existing availability-zone.
7450 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
7451 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7460 description: Response codes found in [response codes](https://wiki.onap.org/).
7464 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7467 example: __CLOUD-OWNER__
7468 - name: cloud-region-id
7470 description: Identifier used by the vendor for the region. Second part of composite key
7473 example: __CLOUD-REGION-ID__
7474 - name: availability-zone-name
7476 description: Name of the availability zone. Unique across a cloud region
7479 example: __AVAILABILITY-ZONE-NAME__
7482 description: availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
7485 $ref: "#/definitions/availability-zone"
7488 - CloudInfrastructure
7489 summary: update an existing availability-zone
7491 Update an existing availability-zone
7493 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7494 The PUT operation will entirely replace an existing object.
7495 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
7497 Other differences between PUT and PATCH are:
7499 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
7500 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7501 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7502 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7511 description: Response codes found in [response codes](https://wiki.onap.org/).
7515 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7518 example: __CLOUD-OWNER__
7519 - name: cloud-region-id
7521 description: Identifier used by the vendor for the region. Second part of composite key
7524 example: __CLOUD-REGION-ID__
7525 - name: availability-zone-name
7527 description: Name of the availability zone. Unique across a cloud region
7530 example: __AVAILABILITY-ZONE-NAME__
7533 description: availability-zone object that needs to be created or updated.
7536 $ref: "#/patchDefinitions/availability-zone"
7539 - CloudInfrastructure
7540 summary: delete an existing availability-zone
7541 description: delete an existing availability-zone
7542 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7551 description: Response codes found in [response codes](https://wiki.onap.org/).
7555 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7558 example: __CLOUD-OWNER__
7559 - name: cloud-region-id
7561 description: Identifier used by the vendor for the region. Second part of composite key
7564 example: __CLOUD-REGION-ID__
7565 - name: availability-zone-name
7567 description: Name of the availability zone. Unique across a cloud region
7570 example: __AVAILABILITY-ZONE-NAME__
7571 - name: resource-version
7573 description: resource-version for concurrency
7576 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones:
7579 - CloudInfrastructure
7580 summary: returns availability-zones
7581 description: returns availability-zones
7582 operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZones
7588 description: successful operation
7590 $ref: "#/getDefinitions/availability-zones"
7592 description: Response codes found in [response codes](https://wiki.onap.org/).
7596 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7599 example: __CLOUD-OWNER__
7600 - name: cloud-region-id
7602 description: Identifier used by the vendor for the region. Second part of composite key
7605 example: __CLOUD-REGION-ID__
7608 description: Type of the cloud (e.g., openstack)
7611 - name: owner-defined-type
7613 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7616 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship:
7619 - CloudInfrastructure
7620 summary: see node definition for valid relationships
7621 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
7630 description: Response codes found in [response codes](https://wiki.onap.org/).
7634 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7637 example: __CLOUD-OWNER__
7638 - name: cloud-region-id
7640 description: Identifier used by the vendor for the region. Second part of composite key
7643 example: __CLOUD-REGION-ID__
7646 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegion.json)
7649 $ref: "#/definitions/relationship"
7652 - CloudInfrastructure
7653 summary: delete an existing relationship
7654 description: delete an existing relationship
7655 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
7664 description: Response codes found in [response codes](https://wiki.onap.org/).
7668 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7671 example: __CLOUD-OWNER__
7672 - name: cloud-region-id
7674 description: Identifier used by the vendor for the region. Second part of composite key
7677 example: __CLOUD-REGION-ID__
7678 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}:
7681 - CloudInfrastructure
7682 summary: returns cloud-region
7683 description: returns cloud-region
7684 operationId: getCloudInfrastructureCloudRegionsCloudRegion
7690 description: successful operation
7692 $ref: "#/getDefinitions/cloud-region"
7694 description: Response codes found in [response codes](https://wiki.onap.org/).
7698 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7701 example: __CLOUD-OWNER__
7702 - name: cloud-region-id
7704 description: Identifier used by the vendor for the region. Second part of composite key
7707 example: __CLOUD-REGION-ID__
7710 description: Type of the cloud (e.g., openstack)
7713 - name: owner-defined-type
7715 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7720 - CloudInfrastructure
7721 summary: create or update an existing cloud-region
7723 Create or update an existing cloud-region.
7725 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
7726 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegion
7735 description: Response codes found in [response codes](https://wiki.onap.org/).
7739 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7742 example: __CLOUD-OWNER__
7743 - name: cloud-region-id
7745 description: Identifier used by the vendor for the region. Second part of composite key
7748 example: __CLOUD-REGION-ID__
7751 description: cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureCloudRegionsCloudRegion.json)
7754 $ref: "#/definitions/cloud-region"
7757 - CloudInfrastructure
7758 summary: update an existing cloud-region
7760 Update an existing cloud-region
7762 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7763 The PUT operation will entirely replace an existing object.
7764 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
7766 Other differences between PUT and PATCH are:
7768 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
7769 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7770 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7771 operationId: UpdateCloudInfrastructureCloudRegionsCloudRegion
7780 description: Response codes found in [response codes](https://wiki.onap.org/).
7784 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7787 example: __CLOUD-OWNER__
7788 - name: cloud-region-id
7790 description: Identifier used by the vendor for the region. Second part of composite key
7793 example: __CLOUD-REGION-ID__
7796 description: cloud-region object that needs to be created or updated.
7799 $ref: "#/patchDefinitions/cloud-region"
7802 - CloudInfrastructure
7803 summary: delete an existing cloud-region
7804 description: delete an existing cloud-region
7805 operationId: deleteCloudInfrastructureCloudRegionsCloudRegion
7814 description: Response codes found in [response codes](https://wiki.onap.org/).
7818 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7821 example: __CLOUD-OWNER__
7822 - name: cloud-region-id
7824 description: Identifier used by the vendor for the region. Second part of composite key
7827 example: __CLOUD-REGION-ID__
7828 - name: resource-version
7830 description: resource-version for concurrency
7833 /cloud-infrastructure/cloud-regions:
7836 - CloudInfrastructure
7837 summary: returns cloud-regions
7838 description: returns cloud-regions
7839 operationId: getCloudInfrastructureCloudRegions
7845 description: successful operation
7847 $ref: "#/getDefinitions/cloud-regions"
7849 description: Response codes found in [response codes](https://wiki.onap.org/).
7850 /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship:
7853 - CloudInfrastructure
7854 summary: see node definition for valid relationships
7855 operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
7864 description: Response codes found in [response codes](https://wiki.onap.org/).
7866 - name: nm-profile-name
7868 description: Unique name of network profile.
7871 example: __NM-PROFILE-NAME__
7874 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureNetworkProfilesNetworkProfile.json)
7877 $ref: "#/definitions/relationship"
7880 - CloudInfrastructure
7881 summary: delete an existing relationship
7882 description: delete an existing relationship
7883 operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
7892 description: Response codes found in [response codes](https://wiki.onap.org/).
7894 - name: nm-profile-name
7896 description: Unique name of network profile.
7899 example: __NM-PROFILE-NAME__
7900 /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}:
7903 - CloudInfrastructure
7904 summary: returns network-profile
7905 description: returns network-profile
7906 operationId: getCloudInfrastructureNetworkProfilesNetworkProfile
7912 description: successful operation
7914 $ref: "#/getDefinitions/network-profile"
7916 description: Response codes found in [response codes](https://wiki.onap.org/).
7918 - name: nm-profile-name
7920 description: Unique name of network profile.
7923 example: __NM-PROFILE-NAME__
7926 - CloudInfrastructure
7927 summary: create or update an existing network-profile
7929 Create or update an existing network-profile.
7931 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
7932 operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile
7941 description: Response codes found in [response codes](https://wiki.onap.org/).
7943 - name: nm-profile-name
7945 description: Unique name of network profile.
7948 example: __NM-PROFILE-NAME__
7951 description: network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureNetworkProfilesNetworkProfile.json)
7954 $ref: "#/definitions/network-profile"
7957 - CloudInfrastructure
7958 summary: update an existing network-profile
7960 Update an existing network-profile
7962 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7963 The PUT operation will entirely replace an existing object.
7964 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
7966 Other differences between PUT and PATCH are:
7968 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
7969 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7970 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7971 operationId: UpdateCloudInfrastructureNetworkProfilesNetworkProfile
7980 description: Response codes found in [response codes](https://wiki.onap.org/).
7982 - name: nm-profile-name
7984 description: Unique name of network profile.
7987 example: __NM-PROFILE-NAME__
7990 description: network-profile object that needs to be created or updated.
7993 $ref: "#/patchDefinitions/network-profile"
7996 - CloudInfrastructure
7997 summary: delete an existing network-profile
7998 description: delete an existing network-profile
7999 operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfile
8008 description: Response codes found in [response codes](https://wiki.onap.org/).
8010 - name: nm-profile-name
8012 description: Unique name of network profile.
8015 example: __NM-PROFILE-NAME__
8016 - name: resource-version
8018 description: resource-version for concurrency
8021 /cloud-infrastructure/network-profiles:
8024 - CloudInfrastructure
8025 summary: returns network-profiles
8026 description: returns network-profiles
8027 operationId: getCloudInfrastructureNetworkProfiles
8033 description: successful operation
8035 $ref: "#/getDefinitions/network-profiles"
8037 description: Response codes found in [response codes](https://wiki.onap.org/).
8038 /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship:
8041 - CloudInfrastructure
8042 summary: see node definition for valid relationships
8043 operationId: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship
8052 description: Response codes found in [response codes](https://wiki.onap.org/).
8056 description: Value from executing hostname on the compute node.
8059 example: __HOSTNAME__
8062 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserver.json)
8065 $ref: "#/definitions/relationship"
8068 - CloudInfrastructure
8069 summary: delete an existing relationship
8070 description: delete an existing relationship
8071 operationId: deleteCloudInfrastructurePserversPserverRelationshipListRelationship
8080 description: Response codes found in [response codes](https://wiki.onap.org/).
8084 description: Value from executing hostname on the compute node.
8087 example: __HOSTNAME__
8088 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
8091 - CloudInfrastructure
8092 summary: see node definition for valid relationships
8093 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
8102 description: Response codes found in [response codes](https://wiki.onap.org/).
8106 description: Value from executing hostname on the compute node.
8109 example: __HOSTNAME__
8110 - name: interface-name
8112 description: Name that identifies the physical interface
8115 example: __INTERFACE-NAME__
8118 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
8121 $ref: "#/definitions/relationship"
8124 - CloudInfrastructure
8125 summary: delete an existing relationship
8126 description: delete an existing relationship
8127 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
8136 description: Response codes found in [response codes](https://wiki.onap.org/).
8140 description: Value from executing hostname on the compute node.
8143 example: __HOSTNAME__
8144 - name: interface-name
8146 description: Name that identifies the physical interface
8149 example: __INTERFACE-NAME__
8150 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
8153 - CloudInfrastructure
8154 summary: see node definition for valid relationships
8155 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
8164 description: Response codes found in [response codes](https://wiki.onap.org/).
8168 description: Value from executing hostname on the compute node.
8171 example: __HOSTNAME__
8172 - name: interface-name
8174 description: Name that identifies the physical interface
8177 example: __INTERFACE-NAME__
8178 - name: interface-name
8180 description: Name given to the interface
8183 example: __INTERFACE-NAME__
8184 - name: vlan-interface
8186 description: String that identifies the interface
8189 example: __VLAN-INTERFACE__
8192 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
8195 $ref: "#/definitions/relationship"
8198 - CloudInfrastructure
8199 summary: delete an existing relationship
8200 description: delete an existing relationship
8201 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
8210 description: Response codes found in [response codes](https://wiki.onap.org/).
8214 description: Value from executing hostname on the compute node.
8217 example: __HOSTNAME__
8218 - name: interface-name
8220 description: Name that identifies the physical interface
8223 example: __INTERFACE-NAME__
8224 - name: interface-name
8226 description: Name given to the interface
8229 example: __INTERFACE-NAME__
8230 - name: vlan-interface
8232 description: String that identifies the interface
8235 example: __VLAN-INTERFACE__
8236 /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:
8239 - CloudInfrastructure
8240 summary: see node definition for valid relationships
8241 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
8250 description: Response codes found in [response codes](https://wiki.onap.org/).
8254 description: Value from executing hostname on the compute node.
8257 example: __HOSTNAME__
8258 - name: interface-name
8260 description: Name that identifies the physical interface
8263 example: __INTERFACE-NAME__
8264 - name: interface-name
8266 description: Name given to the interface
8269 example: __INTERFACE-NAME__
8270 - name: vlan-interface
8272 description: String that identifies the interface
8275 example: __VLAN-INTERFACE__
8276 - name: l3-interface-ipv4-address
8278 description: IP address
8281 example: __L3-INTERFACE-IPV4-ADDRESS__
8284 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
8287 $ref: "#/definitions/relationship"
8290 - CloudInfrastructure
8291 summary: delete an existing relationship
8292 description: delete an existing relationship
8293 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
8302 description: Response codes found in [response codes](https://wiki.onap.org/).
8306 description: Value from executing hostname on the compute node.
8309 example: __HOSTNAME__
8310 - name: interface-name
8312 description: Name that identifies the physical interface
8315 example: __INTERFACE-NAME__
8316 - name: interface-name
8318 description: Name given to the interface
8321 example: __INTERFACE-NAME__
8322 - name: vlan-interface
8324 description: String that identifies the interface
8327 example: __VLAN-INTERFACE__
8328 - name: l3-interface-ipv4-address
8330 description: IP address
8333 example: __L3-INTERFACE-IPV4-ADDRESS__
8334 /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}:
8337 - CloudInfrastructure
8338 summary: returns l3-interface-ipv4-address-list
8339 description: returns l3-interface-ipv4-address-list
8340 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8346 description: successful operation
8348 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
8350 description: Response codes found in [response codes](https://wiki.onap.org/).
8354 description: Value from executing hostname on the compute node.
8357 example: __HOSTNAME__
8358 - name: interface-name
8360 description: Name that identifies the physical interface
8363 example: __INTERFACE-NAME__
8364 - name: interface-name
8366 description: Name given to the interface
8369 example: __INTERFACE-NAME__
8370 - name: vlan-interface
8372 description: String that identifies the interface
8375 example: __VLAN-INTERFACE__
8376 - name: l3-interface-ipv4-address
8378 description: IP address
8381 example: __L3-INTERFACE-IPV4-ADDRESS__
8384 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
8389 description: ID of Pserver
8396 - name: pserver-name2
8398 description: alternative pserver name
8403 description: Trigger for operational monitoring of this resource by Service Assurance systems.
8406 - name: interface-id
8408 description: ID of interface
8413 description: MAC address for the interface
8416 - name: network-name
8418 description: Name of the network
8421 - name: vlan-id-inner
8423 description: Inner VLAN tag
8429 description: This indicates the customers VPN ID associated with this vlan
8432 - name: vlan-id-inner
8434 description: Inner VLAN tag
8438 - name: neutron-network-id
8440 description: Neutron network id of the interface that address belongs to
8443 - name: neutron-subnet-id
8445 description: Neutron id of subnet that address belongs to
8450 - CloudInfrastructure
8451 summary: create or update an existing l3-interface-ipv4-address-list
8453 Create or update an existing l3-interface-ipv4-address-list.
8455 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8456 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8465 description: Response codes found in [response codes](https://wiki.onap.org/).
8469 description: Value from executing hostname on the compute node.
8472 example: __HOSTNAME__
8473 - name: interface-name
8475 description: Name that identifies the physical interface
8478 example: __INTERFACE-NAME__
8479 - name: interface-name
8481 description: Name given to the interface
8484 example: __INTERFACE-NAME__
8485 - name: vlan-interface
8487 description: String that identifies the interface
8490 example: __VLAN-INTERFACE__
8491 - name: l3-interface-ipv4-address
8493 description: IP address
8496 example: __L3-INTERFACE-IPV4-ADDRESS__
8499 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
8502 $ref: "#/definitions/l3-interface-ipv4-address-list"
8505 - CloudInfrastructure
8506 summary: update an existing l3-interface-ipv4-address-list
8508 Update an existing l3-interface-ipv4-address-list
8510 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8511 The PUT operation will entirely replace an existing object.
8512 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8514 Other differences between PUT and PATCH are:
8516 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8517 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8518 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8519 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8528 description: Response codes found in [response codes](https://wiki.onap.org/).
8532 description: Value from executing hostname on the compute node.
8535 example: __HOSTNAME__
8536 - name: interface-name
8538 description: Name that identifies the physical interface
8541 example: __INTERFACE-NAME__
8542 - name: interface-name
8544 description: Name given to the interface
8547 example: __INTERFACE-NAME__
8548 - name: vlan-interface
8550 description: String that identifies the interface
8553 example: __VLAN-INTERFACE__
8554 - name: l3-interface-ipv4-address
8556 description: IP address
8559 example: __L3-INTERFACE-IPV4-ADDRESS__
8562 description: l3-interface-ipv4-address-list object that needs to be created or updated.
8565 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
8568 - CloudInfrastructure
8569 summary: delete an existing l3-interface-ipv4-address-list
8570 description: delete an existing l3-interface-ipv4-address-list
8571 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8580 description: Response codes found in [response codes](https://wiki.onap.org/).
8584 description: Value from executing hostname on the compute node.
8587 example: __HOSTNAME__
8588 - name: interface-name
8590 description: Name that identifies the physical interface
8593 example: __INTERFACE-NAME__
8594 - name: interface-name
8596 description: Name given to the interface
8599 example: __INTERFACE-NAME__
8600 - name: vlan-interface
8602 description: String that identifies the interface
8605 example: __VLAN-INTERFACE__
8606 - name: l3-interface-ipv4-address
8608 description: IP address
8611 example: __L3-INTERFACE-IPV4-ADDRESS__
8612 - name: resource-version
8614 description: resource-version for concurrency
8617 /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:
8620 - CloudInfrastructure
8621 summary: see node definition for valid relationships
8622 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
8631 description: Response codes found in [response codes](https://wiki.onap.org/).
8635 description: Value from executing hostname on the compute node.
8638 example: __HOSTNAME__
8639 - name: interface-name
8641 description: Name that identifies the physical interface
8644 example: __INTERFACE-NAME__
8645 - name: interface-name
8647 description: Name given to the interface
8650 example: __INTERFACE-NAME__
8651 - name: vlan-interface
8653 description: String that identifies the interface
8656 example: __VLAN-INTERFACE__
8657 - name: l3-interface-ipv6-address
8659 description: IP address
8662 example: __L3-INTERFACE-IPV6-ADDRESS__
8665 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
8668 $ref: "#/definitions/relationship"
8671 - CloudInfrastructure
8672 summary: delete an existing relationship
8673 description: delete an existing relationship
8674 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
8683 description: Response codes found in [response codes](https://wiki.onap.org/).
8687 description: Value from executing hostname on the compute node.
8690 example: __HOSTNAME__
8691 - name: interface-name
8693 description: Name that identifies the physical interface
8696 example: __INTERFACE-NAME__
8697 - name: interface-name
8699 description: Name given to the interface
8702 example: __INTERFACE-NAME__
8703 - name: vlan-interface
8705 description: String that identifies the interface
8708 example: __VLAN-INTERFACE__
8709 - name: l3-interface-ipv6-address
8711 description: IP address
8714 example: __L3-INTERFACE-IPV6-ADDRESS__
8715 /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}:
8718 - CloudInfrastructure
8719 summary: returns l3-interface-ipv6-address-list
8720 description: returns l3-interface-ipv6-address-list
8721 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8727 description: successful operation
8729 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
8731 description: Response codes found in [response codes](https://wiki.onap.org/).
8735 description: Value from executing hostname on the compute node.
8738 example: __HOSTNAME__
8739 - name: interface-name
8741 description: Name that identifies the physical interface
8744 example: __INTERFACE-NAME__
8745 - name: interface-name
8747 description: Name given to the interface
8750 example: __INTERFACE-NAME__
8751 - name: vlan-interface
8753 description: String that identifies the interface
8756 example: __VLAN-INTERFACE__
8757 - name: l3-interface-ipv6-address
8759 description: IP address
8762 example: __L3-INTERFACE-IPV6-ADDRESS__
8765 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
8770 description: ID of Pserver
8777 - name: pserver-name2
8779 description: alternative pserver name
8784 description: Trigger for operational monitoring of this resource by Service Assurance systems.
8787 - name: interface-id
8789 description: ID of interface
8794 description: MAC address for the interface
8797 - name: network-name
8799 description: Name of the network
8802 - name: vlan-id-inner
8804 description: Inner VLAN tag
8810 description: This indicates the customers VPN ID associated with this vlan
8813 - name: vlan-id-inner
8815 description: Inner VLAN tag
8819 - name: neutron-network-id
8821 description: Neutron network id of the interface that address belongs to
8824 - name: neutron-subnet-id
8826 description: Neutron id of subnet that address belongs to
8831 - CloudInfrastructure
8832 summary: create or update an existing l3-interface-ipv6-address-list
8834 Create or update an existing l3-interface-ipv6-address-list.
8836 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8837 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8846 description: Response codes found in [response codes](https://wiki.onap.org/).
8850 description: Value from executing hostname on the compute node.
8853 example: __HOSTNAME__
8854 - name: interface-name
8856 description: Name that identifies the physical interface
8859 example: __INTERFACE-NAME__
8860 - name: interface-name
8862 description: Name given to the interface
8865 example: __INTERFACE-NAME__
8866 - name: vlan-interface
8868 description: String that identifies the interface
8871 example: __VLAN-INTERFACE__
8872 - name: l3-interface-ipv6-address
8874 description: IP address
8877 example: __L3-INTERFACE-IPV6-ADDRESS__
8880 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
8883 $ref: "#/definitions/l3-interface-ipv6-address-list"
8886 - CloudInfrastructure
8887 summary: update an existing l3-interface-ipv6-address-list
8889 Update an existing l3-interface-ipv6-address-list
8891 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8892 The PUT operation will entirely replace an existing object.
8893 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8895 Other differences between PUT and PATCH are:
8897 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8898 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8899 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8900 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8909 description: Response codes found in [response codes](https://wiki.onap.org/).
8913 description: Value from executing hostname on the compute node.
8916 example: __HOSTNAME__
8917 - name: interface-name
8919 description: Name that identifies the physical interface
8922 example: __INTERFACE-NAME__
8923 - name: interface-name
8925 description: Name given to the interface
8928 example: __INTERFACE-NAME__
8929 - name: vlan-interface
8931 description: String that identifies the interface
8934 example: __VLAN-INTERFACE__
8935 - name: l3-interface-ipv6-address
8937 description: IP address
8940 example: __L3-INTERFACE-IPV6-ADDRESS__
8943 description: l3-interface-ipv6-address-list object that needs to be created or updated.
8946 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
8949 - CloudInfrastructure
8950 summary: delete an existing l3-interface-ipv6-address-list
8951 description: delete an existing l3-interface-ipv6-address-list
8952 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
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: vlan-interface
8983 description: String that identifies the interface
8986 example: __VLAN-INTERFACE__
8987 - name: l3-interface-ipv6-address
8989 description: IP address
8992 example: __L3-INTERFACE-IPV6-ADDRESS__
8993 - name: resource-version
8995 description: resource-version for concurrency
8998 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
9001 - CloudInfrastructure
9002 summary: returns vlan
9003 description: returns vlan
9004 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9010 description: successful operation
9012 $ref: "#/getDefinitions/vlan"
9014 description: Response codes found in [response codes](https://wiki.onap.org/).
9018 description: Value from executing hostname on the compute node.
9021 example: __HOSTNAME__
9022 - name: interface-name
9024 description: Name that identifies the physical interface
9027 example: __INTERFACE-NAME__
9028 - name: interface-name
9030 description: Name given to the interface
9033 example: __INTERFACE-NAME__
9034 - name: vlan-interface
9036 description: String that identifies the interface
9039 example: __VLAN-INTERFACE__
9042 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
9047 description: ID of Pserver
9054 - name: pserver-name2
9056 description: alternative pserver name
9061 description: Trigger for operational monitoring of this resource by Service Assurance systems.
9064 - name: interface-id
9066 description: ID of interface
9071 description: MAC address for the interface
9074 - name: network-name
9076 description: Name of the network
9079 - name: vlan-id-inner
9081 description: Inner VLAN tag
9087 description: This indicates the customers VPN ID associated with this vlan
9092 - CloudInfrastructure
9093 summary: create or update an existing vlan
9095 Create or update an existing vlan.
9097 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9098 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9107 description: Response codes found in [response codes](https://wiki.onap.org/).
9111 description: Value from executing hostname on the compute node.
9114 example: __HOSTNAME__
9115 - name: interface-name
9117 description: Name that identifies the physical interface
9120 example: __INTERFACE-NAME__
9121 - name: interface-name
9123 description: Name given to the interface
9126 example: __INTERFACE-NAME__
9127 - name: vlan-interface
9129 description: String that identifies the interface
9132 example: __VLAN-INTERFACE__
9135 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
9138 $ref: "#/definitions/vlan"
9141 - CloudInfrastructure
9142 summary: update an existing vlan
9144 Update an existing vlan
9146 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9147 The PUT operation will entirely replace an existing object.
9148 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9150 Other differences between PUT and PATCH are:
9152 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9153 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9154 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9155 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9164 description: Response codes found in [response codes](https://wiki.onap.org/).
9168 description: Value from executing hostname on the compute node.
9171 example: __HOSTNAME__
9172 - name: interface-name
9174 description: Name that identifies the physical interface
9177 example: __INTERFACE-NAME__
9178 - name: interface-name
9180 description: Name given to the interface
9183 example: __INTERFACE-NAME__
9184 - name: vlan-interface
9186 description: String that identifies the interface
9189 example: __VLAN-INTERFACE__
9192 description: vlan object that needs to be created or updated.
9195 $ref: "#/patchDefinitions/vlan"
9198 - CloudInfrastructure
9199 summary: delete an existing vlan
9200 description: delete an existing vlan
9201 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9210 description: Response codes found in [response codes](https://wiki.onap.org/).
9214 description: Value from executing hostname on the compute node.
9217 example: __HOSTNAME__
9218 - name: interface-name
9220 description: Name that identifies the physical interface
9223 example: __INTERFACE-NAME__
9224 - name: interface-name
9226 description: Name given to the interface
9229 example: __INTERFACE-NAME__
9230 - name: vlan-interface
9232 description: String that identifies the interface
9235 example: __VLAN-INTERFACE__
9236 - name: resource-version
9238 description: resource-version for concurrency
9241 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
9244 - CloudInfrastructure
9245 summary: returns vlans
9246 description: returns vlans
9247 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans
9253 description: successful operation
9255 $ref: "#/getDefinitions/vlans"
9257 description: Response codes found in [response codes](https://wiki.onap.org/).
9261 description: Value from executing hostname on the compute node.
9264 example: __HOSTNAME__
9265 - name: interface-name
9267 description: Name that identifies the physical interface
9270 example: __INTERFACE-NAME__
9271 - name: interface-name
9273 description: Name given to the interface
9276 example: __INTERFACE-NAME__
9279 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
9284 description: ID of Pserver
9291 - name: pserver-name2
9293 description: alternative pserver name
9298 description: Trigger for operational monitoring of this resource by Service Assurance systems.
9301 - name: interface-id
9303 description: ID of interface
9308 description: MAC address for the interface
9311 - name: network-name
9313 description: Name of the network
9316 /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:
9319 - CloudInfrastructure
9320 summary: see node definition for valid relationships
9321 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
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: PCI ID used to identify the sriov-vf
9358 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
9361 $ref: "#/definitions/relationship"
9364 - CloudInfrastructure
9365 summary: delete an existing relationship
9366 description: delete an existing relationship
9367 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
9376 description: Response codes found in [response codes](https://wiki.onap.org/).
9380 description: Value from executing hostname on the compute node.
9383 example: __HOSTNAME__
9384 - name: interface-name
9386 description: Name that identifies the physical interface
9389 example: __INTERFACE-NAME__
9390 - name: interface-name
9392 description: Name given to the interface
9395 example: __INTERFACE-NAME__
9398 description: PCI ID used to identify the sriov-vf
9402 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
9405 - CloudInfrastructure
9406 summary: returns sriov-vf
9407 description: returns sriov-vf
9408 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9414 description: successful operation
9416 $ref: "#/getDefinitions/sriov-vf"
9418 description: Response codes found in [response codes](https://wiki.onap.org/).
9422 description: Value from executing hostname on the compute node.
9425 example: __HOSTNAME__
9426 - name: interface-name
9428 description: Name that identifies the physical interface
9431 example: __INTERFACE-NAME__
9432 - name: interface-name
9434 description: Name given to the interface
9437 example: __INTERFACE-NAME__
9440 description: PCI ID used to identify the sriov-vf
9446 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
9451 description: ID of Pserver
9458 - name: pserver-name2
9460 description: alternative pserver name
9465 description: Trigger for operational monitoring of this resource by Service Assurance systems.
9468 - name: interface-id
9470 description: ID of interface
9475 description: MAC address for the interface
9478 - name: network-name
9480 description: Name of the network
9483 - name: vf-vlan-filter
9485 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
9488 - name: vf-mac-filter
9490 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
9493 - name: vf-vlan-strip
9495 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
9498 - name: neutron-network-id
9500 description: Neutron network id of the interface
9505 - CloudInfrastructure
9506 summary: create or update an existing sriov-vf
9508 Create or update an existing sriov-vf.
9510 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9511 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9520 description: Response codes found in [response codes](https://wiki.onap.org/).
9524 description: Value from executing hostname on the compute node.
9527 example: __HOSTNAME__
9528 - name: interface-name
9530 description: Name that identifies the physical interface
9533 example: __INTERFACE-NAME__
9534 - name: interface-name
9536 description: Name given to the interface
9539 example: __INTERFACE-NAME__
9542 description: PCI ID used to identify the sriov-vf
9548 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
9551 $ref: "#/definitions/sriov-vf"
9554 - CloudInfrastructure
9555 summary: update an existing sriov-vf
9557 Update an existing sriov-vf
9559 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9560 The PUT operation will entirely replace an existing object.
9561 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9563 Other differences between PUT and PATCH are:
9565 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9566 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9567 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9568 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9577 description: Response codes found in [response codes](https://wiki.onap.org/).
9581 description: Value from executing hostname on the compute node.
9584 example: __HOSTNAME__
9585 - name: interface-name
9587 description: Name that identifies the physical interface
9590 example: __INTERFACE-NAME__
9591 - name: interface-name
9593 description: Name given to the interface
9596 example: __INTERFACE-NAME__
9599 description: PCI ID used to identify the sriov-vf
9605 description: sriov-vf object that needs to be created or updated.
9608 $ref: "#/patchDefinitions/sriov-vf"
9611 - CloudInfrastructure
9612 summary: delete an existing sriov-vf
9613 description: delete an existing sriov-vf
9614 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9623 description: Response codes found in [response codes](https://wiki.onap.org/).
9627 description: Value from executing hostname on the compute node.
9630 example: __HOSTNAME__
9631 - name: interface-name
9633 description: Name that identifies the physical interface
9636 example: __INTERFACE-NAME__
9637 - name: interface-name
9639 description: Name given to the interface
9642 example: __INTERFACE-NAME__
9645 description: PCI ID used to identify the sriov-vf
9649 - name: resource-version
9651 description: resource-version for concurrency
9654 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
9657 - CloudInfrastructure
9658 summary: returns sriov-vfs
9659 description: returns sriov-vfs
9660 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
9666 description: successful operation
9668 $ref: "#/getDefinitions/sriov-vfs"
9670 description: Response codes found in [response codes](https://wiki.onap.org/).
9674 description: Value from executing hostname on the compute node.
9677 example: __HOSTNAME__
9678 - name: interface-name
9680 description: Name that identifies the physical interface
9683 example: __INTERFACE-NAME__
9684 - name: interface-name
9686 description: Name given to the interface
9689 example: __INTERFACE-NAME__
9692 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
9697 description: ID of Pserver
9704 - name: pserver-name2
9706 description: alternative pserver name
9711 description: Trigger for operational monitoring of this resource by Service Assurance systems.
9714 - name: interface-id
9716 description: ID of interface
9721 description: MAC address for the interface
9724 - name: network-name
9726 description: Name of the network
9729 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
9732 - CloudInfrastructure
9733 summary: see node definition for valid relationships
9734 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
9743 description: Response codes found in [response codes](https://wiki.onap.org/).
9747 description: Value from executing hostname on the compute node.
9750 example: __HOSTNAME__
9751 - name: interface-name
9753 description: Name that identifies the physical interface
9756 example: __INTERFACE-NAME__
9757 - name: interface-name
9759 description: Name given to the interface
9762 example: __INTERFACE-NAME__
9765 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
9768 $ref: "#/definitions/relationship"
9771 - CloudInfrastructure
9772 summary: delete an existing relationship
9773 description: delete an existing relationship
9774 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
9783 description: Response codes found in [response codes](https://wiki.onap.org/).
9787 description: Value from executing hostname on the compute node.
9790 example: __HOSTNAME__
9791 - name: interface-name
9793 description: Name that identifies the physical interface
9796 example: __INTERFACE-NAME__
9797 - name: interface-name
9799 description: Name given to the interface
9802 example: __INTERFACE-NAME__
9803 /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:
9806 - CloudInfrastructure
9807 summary: see node definition for valid relationships
9808 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
9817 description: Response codes found in [response codes](https://wiki.onap.org/).
9821 description: Value from executing hostname on the compute node.
9824 example: __HOSTNAME__
9825 - name: interface-name
9827 description: Name that identifies the physical interface
9830 example: __INTERFACE-NAME__
9831 - name: interface-name
9833 description: Name given to the interface
9836 example: __INTERFACE-NAME__
9837 - name: l3-interface-ipv4-address
9839 description: IP address
9842 example: __L3-INTERFACE-IPV4-ADDRESS__
9845 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
9848 $ref: "#/definitions/relationship"
9851 - CloudInfrastructure
9852 summary: delete an existing relationship
9853 description: delete an existing relationship
9854 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
9863 description: Response codes found in [response codes](https://wiki.onap.org/).
9867 description: Value from executing hostname on the compute node.
9870 example: __HOSTNAME__
9871 - name: interface-name
9873 description: Name that identifies the physical interface
9876 example: __INTERFACE-NAME__
9877 - name: interface-name
9879 description: Name given to the interface
9882 example: __INTERFACE-NAME__
9883 - name: l3-interface-ipv4-address
9885 description: IP address
9888 example: __L3-INTERFACE-IPV4-ADDRESS__
9889 /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}:
9892 - CloudInfrastructure
9893 summary: returns l3-interface-ipv4-address-list
9894 description: returns l3-interface-ipv4-address-list
9895 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
9901 description: successful operation
9903 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
9905 description: Response codes found in [response codes](https://wiki.onap.org/).
9909 description: Value from executing hostname on the compute node.
9912 example: __HOSTNAME__
9913 - name: interface-name
9915 description: Name that identifies the physical interface
9918 example: __INTERFACE-NAME__
9919 - name: interface-name
9921 description: Name given to the interface
9924 example: __INTERFACE-NAME__
9925 - name: l3-interface-ipv4-address
9927 description: IP address
9930 example: __L3-INTERFACE-IPV4-ADDRESS__
9933 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
9938 description: ID of Pserver
9945 - name: pserver-name2
9947 description: alternative pserver name
9952 description: Trigger for operational monitoring of this resource by Service Assurance systems.
9955 - name: interface-id
9957 description: ID of interface
9962 description: MAC address for the interface
9965 - name: network-name
9967 description: Name of the network
9970 - name: vlan-id-inner
9972 description: Inner VLAN tag
9976 - name: neutron-network-id
9978 description: Neutron network id of the interface that address belongs to
9981 - name: neutron-subnet-id
9983 description: Neutron id of subnet that address belongs to
9988 - CloudInfrastructure
9989 summary: create or update an existing l3-interface-ipv4-address-list
9991 Create or update an existing l3-interface-ipv4-address-list.
9993 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9994 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
10003 description: Response codes found in [response codes](https://wiki.onap.org/).
10007 description: Value from executing hostname on the compute node.
10010 example: __HOSTNAME__
10011 - name: interface-name
10013 description: Name that identifies the physical interface
10016 example: __INTERFACE-NAME__
10017 - name: interface-name
10019 description: Name given to the interface
10022 example: __INTERFACE-NAME__
10023 - name: l3-interface-ipv4-address
10025 description: IP address
10028 example: __L3-INTERFACE-IPV4-ADDRESS__
10031 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
10034 $ref: "#/definitions/l3-interface-ipv4-address-list"
10037 - CloudInfrastructure
10038 summary: update an existing l3-interface-ipv4-address-list
10040 Update an existing l3-interface-ipv4-address-list
10042 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10043 The PUT operation will entirely replace an existing object.
10044 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10046 Other differences between PUT and PATCH are:
10048 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10049 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10050 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10051 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
10060 description: Response codes found in [response codes](https://wiki.onap.org/).
10064 description: Value from executing hostname on the compute node.
10067 example: __HOSTNAME__
10068 - name: interface-name
10070 description: Name that identifies the physical interface
10073 example: __INTERFACE-NAME__
10074 - name: interface-name
10076 description: Name given to the interface
10079 example: __INTERFACE-NAME__
10080 - name: l3-interface-ipv4-address
10082 description: IP address
10085 example: __L3-INTERFACE-IPV4-ADDRESS__
10088 description: l3-interface-ipv4-address-list object that needs to be created or updated.
10091 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
10094 - CloudInfrastructure
10095 summary: delete an existing l3-interface-ipv4-address-list
10096 description: delete an existing l3-interface-ipv4-address-list
10097 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
10106 description: Response codes found in [response codes](https://wiki.onap.org/).
10110 description: Value from executing hostname on the compute node.
10113 example: __HOSTNAME__
10114 - name: interface-name
10116 description: Name that identifies the physical interface
10119 example: __INTERFACE-NAME__
10120 - name: interface-name
10122 description: Name given to the interface
10125 example: __INTERFACE-NAME__
10126 - name: l3-interface-ipv4-address
10128 description: IP address
10131 example: __L3-INTERFACE-IPV4-ADDRESS__
10132 - name: resource-version
10134 description: resource-version for concurrency
10137 /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:
10140 - CloudInfrastructure
10141 summary: see node definition for valid relationships
10142 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
10151 description: Response codes found in [response codes](https://wiki.onap.org/).
10155 description: Value from executing hostname on the compute node.
10158 example: __HOSTNAME__
10159 - name: interface-name
10161 description: Name that identifies the physical interface
10164 example: __INTERFACE-NAME__
10165 - name: interface-name
10167 description: Name given to the interface
10170 example: __INTERFACE-NAME__
10171 - name: l3-interface-ipv6-address
10173 description: IP address
10176 example: __L3-INTERFACE-IPV6-ADDRESS__
10179 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
10182 $ref: "#/definitions/relationship"
10185 - CloudInfrastructure
10186 summary: delete an existing relationship
10187 description: delete an existing relationship
10188 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
10197 description: Response codes found in [response codes](https://wiki.onap.org/).
10201 description: Value from executing hostname on the compute node.
10204 example: __HOSTNAME__
10205 - name: interface-name
10207 description: Name that identifies the physical interface
10210 example: __INTERFACE-NAME__
10211 - name: interface-name
10213 description: Name given to the interface
10216 example: __INTERFACE-NAME__
10217 - name: l3-interface-ipv6-address
10219 description: IP address
10222 example: __L3-INTERFACE-IPV6-ADDRESS__
10223 /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}:
10226 - CloudInfrastructure
10227 summary: returns l3-interface-ipv6-address-list
10228 description: returns l3-interface-ipv6-address-list
10229 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10235 description: successful operation
10237 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
10239 description: Response codes found in [response codes](https://wiki.onap.org/).
10243 description: Value from executing hostname on the compute node.
10246 example: __HOSTNAME__
10247 - name: interface-name
10249 description: Name that identifies the physical interface
10252 example: __INTERFACE-NAME__
10253 - name: interface-name
10255 description: Name given to the interface
10258 example: __INTERFACE-NAME__
10259 - name: l3-interface-ipv6-address
10261 description: IP address
10264 example: __L3-INTERFACE-IPV6-ADDRESS__
10267 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
10272 description: ID of Pserver
10279 - name: pserver-name2
10281 description: alternative pserver name
10284 - name: prov-status
10286 description: Trigger for operational monitoring of this resource by Service Assurance systems.
10289 - name: interface-id
10291 description: ID of interface
10296 description: MAC address for the interface
10299 - name: network-name
10301 description: Name of the network
10304 - name: vlan-id-inner
10306 description: Inner VLAN tag
10310 - name: neutron-network-id
10312 description: Neutron network id of the interface that address belongs to
10315 - name: neutron-subnet-id
10317 description: Neutron id of subnet that address belongs to
10322 - CloudInfrastructure
10323 summary: create or update an existing l3-interface-ipv6-address-list
10325 Create or update an existing l3-interface-ipv6-address-list.
10327 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10328 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10337 description: Response codes found in [response codes](https://wiki.onap.org/).
10341 description: Value from executing hostname on the compute node.
10344 example: __HOSTNAME__
10345 - name: interface-name
10347 description: Name that identifies the physical interface
10350 example: __INTERFACE-NAME__
10351 - name: interface-name
10353 description: Name given to the interface
10356 example: __INTERFACE-NAME__
10357 - name: l3-interface-ipv6-address
10359 description: IP address
10362 example: __L3-INTERFACE-IPV6-ADDRESS__
10365 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
10368 $ref: "#/definitions/l3-interface-ipv6-address-list"
10371 - CloudInfrastructure
10372 summary: update an existing l3-interface-ipv6-address-list
10374 Update an existing l3-interface-ipv6-address-list
10376 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10377 The PUT operation will entirely replace an existing object.
10378 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10380 Other differences between PUT and PATCH are:
10382 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10383 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10384 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10385 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10394 description: Response codes found in [response codes](https://wiki.onap.org/).
10398 description: Value from executing hostname on the compute node.
10401 example: __HOSTNAME__
10402 - name: interface-name
10404 description: Name that identifies the physical interface
10407 example: __INTERFACE-NAME__
10408 - name: interface-name
10410 description: Name given to the interface
10413 example: __INTERFACE-NAME__
10414 - name: l3-interface-ipv6-address
10416 description: IP address
10419 example: __L3-INTERFACE-IPV6-ADDRESS__
10422 description: l3-interface-ipv6-address-list object that needs to be created or updated.
10425 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
10428 - CloudInfrastructure
10429 summary: delete an existing l3-interface-ipv6-address-list
10430 description: delete an existing l3-interface-ipv6-address-list
10431 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10440 description: Response codes found in [response codes](https://wiki.onap.org/).
10444 description: Value from executing hostname on the compute node.
10447 example: __HOSTNAME__
10448 - name: interface-name
10450 description: Name that identifies the physical interface
10453 example: __INTERFACE-NAME__
10454 - name: interface-name
10456 description: Name given to the interface
10459 example: __INTERFACE-NAME__
10460 - name: l3-interface-ipv6-address
10462 description: IP address
10465 example: __L3-INTERFACE-IPV6-ADDRESS__
10466 - name: resource-version
10468 description: resource-version for concurrency
10471 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
10474 - CloudInfrastructure
10475 summary: returns l-interface
10476 description: returns l-interface
10477 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10483 description: successful operation
10485 $ref: "#/getDefinitions/l-interface"
10487 description: Response codes found in [response codes](https://wiki.onap.org/).
10491 description: Value from executing hostname on the compute node.
10494 example: __HOSTNAME__
10495 - name: interface-name
10497 description: Name that identifies the physical interface
10500 example: __INTERFACE-NAME__
10501 - name: interface-name
10503 description: Name given to the interface
10506 example: __INTERFACE-NAME__
10509 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
10514 description: ID of Pserver
10521 - name: pserver-name2
10523 description: alternative pserver name
10526 - name: prov-status
10528 description: Trigger for operational monitoring of this resource by Service Assurance systems.
10531 - name: interface-id
10533 description: ID of interface
10538 description: MAC address for the interface
10541 - name: network-name
10543 description: Name of the network
10548 - CloudInfrastructure
10549 summary: create or update an existing l-interface
10551 Create or update an existing l-interface.
10553 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10554 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10563 description: Response codes found in [response codes](https://wiki.onap.org/).
10567 description: Value from executing hostname on the compute node.
10570 example: __HOSTNAME__
10571 - name: interface-name
10573 description: Name that identifies the physical interface
10576 example: __INTERFACE-NAME__
10577 - name: interface-name
10579 description: Name given to the interface
10582 example: __INTERFACE-NAME__
10585 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
10588 $ref: "#/definitions/l-interface"
10591 - CloudInfrastructure
10592 summary: update an existing l-interface
10594 Update an existing l-interface
10596 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10597 The PUT operation will entirely replace an existing object.
10598 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10600 Other differences between PUT and PATCH are:
10602 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10603 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10604 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10605 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10614 description: Response codes found in [response codes](https://wiki.onap.org/).
10618 description: Value from executing hostname on the compute node.
10621 example: __HOSTNAME__
10622 - name: interface-name
10624 description: Name that identifies the physical interface
10627 example: __INTERFACE-NAME__
10628 - name: interface-name
10630 description: Name given to the interface
10633 example: __INTERFACE-NAME__
10636 description: l-interface object that needs to be created or updated.
10639 $ref: "#/patchDefinitions/l-interface"
10642 - CloudInfrastructure
10643 summary: delete an existing l-interface
10644 description: delete an existing l-interface
10645 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10654 description: Response codes found in [response codes](https://wiki.onap.org/).
10658 description: Value from executing hostname on the compute node.
10661 example: __HOSTNAME__
10662 - name: interface-name
10664 description: Name that identifies the physical interface
10667 example: __INTERFACE-NAME__
10668 - name: interface-name
10670 description: Name given to the interface
10673 example: __INTERFACE-NAME__
10674 - name: resource-version
10676 description: resource-version for concurrency
10679 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces:
10682 - CloudInfrastructure
10683 summary: returns l-interfaces
10684 description: returns l-interfaces
10685 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces
10691 description: successful operation
10693 $ref: "#/getDefinitions/l-interfaces"
10695 description: Response codes found in [response codes](https://wiki.onap.org/).
10699 description: Value from executing hostname on the compute node.
10702 example: __HOSTNAME__
10703 - name: interface-name
10705 description: Name that identifies the physical interface
10708 example: __INTERFACE-NAME__
10711 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
10716 description: ID of Pserver
10723 - name: pserver-name2
10725 description: alternative pserver name
10728 - name: prov-status
10730 description: Trigger for operational monitoring of this resource by Service Assurance systems.
10733 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}:
10736 - CloudInfrastructure
10737 summary: returns p-interface
10738 description: returns p-interface
10739 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface
10745 description: successful operation
10747 $ref: "#/getDefinitions/p-interface"
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 physical interface
10762 example: __INTERFACE-NAME__
10765 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
10770 description: ID of Pserver
10777 - name: pserver-name2
10779 description: alternative pserver name
10782 - name: prov-status
10784 description: Trigger for operational monitoring of this resource by Service Assurance systems.
10789 - CloudInfrastructure
10790 summary: create or update an existing p-interface
10792 Create or update an existing p-interface.
10794 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10795 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface
10804 description: Response codes found in [response codes](https://wiki.onap.org/).
10808 description: Value from executing hostname on the compute node.
10811 example: __HOSTNAME__
10812 - name: interface-name
10814 description: Name that identifies the physical interface
10817 example: __INTERFACE-NAME__
10820 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
10823 $ref: "#/definitions/p-interface"
10826 - CloudInfrastructure
10827 summary: update an existing p-interface
10829 Update an existing p-interface
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: UpdateCloudInfrastructurePserversPserverPInterfacesPInterface
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 physical interface
10862 example: __INTERFACE-NAME__
10865 description: p-interface object that needs to be created or updated.
10868 $ref: "#/patchDefinitions/p-interface"
10871 - CloudInfrastructure
10872 summary: delete an existing p-interface
10873 description: delete an existing p-interface
10874 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface
10883 description: Response codes found in [response codes](https://wiki.onap.org/).
10887 description: Value from executing hostname on the compute node.
10890 example: __HOSTNAME__
10891 - name: interface-name
10893 description: Name that identifies the physical interface
10896 example: __INTERFACE-NAME__
10897 - name: resource-version
10899 description: resource-version for concurrency
10902 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces:
10905 - CloudInfrastructure
10906 summary: returns p-interfaces
10907 description: returns p-interfaces
10908 operationId: getCloudInfrastructurePserversPserverPInterfaces
10914 description: successful operation
10916 $ref: "#/getDefinitions/p-interfaces"
10918 description: Response codes found in [response codes](https://wiki.onap.org/).
10922 description: Value from executing hostname on the compute node.
10925 example: __HOSTNAME__
10928 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
10933 description: ID of Pserver
10940 - name: pserver-name2
10942 description: alternative pserver name
10945 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
10948 - CloudInfrastructure
10949 summary: see node definition for valid relationships
10950 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
10959 description: Response codes found in [response codes](https://wiki.onap.org/).
10963 description: Value from executing hostname on the compute node.
10966 example: __HOSTNAME__
10967 - name: interface-name
10969 description: Name that identifies the link aggregate interface
10972 example: __INTERFACE-NAME__
10975 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
10978 $ref: "#/definitions/relationship"
10981 - CloudInfrastructure
10982 summary: delete an existing relationship
10983 description: delete an existing relationship
10984 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
10993 description: Response codes found in [response codes](https://wiki.onap.org/).
10997 description: Value from executing hostname on the compute node.
11000 example: __HOSTNAME__
11001 - name: interface-name
11003 description: Name that identifies the link aggregate interface
11006 example: __INTERFACE-NAME__
11007 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
11010 - CloudInfrastructure
11011 summary: see node definition for valid relationships
11012 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
11021 description: Response codes found in [response codes](https://wiki.onap.org/).
11025 description: Value from executing hostname on the compute node.
11028 example: __HOSTNAME__
11029 - name: interface-name
11031 description: Name that identifies the link aggregate interface
11034 example: __INTERFACE-NAME__
11035 - name: interface-name
11037 description: Name given to the interface
11040 example: __INTERFACE-NAME__
11041 - name: vlan-interface
11043 description: String that identifies the interface
11046 example: __VLAN-INTERFACE__
11049 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
11052 $ref: "#/definitions/relationship"
11055 - CloudInfrastructure
11056 summary: delete an existing relationship
11057 description: delete an existing relationship
11058 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
11067 description: Response codes found in [response codes](https://wiki.onap.org/).
11071 description: Value from executing hostname on the compute node.
11074 example: __HOSTNAME__
11075 - name: interface-name
11077 description: Name that identifies the link aggregate interface
11080 example: __INTERFACE-NAME__
11081 - name: interface-name
11083 description: Name given to the interface
11086 example: __INTERFACE-NAME__
11087 - name: vlan-interface
11089 description: String that identifies the interface
11092 example: __VLAN-INTERFACE__
11093 /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:
11096 - CloudInfrastructure
11097 summary: see node definition for valid relationships
11098 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
11107 description: Response codes found in [response codes](https://wiki.onap.org/).
11111 description: Value from executing hostname on the compute node.
11114 example: __HOSTNAME__
11115 - name: interface-name
11117 description: Name that identifies the link aggregate interface
11120 example: __INTERFACE-NAME__
11121 - name: interface-name
11123 description: Name given to the interface
11126 example: __INTERFACE-NAME__
11127 - name: vlan-interface
11129 description: String that identifies the interface
11132 example: __VLAN-INTERFACE__
11133 - name: l3-interface-ipv4-address
11135 description: IP address
11138 example: __L3-INTERFACE-IPV4-ADDRESS__
11141 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
11144 $ref: "#/definitions/relationship"
11147 - CloudInfrastructure
11148 summary: delete an existing relationship
11149 description: delete an existing relationship
11150 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
11159 description: Response codes found in [response codes](https://wiki.onap.org/).
11163 description: Value from executing hostname on the compute node.
11166 example: __HOSTNAME__
11167 - name: interface-name
11169 description: Name that identifies the link aggregate interface
11172 example: __INTERFACE-NAME__
11173 - name: interface-name
11175 description: Name given to the interface
11178 example: __INTERFACE-NAME__
11179 - name: vlan-interface
11181 description: String that identifies the interface
11184 example: __VLAN-INTERFACE__
11185 - name: l3-interface-ipv4-address
11187 description: IP address
11190 example: __L3-INTERFACE-IPV4-ADDRESS__
11191 /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}:
11194 - CloudInfrastructure
11195 summary: returns l3-interface-ipv4-address-list
11196 description: returns l3-interface-ipv4-address-list
11197 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11203 description: successful operation
11205 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
11207 description: Response codes found in [response codes](https://wiki.onap.org/).
11211 description: Value from executing hostname on the compute node.
11214 example: __HOSTNAME__
11215 - name: interface-name
11217 description: Name that identifies the link aggregate interface
11220 example: __INTERFACE-NAME__
11221 - name: interface-name
11223 description: Name given to the interface
11226 example: __INTERFACE-NAME__
11227 - name: vlan-interface
11229 description: String that identifies the interface
11232 example: __VLAN-INTERFACE__
11233 - name: l3-interface-ipv4-address
11235 description: IP address
11238 example: __L3-INTERFACE-IPV4-ADDRESS__
11241 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
11246 description: ID of Pserver
11253 - name: pserver-name2
11255 description: alternative pserver name
11258 - name: interface-id
11260 description: ID of interface
11263 - name: interface-role
11265 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
11268 - name: interface-id
11270 description: ID of interface
11275 description: MAC address for the interface
11278 - name: network-name
11280 description: Name of the network
11283 - name: vlan-id-inner
11285 description: Inner VLAN tag
11291 description: This indicates the customers VPN ID associated with this vlan
11294 - name: vlan-id-inner
11296 description: Inner VLAN tag
11300 - name: neutron-network-id
11302 description: Neutron network id of the interface that address belongs to
11305 - name: neutron-subnet-id
11307 description: Neutron id of subnet that address belongs to
11312 - CloudInfrastructure
11313 summary: create or update an existing l3-interface-ipv4-address-list
11315 Create or update an existing l3-interface-ipv4-address-list.
11317 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11318 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11327 description: Response codes found in [response codes](https://wiki.onap.org/).
11331 description: Value from executing hostname on the compute node.
11334 example: __HOSTNAME__
11335 - name: interface-name
11337 description: Name that identifies the link aggregate interface
11340 example: __INTERFACE-NAME__
11341 - name: interface-name
11343 description: Name given to the interface
11346 example: __INTERFACE-NAME__
11347 - name: vlan-interface
11349 description: String that identifies the interface
11352 example: __VLAN-INTERFACE__
11353 - name: l3-interface-ipv4-address
11355 description: IP address
11358 example: __L3-INTERFACE-IPV4-ADDRESS__
11361 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
11364 $ref: "#/definitions/l3-interface-ipv4-address-list"
11367 - CloudInfrastructure
11368 summary: update an existing l3-interface-ipv4-address-list
11370 Update an existing l3-interface-ipv4-address-list
11372 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11373 The PUT operation will entirely replace an existing object.
11374 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11376 Other differences between PUT and PATCH are:
11378 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11379 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11380 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11381 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11390 description: Response codes found in [response codes](https://wiki.onap.org/).
11394 description: Value from executing hostname on the compute node.
11397 example: __HOSTNAME__
11398 - name: interface-name
11400 description: Name that identifies the link aggregate interface
11403 example: __INTERFACE-NAME__
11404 - name: interface-name
11406 description: Name given to the interface
11409 example: __INTERFACE-NAME__
11410 - name: vlan-interface
11412 description: String that identifies the interface
11415 example: __VLAN-INTERFACE__
11416 - name: l3-interface-ipv4-address
11418 description: IP address
11421 example: __L3-INTERFACE-IPV4-ADDRESS__
11424 description: l3-interface-ipv4-address-list object that needs to be created or updated.
11427 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
11430 - CloudInfrastructure
11431 summary: delete an existing l3-interface-ipv4-address-list
11432 description: delete an existing l3-interface-ipv4-address-list
11433 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
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: vlan-interface
11464 description: String that identifies the interface
11467 example: __VLAN-INTERFACE__
11468 - name: l3-interface-ipv4-address
11470 description: IP address
11473 example: __L3-INTERFACE-IPV4-ADDRESS__
11474 - name: resource-version
11476 description: resource-version for concurrency
11479 /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:
11482 - CloudInfrastructure
11483 summary: see node definition for valid relationships
11484 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
11493 description: Response codes found in [response codes](https://wiki.onap.org/).
11497 description: Value from executing hostname on the compute node.
11500 example: __HOSTNAME__
11501 - name: interface-name
11503 description: Name that identifies the link aggregate interface
11506 example: __INTERFACE-NAME__
11507 - name: interface-name
11509 description: Name given to the interface
11512 example: __INTERFACE-NAME__
11513 - name: vlan-interface
11515 description: String that identifies the interface
11518 example: __VLAN-INTERFACE__
11519 - name: l3-interface-ipv6-address
11521 description: IP address
11524 example: __L3-INTERFACE-IPV6-ADDRESS__
11527 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
11530 $ref: "#/definitions/relationship"
11533 - CloudInfrastructure
11534 summary: delete an existing relationship
11535 description: delete an existing relationship
11536 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
11545 description: Response codes found in [response codes](https://wiki.onap.org/).
11549 description: Value from executing hostname on the compute node.
11552 example: __HOSTNAME__
11553 - name: interface-name
11555 description: Name that identifies the link aggregate interface
11558 example: __INTERFACE-NAME__
11559 - name: interface-name
11561 description: Name given to the interface
11564 example: __INTERFACE-NAME__
11565 - name: vlan-interface
11567 description: String that identifies the interface
11570 example: __VLAN-INTERFACE__
11571 - name: l3-interface-ipv6-address
11573 description: IP address
11576 example: __L3-INTERFACE-IPV6-ADDRESS__
11577 /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}:
11580 - CloudInfrastructure
11581 summary: returns l3-interface-ipv6-address-list
11582 description: returns l3-interface-ipv6-address-list
11583 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11589 description: successful operation
11591 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
11593 description: Response codes found in [response codes](https://wiki.onap.org/).
11597 description: Value from executing hostname on the compute node.
11600 example: __HOSTNAME__
11601 - name: interface-name
11603 description: Name that identifies the link aggregate interface
11606 example: __INTERFACE-NAME__
11607 - name: interface-name
11609 description: Name given to the interface
11612 example: __INTERFACE-NAME__
11613 - name: vlan-interface
11615 description: String that identifies the interface
11618 example: __VLAN-INTERFACE__
11619 - name: l3-interface-ipv6-address
11621 description: IP address
11624 example: __L3-INTERFACE-IPV6-ADDRESS__
11627 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
11632 description: ID of Pserver
11639 - name: pserver-name2
11641 description: alternative pserver name
11644 - name: interface-id
11646 description: ID of interface
11649 - name: interface-role
11651 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
11654 - name: interface-id
11656 description: ID of interface
11661 description: MAC address for the interface
11664 - name: network-name
11666 description: Name of the network
11669 - name: vlan-id-inner
11671 description: Inner VLAN tag
11677 description: This indicates the customers VPN ID associated with this vlan
11680 - name: vlan-id-inner
11682 description: Inner VLAN tag
11686 - name: neutron-network-id
11688 description: Neutron network id of the interface that address belongs to
11691 - name: neutron-subnet-id
11693 description: Neutron id of subnet that address belongs to
11698 - CloudInfrastructure
11699 summary: create or update an existing l3-interface-ipv6-address-list
11701 Create or update an existing l3-interface-ipv6-address-list.
11703 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11704 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11713 description: Response codes found in [response codes](https://wiki.onap.org/).
11717 description: Value from executing hostname on the compute node.
11720 example: __HOSTNAME__
11721 - name: interface-name
11723 description: Name that identifies the link aggregate interface
11726 example: __INTERFACE-NAME__
11727 - name: interface-name
11729 description: Name given to the interface
11732 example: __INTERFACE-NAME__
11733 - name: vlan-interface
11735 description: String that identifies the interface
11738 example: __VLAN-INTERFACE__
11739 - name: l3-interface-ipv6-address
11741 description: IP address
11744 example: __L3-INTERFACE-IPV6-ADDRESS__
11747 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
11750 $ref: "#/definitions/l3-interface-ipv6-address-list"
11753 - CloudInfrastructure
11754 summary: update an existing l3-interface-ipv6-address-list
11756 Update an existing l3-interface-ipv6-address-list
11758 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11759 The PUT operation will entirely replace an existing object.
11760 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11762 Other differences between PUT and PATCH are:
11764 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11765 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11766 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11767 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11776 description: Response codes found in [response codes](https://wiki.onap.org/).
11780 description: Value from executing hostname on the compute node.
11783 example: __HOSTNAME__
11784 - name: interface-name
11786 description: Name that identifies the link aggregate interface
11789 example: __INTERFACE-NAME__
11790 - name: interface-name
11792 description: Name given to the interface
11795 example: __INTERFACE-NAME__
11796 - name: vlan-interface
11798 description: String that identifies the interface
11801 example: __VLAN-INTERFACE__
11802 - name: l3-interface-ipv6-address
11804 description: IP address
11807 example: __L3-INTERFACE-IPV6-ADDRESS__
11810 description: l3-interface-ipv6-address-list object that needs to be created or updated.
11813 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
11816 - CloudInfrastructure
11817 summary: delete an existing l3-interface-ipv6-address-list
11818 description: delete an existing l3-interface-ipv6-address-list
11819 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11828 description: Response codes found in [response codes](https://wiki.onap.org/).
11832 description: Value from executing hostname on the compute node.
11835 example: __HOSTNAME__
11836 - name: interface-name
11838 description: Name that identifies the link aggregate interface
11841 example: __INTERFACE-NAME__
11842 - name: interface-name
11844 description: Name given to the interface
11847 example: __INTERFACE-NAME__
11848 - name: vlan-interface
11850 description: String that identifies the interface
11853 example: __VLAN-INTERFACE__
11854 - name: l3-interface-ipv6-address
11856 description: IP address
11859 example: __L3-INTERFACE-IPV6-ADDRESS__
11860 - name: resource-version
11862 description: resource-version for concurrency
11865 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
11868 - CloudInfrastructure
11869 summary: returns vlan
11870 description: returns vlan
11871 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
11877 description: successful operation
11879 $ref: "#/getDefinitions/vlan"
11881 description: Response codes found in [response codes](https://wiki.onap.org/).
11885 description: Value from executing hostname on the compute node.
11888 example: __HOSTNAME__
11889 - name: interface-name
11891 description: Name that identifies the link aggregate interface
11894 example: __INTERFACE-NAME__
11895 - name: interface-name
11897 description: Name given to the interface
11900 example: __INTERFACE-NAME__
11901 - name: vlan-interface
11903 description: String that identifies the interface
11906 example: __VLAN-INTERFACE__
11909 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
11914 description: ID of Pserver
11921 - name: pserver-name2
11923 description: alternative pserver name
11926 - name: interface-id
11928 description: ID of interface
11931 - name: interface-role
11933 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
11936 - name: interface-id
11938 description: ID of interface
11943 description: MAC address for the interface
11946 - name: network-name
11948 description: Name of the network
11951 - name: vlan-id-inner
11953 description: Inner VLAN tag
11959 description: This indicates the customers VPN ID associated with this vlan
11964 - CloudInfrastructure
11965 summary: create or update an existing vlan
11967 Create or update an existing vlan.
11969 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11970 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
11979 description: Response codes found in [response codes](https://wiki.onap.org/).
11983 description: Value from executing hostname on the compute node.
11986 example: __HOSTNAME__
11987 - name: interface-name
11989 description: Name that identifies the link aggregate interface
11992 example: __INTERFACE-NAME__
11993 - name: interface-name
11995 description: Name given to the interface
11998 example: __INTERFACE-NAME__
11999 - name: vlan-interface
12001 description: String that identifies the interface
12004 example: __VLAN-INTERFACE__
12007 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
12010 $ref: "#/definitions/vlan"
12013 - CloudInfrastructure
12014 summary: update an existing vlan
12016 Update an existing vlan
12018 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12019 The PUT operation will entirely replace an existing object.
12020 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12022 Other differences between PUT and PATCH are:
12024 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12025 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12026 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12027 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
12036 description: Response codes found in [response codes](https://wiki.onap.org/).
12040 description: Value from executing hostname on the compute node.
12043 example: __HOSTNAME__
12044 - name: interface-name
12046 description: Name that identifies the link aggregate interface
12049 example: __INTERFACE-NAME__
12050 - name: interface-name
12052 description: Name given to the interface
12055 example: __INTERFACE-NAME__
12056 - name: vlan-interface
12058 description: String that identifies the interface
12061 example: __VLAN-INTERFACE__
12064 description: vlan object that needs to be created or updated.
12067 $ref: "#/patchDefinitions/vlan"
12070 - CloudInfrastructure
12071 summary: delete an existing vlan
12072 description: delete an existing vlan
12073 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
12082 description: Response codes found in [response codes](https://wiki.onap.org/).
12086 description: Value from executing hostname on the compute node.
12089 example: __HOSTNAME__
12090 - name: interface-name
12092 description: Name that identifies the link aggregate interface
12095 example: __INTERFACE-NAME__
12096 - name: interface-name
12098 description: Name given to the interface
12101 example: __INTERFACE-NAME__
12102 - name: vlan-interface
12104 description: String that identifies the interface
12107 example: __VLAN-INTERFACE__
12108 - name: resource-version
12110 description: resource-version for concurrency
12113 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
12116 - CloudInfrastructure
12117 summary: returns vlans
12118 description: returns vlans
12119 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
12125 description: successful operation
12127 $ref: "#/getDefinitions/vlans"
12129 description: Response codes found in [response codes](https://wiki.onap.org/).
12133 description: Value from executing hostname on the compute node.
12136 example: __HOSTNAME__
12137 - name: interface-name
12139 description: Name that identifies the link aggregate interface
12142 example: __INTERFACE-NAME__
12143 - name: interface-name
12145 description: Name given to the interface
12148 example: __INTERFACE-NAME__
12151 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
12156 description: ID of Pserver
12163 - name: pserver-name2
12165 description: alternative pserver name
12168 - name: interface-id
12170 description: ID of interface
12173 - name: interface-role
12175 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
12178 - name: interface-id
12180 description: ID of interface
12185 description: MAC address for the interface
12188 - name: network-name
12190 description: Name of the network
12193 /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:
12196 - CloudInfrastructure
12197 summary: see node definition for valid relationships
12198 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
12207 description: Response codes found in [response codes](https://wiki.onap.org/).
12211 description: Value from executing hostname on the compute node.
12214 example: __HOSTNAME__
12215 - name: interface-name
12217 description: Name that identifies the link aggregate interface
12220 example: __INTERFACE-NAME__
12221 - name: interface-name
12223 description: Name given to the interface
12226 example: __INTERFACE-NAME__
12229 description: PCI ID used to identify the sriov-vf
12232 example: __PCI-ID__
12235 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
12238 $ref: "#/definitions/relationship"
12241 - CloudInfrastructure
12242 summary: delete an existing relationship
12243 description: delete an existing relationship
12244 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
12253 description: Response codes found in [response codes](https://wiki.onap.org/).
12257 description: Value from executing hostname on the compute node.
12260 example: __HOSTNAME__
12261 - name: interface-name
12263 description: Name that identifies the link aggregate interface
12266 example: __INTERFACE-NAME__
12267 - name: interface-name
12269 description: Name given to the interface
12272 example: __INTERFACE-NAME__
12275 description: PCI ID used to identify the sriov-vf
12278 example: __PCI-ID__
12279 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
12282 - CloudInfrastructure
12283 summary: returns sriov-vf
12284 description: returns sriov-vf
12285 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12291 description: successful operation
12293 $ref: "#/getDefinitions/sriov-vf"
12295 description: Response codes found in [response codes](https://wiki.onap.org/).
12299 description: Value from executing hostname on the compute node.
12302 example: __HOSTNAME__
12303 - name: interface-name
12305 description: Name that identifies the link aggregate interface
12308 example: __INTERFACE-NAME__
12309 - name: interface-name
12311 description: Name given to the interface
12314 example: __INTERFACE-NAME__
12317 description: PCI ID used to identify the sriov-vf
12320 example: __PCI-ID__
12323 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
12328 description: ID of Pserver
12335 - name: pserver-name2
12337 description: alternative pserver name
12340 - name: interface-id
12342 description: ID of interface
12345 - name: interface-role
12347 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
12350 - name: interface-id
12352 description: ID of interface
12357 description: MAC address for the interface
12360 - name: network-name
12362 description: Name of the network
12365 - name: vf-vlan-filter
12367 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
12370 - name: vf-mac-filter
12372 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
12375 - name: vf-vlan-strip
12377 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
12380 - name: neutron-network-id
12382 description: Neutron network id of the interface
12387 - CloudInfrastructure
12388 summary: create or update an existing sriov-vf
12390 Create or update an existing sriov-vf.
12392 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12393 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12402 description: Response codes found in [response codes](https://wiki.onap.org/).
12406 description: Value from executing hostname on the compute node.
12409 example: __HOSTNAME__
12410 - name: interface-name
12412 description: Name that identifies the link aggregate interface
12415 example: __INTERFACE-NAME__
12416 - name: interface-name
12418 description: Name given to the interface
12421 example: __INTERFACE-NAME__
12424 description: PCI ID used to identify the sriov-vf
12427 example: __PCI-ID__
12430 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
12433 $ref: "#/definitions/sriov-vf"
12436 - CloudInfrastructure
12437 summary: update an existing sriov-vf
12439 Update an existing sriov-vf
12441 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12442 The PUT operation will entirely replace an existing object.
12443 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12445 Other differences between PUT and PATCH are:
12447 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12448 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12449 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12450 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12459 description: Response codes found in [response codes](https://wiki.onap.org/).
12463 description: Value from executing hostname on the compute node.
12466 example: __HOSTNAME__
12467 - name: interface-name
12469 description: Name that identifies the link aggregate interface
12472 example: __INTERFACE-NAME__
12473 - name: interface-name
12475 description: Name given to the interface
12478 example: __INTERFACE-NAME__
12481 description: PCI ID used to identify the sriov-vf
12484 example: __PCI-ID__
12487 description: sriov-vf object that needs to be created or updated.
12490 $ref: "#/patchDefinitions/sriov-vf"
12493 - CloudInfrastructure
12494 summary: delete an existing sriov-vf
12495 description: delete an existing sriov-vf
12496 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12505 description: Response codes found in [response codes](https://wiki.onap.org/).
12509 description: Value from executing hostname on the compute node.
12512 example: __HOSTNAME__
12513 - name: interface-name
12515 description: Name that identifies the link aggregate interface
12518 example: __INTERFACE-NAME__
12519 - name: interface-name
12521 description: Name given to the interface
12524 example: __INTERFACE-NAME__
12527 description: PCI ID used to identify the sriov-vf
12530 example: __PCI-ID__
12531 - name: resource-version
12533 description: resource-version for concurrency
12536 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
12539 - CloudInfrastructure
12540 summary: returns sriov-vfs
12541 description: returns sriov-vfs
12542 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
12548 description: successful operation
12550 $ref: "#/getDefinitions/sriov-vfs"
12552 description: Response codes found in [response codes](https://wiki.onap.org/).
12556 description: Value from executing hostname on the compute node.
12559 example: __HOSTNAME__
12560 - name: interface-name
12562 description: Name that identifies the link aggregate interface
12565 example: __INTERFACE-NAME__
12566 - name: interface-name
12568 description: Name given to the interface
12571 example: __INTERFACE-NAME__
12574 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
12579 description: ID of Pserver
12586 - name: pserver-name2
12588 description: alternative pserver name
12591 - name: interface-id
12593 description: ID of interface
12596 - name: interface-role
12598 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
12601 - name: interface-id
12603 description: ID of interface
12608 description: MAC address for the interface
12611 - name: network-name
12613 description: Name of the network
12616 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
12619 - CloudInfrastructure
12620 summary: see node definition for valid relationships
12621 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
12630 description: Response codes found in [response codes](https://wiki.onap.org/).
12634 description: Value from executing hostname on the compute node.
12637 example: __HOSTNAME__
12638 - name: interface-name
12640 description: Name that identifies the link aggregate interface
12643 example: __INTERFACE-NAME__
12644 - name: interface-name
12646 description: Name given to the interface
12649 example: __INTERFACE-NAME__
12652 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
12655 $ref: "#/definitions/relationship"
12658 - CloudInfrastructure
12659 summary: delete an existing relationship
12660 description: delete an existing relationship
12661 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
12670 description: Response codes found in [response codes](https://wiki.onap.org/).
12674 description: Value from executing hostname on the compute node.
12677 example: __HOSTNAME__
12678 - name: interface-name
12680 description: Name that identifies the link aggregate interface
12683 example: __INTERFACE-NAME__
12684 - name: interface-name
12686 description: Name given to the interface
12689 example: __INTERFACE-NAME__
12690 /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:
12693 - CloudInfrastructure
12694 summary: see node definition for valid relationships
12695 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
12704 description: Response codes found in [response codes](https://wiki.onap.org/).
12708 description: Value from executing hostname on the compute node.
12711 example: __HOSTNAME__
12712 - name: interface-name
12714 description: Name that identifies the link aggregate interface
12717 example: __INTERFACE-NAME__
12718 - name: interface-name
12720 description: Name given to the interface
12723 example: __INTERFACE-NAME__
12724 - name: l3-interface-ipv4-address
12726 description: IP address
12729 example: __L3-INTERFACE-IPV4-ADDRESS__
12732 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
12735 $ref: "#/definitions/relationship"
12738 - CloudInfrastructure
12739 summary: delete an existing relationship
12740 description: delete an existing relationship
12741 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
12750 description: Response codes found in [response codes](https://wiki.onap.org/).
12754 description: Value from executing hostname on the compute node.
12757 example: __HOSTNAME__
12758 - name: interface-name
12760 description: Name that identifies the link aggregate interface
12763 example: __INTERFACE-NAME__
12764 - name: interface-name
12766 description: Name given to the interface
12769 example: __INTERFACE-NAME__
12770 - name: l3-interface-ipv4-address
12772 description: IP address
12775 example: __L3-INTERFACE-IPV4-ADDRESS__
12776 /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}:
12779 - CloudInfrastructure
12780 summary: returns l3-interface-ipv4-address-list
12781 description: returns l3-interface-ipv4-address-list
12782 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12788 description: successful operation
12790 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
12792 description: Response codes found in [response codes](https://wiki.onap.org/).
12796 description: Value from executing hostname on the compute node.
12799 example: __HOSTNAME__
12800 - name: interface-name
12802 description: Name that identifies the link aggregate interface
12805 example: __INTERFACE-NAME__
12806 - name: interface-name
12808 description: Name given to the interface
12811 example: __INTERFACE-NAME__
12812 - name: l3-interface-ipv4-address
12814 description: IP address
12817 example: __L3-INTERFACE-IPV4-ADDRESS__
12820 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
12825 description: ID of Pserver
12832 - name: pserver-name2
12834 description: alternative pserver name
12837 - name: interface-id
12839 description: ID of interface
12842 - name: interface-role
12844 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
12847 - name: interface-id
12849 description: ID of interface
12854 description: MAC address for the interface
12857 - name: network-name
12859 description: Name of the network
12862 - name: vlan-id-inner
12864 description: Inner VLAN tag
12868 - name: neutron-network-id
12870 description: Neutron network id of the interface that address belongs to
12873 - name: neutron-subnet-id
12875 description: Neutron id of subnet that address belongs to
12880 - CloudInfrastructure
12881 summary: create or update an existing l3-interface-ipv4-address-list
12883 Create or update an existing l3-interface-ipv4-address-list.
12885 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12886 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12895 description: Response codes found in [response codes](https://wiki.onap.org/).
12899 description: Value from executing hostname on the compute node.
12902 example: __HOSTNAME__
12903 - name: interface-name
12905 description: Name that identifies the link aggregate interface
12908 example: __INTERFACE-NAME__
12909 - name: interface-name
12911 description: Name given to the interface
12914 example: __INTERFACE-NAME__
12915 - name: l3-interface-ipv4-address
12917 description: IP address
12920 example: __L3-INTERFACE-IPV4-ADDRESS__
12923 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
12926 $ref: "#/definitions/l3-interface-ipv4-address-list"
12929 - CloudInfrastructure
12930 summary: update an existing l3-interface-ipv4-address-list
12932 Update an existing l3-interface-ipv4-address-list
12934 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12935 The PUT operation will entirely replace an existing object.
12936 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12938 Other differences between PUT and PATCH are:
12940 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12941 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12942 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12943 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12952 description: Response codes found in [response codes](https://wiki.onap.org/).
12956 description: Value from executing hostname on the compute node.
12959 example: __HOSTNAME__
12960 - name: interface-name
12962 description: Name that identifies the link aggregate interface
12965 example: __INTERFACE-NAME__
12966 - name: interface-name
12968 description: Name given to the interface
12971 example: __INTERFACE-NAME__
12972 - name: l3-interface-ipv4-address
12974 description: IP address
12977 example: __L3-INTERFACE-IPV4-ADDRESS__
12980 description: l3-interface-ipv4-address-list object that needs to be created or updated.
12983 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
12986 - CloudInfrastructure
12987 summary: delete an existing l3-interface-ipv4-address-list
12988 description: delete an existing l3-interface-ipv4-address-list
12989 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12998 description: Response codes found in [response codes](https://wiki.onap.org/).
13002 description: Value from executing hostname on the compute node.
13005 example: __HOSTNAME__
13006 - name: interface-name
13008 description: Name that identifies the link aggregate interface
13011 example: __INTERFACE-NAME__
13012 - name: interface-name
13014 description: Name given to the interface
13017 example: __INTERFACE-NAME__
13018 - name: l3-interface-ipv4-address
13020 description: IP address
13023 example: __L3-INTERFACE-IPV4-ADDRESS__
13024 - name: resource-version
13026 description: resource-version for concurrency
13029 /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:
13032 - CloudInfrastructure
13033 summary: see node definition for valid relationships
13034 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
13043 description: Response codes found in [response codes](https://wiki.onap.org/).
13047 description: Value from executing hostname on the compute node.
13050 example: __HOSTNAME__
13051 - name: interface-name
13053 description: Name that identifies the link aggregate interface
13056 example: __INTERFACE-NAME__
13057 - name: interface-name
13059 description: Name given to the interface
13062 example: __INTERFACE-NAME__
13063 - name: l3-interface-ipv6-address
13065 description: IP address
13068 example: __L3-INTERFACE-IPV6-ADDRESS__
13071 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
13074 $ref: "#/definitions/relationship"
13077 - CloudInfrastructure
13078 summary: delete an existing relationship
13079 description: delete an existing relationship
13080 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
13089 description: Response codes found in [response codes](https://wiki.onap.org/).
13093 description: Value from executing hostname on the compute node.
13096 example: __HOSTNAME__
13097 - name: interface-name
13099 description: Name that identifies the link aggregate interface
13102 example: __INTERFACE-NAME__
13103 - name: interface-name
13105 description: Name given to the interface
13108 example: __INTERFACE-NAME__
13109 - name: l3-interface-ipv6-address
13111 description: IP address
13114 example: __L3-INTERFACE-IPV6-ADDRESS__
13115 /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}:
13118 - CloudInfrastructure
13119 summary: returns l3-interface-ipv6-address-list
13120 description: returns l3-interface-ipv6-address-list
13121 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13127 description: successful operation
13129 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
13131 description: Response codes found in [response codes](https://wiki.onap.org/).
13135 description: Value from executing hostname on the compute node.
13138 example: __HOSTNAME__
13139 - name: interface-name
13141 description: Name that identifies the link aggregate interface
13144 example: __INTERFACE-NAME__
13145 - name: interface-name
13147 description: Name given to the interface
13150 example: __INTERFACE-NAME__
13151 - name: l3-interface-ipv6-address
13153 description: IP address
13156 example: __L3-INTERFACE-IPV6-ADDRESS__
13159 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
13164 description: ID of Pserver
13171 - name: pserver-name2
13173 description: alternative pserver name
13176 - name: interface-id
13178 description: ID of interface
13181 - name: interface-role
13183 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13186 - name: interface-id
13188 description: ID of interface
13193 description: MAC address for the interface
13196 - name: network-name
13198 description: Name of the network
13201 - name: vlan-id-inner
13203 description: Inner VLAN tag
13207 - name: neutron-network-id
13209 description: Neutron network id of the interface that address belongs to
13212 - name: neutron-subnet-id
13214 description: Neutron id of subnet that address belongs to
13219 - CloudInfrastructure
13220 summary: create or update an existing l3-interface-ipv6-address-list
13222 Create or update an existing l3-interface-ipv6-address-list.
13224 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13225 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13234 description: Response codes found in [response codes](https://wiki.onap.org/).
13238 description: Value from executing hostname on the compute node.
13241 example: __HOSTNAME__
13242 - name: interface-name
13244 description: Name that identifies the link aggregate interface
13247 example: __INTERFACE-NAME__
13248 - name: interface-name
13250 description: Name given to the interface
13253 example: __INTERFACE-NAME__
13254 - name: l3-interface-ipv6-address
13256 description: IP address
13259 example: __L3-INTERFACE-IPV6-ADDRESS__
13262 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
13265 $ref: "#/definitions/l3-interface-ipv6-address-list"
13268 - CloudInfrastructure
13269 summary: update an existing l3-interface-ipv6-address-list
13271 Update an existing l3-interface-ipv6-address-list
13273 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13274 The PUT operation will entirely replace an existing object.
13275 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13277 Other differences between PUT and PATCH are:
13279 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13280 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13281 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13282 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13291 description: Response codes found in [response codes](https://wiki.onap.org/).
13295 description: Value from executing hostname on the compute node.
13298 example: __HOSTNAME__
13299 - name: interface-name
13301 description: Name that identifies the link aggregate interface
13304 example: __INTERFACE-NAME__
13305 - name: interface-name
13307 description: Name given to the interface
13310 example: __INTERFACE-NAME__
13311 - name: l3-interface-ipv6-address
13313 description: IP address
13316 example: __L3-INTERFACE-IPV6-ADDRESS__
13319 description: l3-interface-ipv6-address-list object that needs to be created or updated.
13322 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
13325 - CloudInfrastructure
13326 summary: delete an existing l3-interface-ipv6-address-list
13327 description: delete an existing l3-interface-ipv6-address-list
13328 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13337 description: Response codes found in [response codes](https://wiki.onap.org/).
13341 description: Value from executing hostname on the compute node.
13344 example: __HOSTNAME__
13345 - name: interface-name
13347 description: Name that identifies the link aggregate interface
13350 example: __INTERFACE-NAME__
13351 - name: interface-name
13353 description: Name given to the interface
13356 example: __INTERFACE-NAME__
13357 - name: l3-interface-ipv6-address
13359 description: IP address
13362 example: __L3-INTERFACE-IPV6-ADDRESS__
13363 - name: resource-version
13365 description: resource-version for concurrency
13368 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
13371 - CloudInfrastructure
13372 summary: returns l-interface
13373 description: returns l-interface
13374 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13380 description: successful operation
13382 $ref: "#/getDefinitions/l-interface"
13384 description: Response codes found in [response codes](https://wiki.onap.org/).
13388 description: Value from executing hostname on the compute node.
13391 example: __HOSTNAME__
13392 - name: interface-name
13394 description: Name that identifies the link aggregate interface
13397 example: __INTERFACE-NAME__
13398 - name: interface-name
13400 description: Name given to the interface
13403 example: __INTERFACE-NAME__
13406 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
13411 description: ID of Pserver
13418 - name: pserver-name2
13420 description: alternative pserver name
13423 - name: interface-id
13425 description: ID of interface
13428 - name: interface-role
13430 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13433 - name: interface-id
13435 description: ID of interface
13440 description: MAC address for the interface
13443 - name: network-name
13445 description: Name of the network
13450 - CloudInfrastructure
13451 summary: create or update an existing l-interface
13453 Create or update an existing l-interface.
13455 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13456 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13465 description: Response codes found in [response codes](https://wiki.onap.org/).
13469 description: Value from executing hostname on the compute node.
13472 example: __HOSTNAME__
13473 - name: interface-name
13475 description: Name that identifies the link aggregate interface
13478 example: __INTERFACE-NAME__
13479 - name: interface-name
13481 description: Name given to the interface
13484 example: __INTERFACE-NAME__
13487 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
13490 $ref: "#/definitions/l-interface"
13493 - CloudInfrastructure
13494 summary: update an existing l-interface
13496 Update an existing l-interface
13498 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13499 The PUT operation will entirely replace an existing object.
13500 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13502 Other differences between PUT and PATCH are:
13504 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13505 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13506 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13507 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13516 description: Response codes found in [response codes](https://wiki.onap.org/).
13520 description: Value from executing hostname on the compute node.
13523 example: __HOSTNAME__
13524 - name: interface-name
13526 description: Name that identifies the link aggregate interface
13529 example: __INTERFACE-NAME__
13530 - name: interface-name
13532 description: Name given to the interface
13535 example: __INTERFACE-NAME__
13538 description: l-interface object that needs to be created or updated.
13541 $ref: "#/patchDefinitions/l-interface"
13544 - CloudInfrastructure
13545 summary: delete an existing l-interface
13546 description: delete an existing l-interface
13547 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13556 description: Response codes found in [response codes](https://wiki.onap.org/).
13560 description: Value from executing hostname on the compute node.
13563 example: __HOSTNAME__
13564 - name: interface-name
13566 description: Name that identifies the link aggregate interface
13569 example: __INTERFACE-NAME__
13570 - name: interface-name
13572 description: Name given to the interface
13575 example: __INTERFACE-NAME__
13576 - name: resource-version
13578 description: resource-version for concurrency
13581 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
13584 - CloudInfrastructure
13585 summary: returns l-interfaces
13586 description: returns l-interfaces
13587 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces
13593 description: successful operation
13595 $ref: "#/getDefinitions/l-interfaces"
13597 description: Response codes found in [response codes](https://wiki.onap.org/).
13601 description: Value from executing hostname on the compute node.
13604 example: __HOSTNAME__
13605 - name: interface-name
13607 description: Name that identifies the link aggregate interface
13610 example: __INTERFACE-NAME__
13613 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
13618 description: ID of Pserver
13625 - name: pserver-name2
13627 description: alternative pserver name
13630 - name: interface-id
13632 description: ID of interface
13635 - name: interface-role
13637 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13640 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}:
13643 - CloudInfrastructure
13644 summary: returns lag-interface
13645 description: returns lag-interface
13646 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface
13652 description: successful operation
13654 $ref: "#/getDefinitions/lag-interface"
13656 description: Response codes found in [response codes](https://wiki.onap.org/).
13660 description: Value from executing hostname on the compute node.
13663 example: __HOSTNAME__
13664 - name: interface-name
13666 description: Name that identifies the link aggregate interface
13669 example: __INTERFACE-NAME__
13672 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
13677 description: ID of Pserver
13684 - name: pserver-name2
13686 description: alternative pserver name
13689 - name: interface-id
13691 description: ID of interface
13694 - name: interface-role
13696 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13701 - CloudInfrastructure
13702 summary: create or update an existing lag-interface
13704 Create or update an existing lag-interface.
13706 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13707 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
13716 description: Response codes found in [response codes](https://wiki.onap.org/).
13720 description: Value from executing hostname on the compute node.
13723 example: __HOSTNAME__
13724 - name: interface-name
13726 description: Name that identifies the link aggregate interface
13729 example: __INTERFACE-NAME__
13732 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
13735 $ref: "#/definitions/lag-interface"
13738 - CloudInfrastructure
13739 summary: update an existing lag-interface
13741 Update an existing lag-interface
13743 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13744 The PUT operation will entirely replace an existing object.
13745 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13747 Other differences between PUT and PATCH are:
13749 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13750 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13751 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13752 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
13761 description: Response codes found in [response codes](https://wiki.onap.org/).
13765 description: Value from executing hostname on the compute node.
13768 example: __HOSTNAME__
13769 - name: interface-name
13771 description: Name that identifies the link aggregate interface
13774 example: __INTERFACE-NAME__
13777 description: lag-interface object that needs to be created or updated.
13780 $ref: "#/patchDefinitions/lag-interface"
13783 - CloudInfrastructure
13784 summary: delete an existing lag-interface
13785 description: delete an existing lag-interface
13786 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface
13795 description: Response codes found in [response codes](https://wiki.onap.org/).
13799 description: Value from executing hostname on the compute node.
13802 example: __HOSTNAME__
13803 - name: interface-name
13805 description: Name that identifies the link aggregate interface
13808 example: __INTERFACE-NAME__
13809 - name: resource-version
13811 description: resource-version for concurrency
13814 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces:
13817 - CloudInfrastructure
13818 summary: returns lag-interfaces
13819 description: returns lag-interfaces
13820 operationId: getCloudInfrastructurePserversPserverLagInterfaces
13826 description: successful operation
13828 $ref: "#/getDefinitions/lag-interfaces"
13830 description: Response codes found in [response codes](https://wiki.onap.org/).
13834 description: Value from executing hostname on the compute node.
13837 example: __HOSTNAME__
13840 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
13845 description: ID of Pserver
13852 - name: pserver-name2
13854 description: alternative pserver name
13857 /cloud-infrastructure/pservers/pserver/{hostname}:
13860 - CloudInfrastructure
13861 summary: returns pserver
13862 description: returns pserver
13863 operationId: getCloudInfrastructurePserversPserver
13869 description: successful operation
13871 $ref: "#/getDefinitions/pserver"
13873 description: Response codes found in [response codes](https://wiki.onap.org/).
13877 description: Value from executing hostname on the compute node.
13880 example: __HOSTNAME__
13883 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
13888 description: ID of Pserver
13895 - name: pserver-name2
13897 description: alternative pserver name
13902 - CloudInfrastructure
13903 summary: create or update an existing pserver
13905 Create or update an existing pserver.
13907 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13908 operationId: createOrUpdateCloudInfrastructurePserversPserver
13917 description: Response codes found in [response codes](https://wiki.onap.org/).
13921 description: Value from executing hostname on the compute node.
13924 example: __HOSTNAME__
13927 description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserver.json)
13930 $ref: "#/definitions/pserver"
13933 - CloudInfrastructure
13934 summary: update an existing pserver
13936 Update an existing pserver
13938 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13939 The PUT operation will entirely replace an existing object.
13940 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13942 Other differences between PUT and PATCH are:
13944 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13945 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13946 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13947 operationId: UpdateCloudInfrastructurePserversPserver
13956 description: Response codes found in [response codes](https://wiki.onap.org/).
13960 description: Value from executing hostname on the compute node.
13963 example: __HOSTNAME__
13966 description: pserver object that needs to be created or updated.
13969 $ref: "#/patchDefinitions/pserver"
13972 - CloudInfrastructure
13973 summary: delete an existing pserver
13974 description: delete an existing pserver
13975 operationId: deleteCloudInfrastructurePserversPserver
13984 description: Response codes found in [response codes](https://wiki.onap.org/).
13988 description: Value from executing hostname on the compute node.
13991 example: __HOSTNAME__
13992 - name: resource-version
13994 description: resource-version for concurrency
13997 /cloud-infrastructure/pservers:
14000 - CloudInfrastructure
14001 summary: returns pservers
14002 description: returns pservers
14003 operationId: getCloudInfrastructurePservers
14009 description: successful operation
14011 $ref: "#/getDefinitions/pservers"
14013 description: Response codes found in [response codes](https://wiki.onap.org/).
14014 /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship:
14017 - CloudInfrastructure
14018 summary: see node definition for valid relationships
14019 operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
14028 description: Response codes found in [response codes](https://wiki.onap.org/).
14032 description: Unique ID of the vdc
14035 example: __VDC-ID__
14038 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
14041 $ref: "#/definitions/relationship"
14044 - CloudInfrastructure
14045 summary: delete an existing relationship
14046 description: delete an existing relationship
14047 operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
14056 description: Response codes found in [response codes](https://wiki.onap.org/).
14060 description: Unique ID of the vdc
14063 example: __VDC-ID__
14064 /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}:
14067 - CloudInfrastructure
14068 summary: returns virtual-data-center
14069 description: returns virtual-data-center
14070 operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter
14076 description: successful operation
14078 $ref: "#/getDefinitions/virtual-data-center"
14080 description: Response codes found in [response codes](https://wiki.onap.org/).
14084 description: Unique ID of the vdc
14087 example: __VDC-ID__
14090 description: Name of the virtual data center
14095 - CloudInfrastructure
14096 summary: create or update an existing virtual-data-center
14098 Create or update an existing virtual-data-center.
14100 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14101 operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
14110 description: Response codes found in [response codes](https://wiki.onap.org/).
14114 description: Unique ID of the vdc
14117 example: __VDC-ID__
14120 description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
14123 $ref: "#/definitions/virtual-data-center"
14126 - CloudInfrastructure
14127 summary: update an existing virtual-data-center
14129 Update an existing virtual-data-center
14131 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14132 The PUT operation will entirely replace an existing object.
14133 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14135 Other differences between PUT and PATCH are:
14137 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14138 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14139 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14140 operationId: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
14149 description: Response codes found in [response codes](https://wiki.onap.org/).
14153 description: Unique ID of the vdc
14156 example: __VDC-ID__
14159 description: virtual-data-center object that needs to be created or updated.
14162 $ref: "#/patchDefinitions/virtual-data-center"
14165 - CloudInfrastructure
14166 summary: delete an existing virtual-data-center
14167 description: delete an existing virtual-data-center
14168 operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter
14177 description: Response codes found in [response codes](https://wiki.onap.org/).
14181 description: Unique ID of the vdc
14184 example: __VDC-ID__
14185 - name: resource-version
14187 description: resource-version for concurrency
14190 /cloud-infrastructure/virtual-data-centers:
14193 - CloudInfrastructure
14194 summary: returns virtual-data-centers
14195 description: returns virtual-data-centers
14196 operationId: getCloudInfrastructureVirtualDataCenters
14202 description: successful operation
14204 $ref: "#/getDefinitions/virtual-data-centers"
14206 description: Response codes found in [response codes](https://wiki.onap.org/).
14207 /business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
14211 summary: see node definition for valid relationships
14212 operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship
14221 description: Response codes found in [response codes](https://wiki.onap.org/).
14223 - name: resource-instance-id
14225 description: Unique id of resource instance.
14228 example: __RESOURCE-INSTANCE-ID__
14231 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessConnectorsConnector.json)
14234 $ref: "#/definitions/relationship"
14238 summary: delete an existing relationship
14239 description: delete an existing relationship
14240 operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship
14249 description: Response codes found in [response codes](https://wiki.onap.org/).
14251 - name: resource-instance-id
14253 description: Unique id of resource instance.
14256 example: __RESOURCE-INSTANCE-ID__
14257 /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
14261 summary: returns metadatum
14262 description: returns metadatum
14263 operationId: getBusinessConnectorsConnectorMetadataMetadatum
14269 description: successful operation
14271 $ref: "#/getDefinitions/metadatum"
14273 description: Response codes found in [response codes](https://wiki.onap.org/).
14275 - name: resource-instance-id
14277 description: Unique id of resource instance.
14280 example: __RESOURCE-INSTANCE-ID__
14285 example: __METANAME__
14286 - name: model-invariant-id
14288 description: the ASDC model id for this resource or service model.
14291 - name: model-version-id
14293 description: the ASDC model version for this resource or service model.
14296 - name: widget-model-id
14298 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14301 - name: widget-model-version
14303 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14309 summary: create or update an existing metadatum
14311 Create or update an existing metadatum.
14313 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14314 operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum
14323 description: Response codes found in [response codes](https://wiki.onap.org/).
14325 - name: resource-instance-id
14327 description: Unique id of resource instance.
14330 example: __RESOURCE-INSTANCE-ID__
14335 example: __METANAME__
14338 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessConnectorsConnectorMetadataMetadatum.json)
14341 $ref: "#/definitions/metadatum"
14345 summary: update an existing metadatum
14347 Update an existing metadatum
14349 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14350 The PUT operation will entirely replace an existing object.
14351 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14353 Other differences between PUT and PATCH are:
14355 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14356 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14357 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14358 operationId: UpdateBusinessConnectorsConnectorMetadataMetadatum
14367 description: Response codes found in [response codes](https://wiki.onap.org/).
14369 - name: resource-instance-id
14371 description: Unique id of resource instance.
14374 example: __RESOURCE-INSTANCE-ID__
14379 example: __METANAME__
14382 description: metadatum object that needs to be created or updated.
14385 $ref: "#/patchDefinitions/metadatum"
14389 summary: delete an existing metadatum
14390 description: delete an existing metadatum
14391 operationId: deleteBusinessConnectorsConnectorMetadataMetadatum
14400 description: Response codes found in [response codes](https://wiki.onap.org/).
14402 - name: resource-instance-id
14404 description: Unique id of resource instance.
14407 example: __RESOURCE-INSTANCE-ID__
14412 example: __METANAME__
14413 - name: resource-version
14415 description: resource-version for concurrency
14418 /business/connectors/connector/{resource-instance-id}/metadata:
14422 summary: returns metadata
14423 description: returns metadata
14424 operationId: getBusinessConnectorsConnectorMetadata
14430 description: successful operation
14432 $ref: "#/getDefinitions/metadata"
14434 description: Response codes found in [response codes](https://wiki.onap.org/).
14436 - name: resource-instance-id
14438 description: Unique id of resource instance.
14441 example: __RESOURCE-INSTANCE-ID__
14442 - name: model-invariant-id
14444 description: the ASDC model id for this resource or service model.
14447 - name: model-version-id
14449 description: the ASDC model version for this resource or service model.
14452 - name: widget-model-id
14454 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14457 - name: widget-model-version
14459 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14462 /business/connectors/connector/{resource-instance-id}:
14466 summary: returns connector
14467 description: returns connector
14468 operationId: getBusinessConnectorsConnector
14474 description: successful operation
14476 $ref: "#/getDefinitions/connector"
14478 description: Response codes found in [response codes](https://wiki.onap.org/).
14480 - name: resource-instance-id
14482 description: Unique id of resource instance.
14485 example: __RESOURCE-INSTANCE-ID__
14486 - name: model-invariant-id
14488 description: the ASDC model id for this resource or service model.
14491 - name: model-version-id
14493 description: the ASDC model version for this resource or service model.
14496 - name: widget-model-id
14498 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14501 - name: widget-model-version
14503 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14509 summary: create or update an existing connector
14511 Create or update an existing connector.
14513 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14514 operationId: createOrUpdateBusinessConnectorsConnector
14523 description: Response codes found in [response codes](https://wiki.onap.org/).
14525 - name: resource-instance-id
14527 description: Unique id of resource instance.
14530 example: __RESOURCE-INSTANCE-ID__
14533 description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessConnectorsConnector.json)
14536 $ref: "#/definitions/connector"
14540 summary: update an existing connector
14542 Update an existing connector
14544 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14545 The PUT operation will entirely replace an existing object.
14546 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14548 Other differences between PUT and PATCH are:
14550 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14551 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14552 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14553 operationId: UpdateBusinessConnectorsConnector
14562 description: Response codes found in [response codes](https://wiki.onap.org/).
14564 - name: resource-instance-id
14566 description: Unique id of resource instance.
14569 example: __RESOURCE-INSTANCE-ID__
14572 description: connector object that needs to be created or updated.
14575 $ref: "#/patchDefinitions/connector"
14579 summary: delete an existing connector
14580 description: delete an existing connector
14581 operationId: deleteBusinessConnectorsConnector
14590 description: Response codes found in [response codes](https://wiki.onap.org/).
14592 - name: resource-instance-id
14594 description: Unique id of resource instance.
14597 example: __RESOURCE-INSTANCE-ID__
14598 - name: resource-version
14600 description: resource-version for concurrency
14603 /business/connectors:
14607 summary: returns connectors
14608 description: returns connectors
14609 operationId: getBusinessConnectors
14615 description: successful operation
14617 $ref: "#/getDefinitions/connectors"
14619 description: Response codes found in [response codes](https://wiki.onap.org/).
14620 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
14624 summary: see node definition for valid relationships
14625 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
14634 description: Response codes found in [response codes](https://wiki.onap.org/).
14636 - name: global-customer-id
14638 description: Global customer id used across ECOMP to uniquely identify customer.
14641 example: __GLOBAL-CUSTOMER-ID__
14642 - name: service-type
14644 description: Value defined by orchestration to identify this service across ECOMP.
14647 example: __SERVICE-TYPE__
14648 - name: service-instance-id
14650 description: Uniquely identifies this instance of a service
14653 example: __SERVICE-INSTANCE-ID__
14656 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
14659 $ref: "#/definitions/relationship"
14663 summary: delete an existing relationship
14664 description: delete an existing relationship
14665 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
14674 description: Response codes found in [response codes](https://wiki.onap.org/).
14676 - name: global-customer-id
14678 description: Global customer id used across ECOMP to uniquely identify customer.
14681 example: __GLOBAL-CUSTOMER-ID__
14682 - name: service-type
14684 description: Value defined by orchestration to identify this service across ECOMP.
14687 example: __SERVICE-TYPE__
14688 - name: service-instance-id
14690 description: Uniquely identifies this instance of a service
14693 example: __SERVICE-INSTANCE-ID__
14694 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
14698 summary: returns metadatum
14699 description: returns metadatum
14700 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
14706 description: successful operation
14708 $ref: "#/getDefinitions/metadatum"
14710 description: Response codes found in [response codes](https://wiki.onap.org/).
14712 - name: global-customer-id
14714 description: Global customer id used across ECOMP to uniquely identify customer.
14717 example: __GLOBAL-CUSTOMER-ID__
14718 - name: service-type
14720 description: Value defined by orchestration to identify this service across ECOMP.
14723 example: __SERVICE-TYPE__
14724 - name: service-instance-id
14726 description: Uniquely identifies this instance of a service
14729 example: __SERVICE-INSTANCE-ID__
14734 example: __METANAME__
14735 - name: subscriber-name
14737 description: Subscriber name, an alternate way to retrieve a customer.
14740 - name: subscriber-type
14742 description: Subscriber type, a way to provide VID with only the INFRA customers.
14745 - name: service-instance-name
14747 description: This field will store a name assigned to the service-instance.
14750 - name: model-invariant-id
14752 description: the ASDC model id for this resource or service model.
14755 - name: model-version-id
14757 description: the ASDC model version for this resource or service model.
14760 - name: widget-model-id
14762 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14765 - name: widget-model-version
14767 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14770 - name: service-instance-location-id
14772 description: An identifier that customers assign to the location where this service is being used.
14775 - name: orchestration-status
14777 description: Orchestration status of this service.
14783 summary: create or update an existing metadatum
14785 Create or update an existing metadatum.
14787 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14788 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
14797 description: Response codes found in [response codes](https://wiki.onap.org/).
14799 - name: global-customer-id
14801 description: Global customer id used across ECOMP to uniquely identify customer.
14804 example: __GLOBAL-CUSTOMER-ID__
14805 - name: service-type
14807 description: Value defined by orchestration to identify this service across ECOMP.
14810 example: __SERVICE-TYPE__
14811 - name: service-instance-id
14813 description: Uniquely identifies this instance of a service
14816 example: __SERVICE-INSTANCE-ID__
14821 example: __METANAME__
14824 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)
14827 $ref: "#/definitions/metadatum"
14831 summary: update an existing metadatum
14833 Update an existing metadatum
14835 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14836 The PUT operation will entirely replace an existing object.
14837 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14839 Other differences between PUT and PATCH are:
14841 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14842 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14843 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14844 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
14853 description: Response codes found in [response codes](https://wiki.onap.org/).
14855 - name: global-customer-id
14857 description: Global customer id used across ECOMP to uniquely identify customer.
14860 example: __GLOBAL-CUSTOMER-ID__
14861 - name: service-type
14863 description: Value defined by orchestration to identify this service across ECOMP.
14866 example: __SERVICE-TYPE__
14867 - name: service-instance-id
14869 description: Uniquely identifies this instance of a service
14872 example: __SERVICE-INSTANCE-ID__
14877 example: __METANAME__
14880 description: metadatum object that needs to be created or updated.
14883 $ref: "#/patchDefinitions/metadatum"
14887 summary: delete an existing metadatum
14888 description: delete an existing metadatum
14889 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
14898 description: Response codes found in [response codes](https://wiki.onap.org/).
14900 - name: global-customer-id
14902 description: Global customer id used across ECOMP to uniquely identify customer.
14905 example: __GLOBAL-CUSTOMER-ID__
14906 - name: service-type
14908 description: Value defined by orchestration to identify this service across ECOMP.
14911 example: __SERVICE-TYPE__
14912 - name: service-instance-id
14914 description: Uniquely identifies this instance of a service
14917 example: __SERVICE-INSTANCE-ID__
14922 example: __METANAME__
14923 - name: resource-version
14925 description: resource-version for concurrency
14928 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
14932 summary: returns metadata
14933 description: returns metadata
14934 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
14940 description: successful operation
14942 $ref: "#/getDefinitions/metadata"
14944 description: Response codes found in [response codes](https://wiki.onap.org/).
14946 - name: global-customer-id
14948 description: Global customer id used across ECOMP to uniquely identify customer.
14951 example: __GLOBAL-CUSTOMER-ID__
14952 - name: service-type
14954 description: Value defined by orchestration to identify this service across ECOMP.
14957 example: __SERVICE-TYPE__
14958 - name: service-instance-id
14960 description: Uniquely identifies this instance of a service
14963 example: __SERVICE-INSTANCE-ID__
14964 - name: subscriber-name
14966 description: Subscriber name, an alternate way to retrieve a customer.
14969 - name: subscriber-type
14971 description: Subscriber type, a way to provide VID with only the INFRA customers.
14974 - name: service-instance-name
14976 description: This field will store a name assigned to the service-instance.
14979 - name: model-invariant-id
14981 description: the ASDC model id for this resource or service model.
14984 - name: model-version-id
14986 description: the ASDC model version for this resource or service model.
14989 - name: widget-model-id
14991 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14994 - name: widget-model-version
14996 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14999 - name: service-instance-location-id
15001 description: An identifier that customers assign to the location where this service is being used.
15004 - name: orchestration-status
15006 description: Orchestration status of this service.
15009 /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:
15013 summary: see node definition for valid relationships
15014 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
15023 description: Response codes found in [response codes](https://wiki.onap.org/).
15025 - name: global-customer-id
15027 description: Global customer id used across ECOMP to uniquely identify customer.
15030 example: __GLOBAL-CUSTOMER-ID__
15031 - name: service-type
15033 description: Value defined by orchestration to identify this service across ECOMP.
15036 example: __SERVICE-TYPE__
15037 - name: service-instance-id
15039 description: Uniquely identifies this instance of a service
15042 example: __SERVICE-INSTANCE-ID__
15045 description: Allotted Resource id UUID assigned to this instance.
15051 description: Allotted Resource id UUID assigned to this instance.
15057 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
15060 $ref: "#/definitions/relationship"
15064 summary: delete an existing relationship
15065 description: delete an existing relationship
15066 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
15075 description: Response codes found in [response codes](https://wiki.onap.org/).
15077 - name: global-customer-id
15079 description: Global customer id used across ECOMP to uniquely identify customer.
15082 example: __GLOBAL-CUSTOMER-ID__
15083 - name: service-type
15085 description: Value defined by orchestration to identify this service across ECOMP.
15088 example: __SERVICE-TYPE__
15089 - name: service-instance-id
15091 description: Uniquely identifies this instance of a service
15094 example: __SERVICE-INSTANCE-ID__
15097 description: Allotted Resource id UUID assigned to this instance.
15103 description: Allotted Resource id UUID assigned to this instance.
15107 /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}:
15111 summary: returns tunnel-xconnect
15112 description: returns tunnel-xconnect
15113 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15119 description: successful operation
15121 $ref: "#/getDefinitions/tunnel-xconnect"
15123 description: Response codes found in [response codes](https://wiki.onap.org/).
15125 - name: global-customer-id
15127 description: Global customer id used across ECOMP to uniquely identify customer.
15130 example: __GLOBAL-CUSTOMER-ID__
15131 - name: service-type
15133 description: Value defined by orchestration to identify this service across ECOMP.
15136 example: __SERVICE-TYPE__
15137 - name: service-instance-id
15139 description: Uniquely identifies this instance of a service
15142 example: __SERVICE-INSTANCE-ID__
15145 description: Allotted Resource id UUID assigned to this instance.
15151 description: Allotted Resource id UUID assigned to this instance.
15155 - name: subscriber-name
15157 description: Subscriber name, an alternate way to retrieve a customer.
15160 - name: subscriber-type
15162 description: Subscriber type, a way to provide VID with only the INFRA customers.
15165 - name: service-instance-name
15167 description: This field will store a name assigned to the service-instance.
15170 - name: model-invariant-id
15172 description: the ASDC model id for this resource or service model.
15175 - name: model-version-id
15177 description: the ASDC model version for this resource or service model.
15180 - name: widget-model-id
15182 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15185 - name: widget-model-version
15187 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15190 - name: service-instance-location-id
15192 description: An identifier that customers assign to the location where this service is being used.
15195 - name: orchestration-status
15197 description: Orchestration status of this service.
15200 - name: model-invariant-id
15202 description: the ASDC model id for this resource or service model.
15205 - name: model-version-id
15207 description: the ASDC model version for this resource or service model.
15212 description: Generic description of the type of allotted resource.
15217 description: role in the network that this resource will be providing.
15223 summary: create or update an existing tunnel-xconnect
15225 Create or update an existing tunnel-xconnect.
15227 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15228 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15237 description: Response codes found in [response codes](https://wiki.onap.org/).
15239 - name: global-customer-id
15241 description: Global customer id used across ECOMP to uniquely identify customer.
15244 example: __GLOBAL-CUSTOMER-ID__
15245 - name: service-type
15247 description: Value defined by orchestration to identify this service across ECOMP.
15250 example: __SERVICE-TYPE__
15251 - name: service-instance-id
15253 description: Uniquely identifies this instance of a service
15256 example: __SERVICE-INSTANCE-ID__
15259 description: Allotted Resource id UUID assigned to this instance.
15265 description: Allotted Resource id UUID assigned to this instance.
15271 description: tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
15274 $ref: "#/definitions/tunnel-xconnect"
15278 summary: update an existing tunnel-xconnect
15280 Update an existing tunnel-xconnect
15282 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15283 The PUT operation will entirely replace an existing object.
15284 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15286 Other differences between PUT and PATCH are:
15288 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15289 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15290 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15291 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15300 description: Response codes found in [response codes](https://wiki.onap.org/).
15302 - name: global-customer-id
15304 description: Global customer id used across ECOMP to uniquely identify customer.
15307 example: __GLOBAL-CUSTOMER-ID__
15308 - name: service-type
15310 description: Value defined by orchestration to identify this service across ECOMP.
15313 example: __SERVICE-TYPE__
15314 - name: service-instance-id
15316 description: Uniquely identifies this instance of a service
15319 example: __SERVICE-INSTANCE-ID__
15322 description: Allotted Resource id UUID assigned to this instance.
15328 description: Allotted Resource id UUID assigned to this instance.
15334 description: tunnel-xconnect object that needs to be created or updated.
15337 $ref: "#/patchDefinitions/tunnel-xconnect"
15341 summary: delete an existing tunnel-xconnect
15342 description: delete an existing tunnel-xconnect
15343 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15352 description: Response codes found in [response codes](https://wiki.onap.org/).
15354 - name: global-customer-id
15356 description: Global customer id used across ECOMP to uniquely identify customer.
15359 example: __GLOBAL-CUSTOMER-ID__
15360 - name: service-type
15362 description: Value defined by orchestration to identify this service across ECOMP.
15365 example: __SERVICE-TYPE__
15366 - name: service-instance-id
15368 description: Uniquely identifies this instance of a service
15371 example: __SERVICE-INSTANCE-ID__
15374 description: Allotted Resource id UUID assigned to this instance.
15380 description: Allotted Resource id UUID assigned to this instance.
15384 - name: resource-version
15386 description: resource-version for concurrency
15389 /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:
15393 summary: returns tunnel-xconnects
15394 description: returns tunnel-xconnects
15395 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects
15401 description: successful operation
15403 $ref: "#/getDefinitions/tunnel-xconnects"
15405 description: Response codes found in [response codes](https://wiki.onap.org/).
15407 - name: global-customer-id
15409 description: Global customer id used across ECOMP to uniquely identify customer.
15412 example: __GLOBAL-CUSTOMER-ID__
15413 - name: service-type
15415 description: Value defined by orchestration to identify this service across ECOMP.
15418 example: __SERVICE-TYPE__
15419 - name: service-instance-id
15421 description: Uniquely identifies this instance of a service
15424 example: __SERVICE-INSTANCE-ID__
15427 description: Allotted Resource id UUID assigned to this instance.
15431 - name: subscriber-name
15433 description: Subscriber name, an alternate way to retrieve a customer.
15436 - name: subscriber-type
15438 description: Subscriber type, a way to provide VID with only the INFRA customers.
15441 - name: service-instance-name
15443 description: This field will store a name assigned to the service-instance.
15446 - name: model-invariant-id
15448 description: the ASDC model id for this resource or service model.
15451 - name: model-version-id
15453 description: the ASDC model version for this resource or service model.
15456 - name: widget-model-id
15458 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15461 - name: widget-model-version
15463 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15466 - name: service-instance-location-id
15468 description: An identifier that customers assign to the location where this service is being used.
15471 - name: orchestration-status
15473 description: Orchestration status of this service.
15476 - name: model-invariant-id
15478 description: the ASDC model id for this resource or service model.
15481 - name: model-version-id
15483 description: the ASDC model version for this resource or service model.
15488 description: Generic description of the type of allotted resource.
15493 description: role in the network that this resource will be providing.
15496 /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:
15500 summary: see node definition for valid relationships
15501 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
15510 description: Response codes found in [response codes](https://wiki.onap.org/).
15512 - name: global-customer-id
15514 description: Global customer id used across ECOMP to uniquely identify customer.
15517 example: __GLOBAL-CUSTOMER-ID__
15518 - name: service-type
15520 description: Value defined by orchestration to identify this service across ECOMP.
15523 example: __SERVICE-TYPE__
15524 - name: service-instance-id
15526 description: Uniquely identifies this instance of a service
15529 example: __SERVICE-INSTANCE-ID__
15532 description: Allotted Resource id UUID assigned to this instance.
15538 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
15541 $ref: "#/definitions/relationship"
15545 summary: delete an existing relationship
15546 description: delete an existing relationship
15547 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
15556 description: Response codes found in [response codes](https://wiki.onap.org/).
15558 - name: global-customer-id
15560 description: Global customer id used across ECOMP to uniquely identify customer.
15563 example: __GLOBAL-CUSTOMER-ID__
15564 - name: service-type
15566 description: Value defined by orchestration to identify this service across ECOMP.
15569 example: __SERVICE-TYPE__
15570 - name: service-instance-id
15572 description: Uniquely identifies this instance of a service
15575 example: __SERVICE-INSTANCE-ID__
15578 description: Allotted Resource id UUID assigned to this instance.
15582 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}:
15586 summary: returns allotted-resource
15587 description: returns allotted-resource
15588 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
15594 description: successful operation
15596 $ref: "#/getDefinitions/allotted-resource"
15598 description: Response codes found in [response codes](https://wiki.onap.org/).
15600 - name: global-customer-id
15602 description: Global customer id used across ECOMP to uniquely identify customer.
15605 example: __GLOBAL-CUSTOMER-ID__
15606 - name: service-type
15608 description: Value defined by orchestration to identify this service across ECOMP.
15611 example: __SERVICE-TYPE__
15612 - name: service-instance-id
15614 description: Uniquely identifies this instance of a service
15617 example: __SERVICE-INSTANCE-ID__
15620 description: Allotted Resource id UUID assigned to this instance.
15624 - name: subscriber-name
15626 description: Subscriber name, an alternate way to retrieve a customer.
15629 - name: subscriber-type
15631 description: Subscriber type, a way to provide VID with only the INFRA customers.
15634 - name: service-instance-name
15636 description: This field will store a name assigned to the service-instance.
15639 - name: model-invariant-id
15641 description: the ASDC model id for this resource or service model.
15644 - name: model-version-id
15646 description: the ASDC model version for this resource or service model.
15649 - name: widget-model-id
15651 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15654 - name: widget-model-version
15656 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15659 - name: service-instance-location-id
15661 description: An identifier that customers assign to the location where this service is being used.
15664 - name: orchestration-status
15666 description: Orchestration status of this service.
15669 - name: model-invariant-id
15671 description: the ASDC model id for this resource or service model.
15674 - name: model-version-id
15676 description: the ASDC model version for this resource or service model.
15681 description: Generic description of the type of allotted resource.
15686 description: role in the network that this resource will be providing.
15692 summary: create or update an existing allotted-resource
15694 Create or update an existing allotted-resource.
15696 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15697 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
15706 description: Response codes found in [response codes](https://wiki.onap.org/).
15708 - name: global-customer-id
15710 description: Global customer id used across ECOMP to uniquely identify customer.
15713 example: __GLOBAL-CUSTOMER-ID__
15714 - name: service-type
15716 description: Value defined by orchestration to identify this service across ECOMP.
15719 example: __SERVICE-TYPE__
15720 - name: service-instance-id
15722 description: Uniquely identifies this instance of a service
15725 example: __SERVICE-INSTANCE-ID__
15728 description: Allotted Resource id UUID assigned to this instance.
15734 description: allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
15737 $ref: "#/definitions/allotted-resource"
15741 summary: update an existing allotted-resource
15743 Update an existing allotted-resource
15745 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15746 The PUT operation will entirely replace an existing object.
15747 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15749 Other differences between PUT and PATCH are:
15751 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15752 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15753 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15754 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
15763 description: Response codes found in [response codes](https://wiki.onap.org/).
15765 - name: global-customer-id
15767 description: Global customer id used across ECOMP to uniquely identify customer.
15770 example: __GLOBAL-CUSTOMER-ID__
15771 - name: service-type
15773 description: Value defined by orchestration to identify this service across ECOMP.
15776 example: __SERVICE-TYPE__
15777 - name: service-instance-id
15779 description: Uniquely identifies this instance of a service
15782 example: __SERVICE-INSTANCE-ID__
15785 description: Allotted Resource id UUID assigned to this instance.
15791 description: allotted-resource object that needs to be created or updated.
15794 $ref: "#/patchDefinitions/allotted-resource"
15798 summary: delete an existing allotted-resource
15799 description: delete an existing allotted-resource
15800 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
15809 description: Response codes found in [response codes](https://wiki.onap.org/).
15811 - name: global-customer-id
15813 description: Global customer id used across ECOMP to uniquely identify customer.
15816 example: __GLOBAL-CUSTOMER-ID__
15817 - name: service-type
15819 description: Value defined by orchestration to identify this service across ECOMP.
15822 example: __SERVICE-TYPE__
15823 - name: service-instance-id
15825 description: Uniquely identifies this instance of a service
15828 example: __SERVICE-INSTANCE-ID__
15831 description: Allotted Resource id UUID assigned to this instance.
15835 - name: resource-version
15837 description: resource-version for concurrency
15840 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources:
15844 summary: returns allotted-resources
15845 description: returns allotted-resources
15846 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources
15852 description: successful operation
15854 $ref: "#/getDefinitions/allotted-resources"
15856 description: Response codes found in [response codes](https://wiki.onap.org/).
15858 - name: global-customer-id
15860 description: Global customer id used across ECOMP to uniquely identify customer.
15863 example: __GLOBAL-CUSTOMER-ID__
15864 - name: service-type
15866 description: Value defined by orchestration to identify this service across ECOMP.
15869 example: __SERVICE-TYPE__
15870 - name: service-instance-id
15872 description: Uniquely identifies this instance of a service
15875 example: __SERVICE-INSTANCE-ID__
15876 - name: subscriber-name
15878 description: Subscriber name, an alternate way to retrieve a customer.
15881 - name: subscriber-type
15883 description: Subscriber type, a way to provide VID with only the INFRA customers.
15886 - name: service-instance-name
15888 description: This field will store a name assigned to the service-instance.
15891 - name: model-invariant-id
15893 description: the ASDC model id for this resource or service model.
15896 - name: model-version-id
15898 description: the ASDC model version for this resource or service model.
15901 - name: widget-model-id
15903 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15906 - name: widget-model-version
15908 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15911 - name: service-instance-location-id
15913 description: An identifier that customers assign to the location where this service is being used.
15916 - name: orchestration-status
15918 description: Orchestration status of this service.
15921 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
15925 summary: returns service-instance
15926 description: returns service-instance
15927 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
15933 description: successful operation
15935 $ref: "#/getDefinitions/service-instance"
15937 description: Response codes found in [response codes](https://wiki.onap.org/).
15939 - name: global-customer-id
15941 description: Global customer id used across ECOMP to uniquely identify customer.
15944 example: __GLOBAL-CUSTOMER-ID__
15945 - name: service-type
15947 description: Value defined by orchestration to identify this service across ECOMP.
15950 example: __SERVICE-TYPE__
15951 - name: service-instance-id
15953 description: Uniquely identifies this instance of a service
15956 example: __SERVICE-INSTANCE-ID__
15957 - name: subscriber-name
15959 description: Subscriber name, an alternate way to retrieve a customer.
15962 - name: subscriber-type
15964 description: Subscriber type, a way to provide VID with only the INFRA customers.
15967 - name: service-instance-name
15969 description: This field will store a name assigned to the service-instance.
15972 - name: model-invariant-id
15974 description: the ASDC model id for this resource or service model.
15977 - name: model-version-id
15979 description: the ASDC model version for this resource or service model.
15982 - name: widget-model-id
15984 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15987 - name: widget-model-version
15989 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15992 - name: service-instance-location-id
15994 description: An identifier that customers assign to the location where this service is being used.
15997 - name: orchestration-status
15999 description: Orchestration status of this service.
16005 summary: create or update an existing service-instance
16007 Create or update an existing service-instance.
16009 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16010 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
16019 description: Response codes found in [response codes](https://wiki.onap.org/).
16021 - name: global-customer-id
16023 description: Global customer id used across ECOMP to uniquely identify customer.
16026 example: __GLOBAL-CUSTOMER-ID__
16027 - name: service-type
16029 description: Value defined by orchestration to identify this service across ECOMP.
16032 example: __SERVICE-TYPE__
16033 - name: service-instance-id
16035 description: Uniquely identifies this instance of a service
16038 example: __SERVICE-INSTANCE-ID__
16041 description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
16044 $ref: "#/definitions/service-instance"
16048 summary: update an existing service-instance
16050 Update an existing service-instance
16052 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16053 The PUT operation will entirely replace an existing object.
16054 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16056 Other differences between PUT and PATCH are:
16058 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16059 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16060 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16061 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
16070 description: Response codes found in [response codes](https://wiki.onap.org/).
16072 - name: global-customer-id
16074 description: Global customer id used across ECOMP to uniquely identify customer.
16077 example: __GLOBAL-CUSTOMER-ID__
16078 - name: service-type
16080 description: Value defined by orchestration to identify this service across ECOMP.
16083 example: __SERVICE-TYPE__
16084 - name: service-instance-id
16086 description: Uniquely identifies this instance of a service
16089 example: __SERVICE-INSTANCE-ID__
16092 description: service-instance object that needs to be created or updated.
16095 $ref: "#/patchDefinitions/service-instance"
16099 summary: delete an existing service-instance
16100 description: delete an existing service-instance
16101 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
16110 description: Response codes found in [response codes](https://wiki.onap.org/).
16112 - name: global-customer-id
16114 description: Global customer id used across ECOMP to uniquely identify customer.
16117 example: __GLOBAL-CUSTOMER-ID__
16118 - name: service-type
16120 description: Value defined by orchestration to identify this service across ECOMP.
16123 example: __SERVICE-TYPE__
16124 - name: service-instance-id
16126 description: Uniquely identifies this instance of a service
16129 example: __SERVICE-INSTANCE-ID__
16130 - name: resource-version
16132 description: resource-version for concurrency
16135 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances:
16139 summary: returns service-instances
16140 description: returns service-instances
16141 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances
16147 description: successful operation
16149 $ref: "#/getDefinitions/service-instances"
16151 description: Response codes found in [response codes](https://wiki.onap.org/).
16153 - name: global-customer-id
16155 description: Global customer id used across ECOMP to uniquely identify customer.
16158 example: __GLOBAL-CUSTOMER-ID__
16159 - name: service-type
16161 description: Value defined by orchestration to identify this service across ECOMP.
16164 example: __SERVICE-TYPE__
16165 - name: subscriber-name
16167 description: Subscriber name, an alternate way to retrieve a customer.
16170 - name: subscriber-type
16172 description: Subscriber type, a way to provide VID with only the INFRA customers.
16175 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship:
16179 summary: see node definition for valid relationships
16180 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
16189 description: Response codes found in [response codes](https://wiki.onap.org/).
16191 - name: global-customer-id
16193 description: Global customer id used across ECOMP to uniquely identify customer.
16196 example: __GLOBAL-CUSTOMER-ID__
16197 - name: service-type
16199 description: Value defined by orchestration to identify this service across ECOMP.
16202 example: __SERVICE-TYPE__
16205 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
16208 $ref: "#/definitions/relationship"
16212 summary: delete an existing relationship
16213 description: delete an existing relationship
16214 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
16223 description: Response codes found in [response codes](https://wiki.onap.org/).
16225 - name: global-customer-id
16227 description: Global customer id used across ECOMP to uniquely identify customer.
16230 example: __GLOBAL-CUSTOMER-ID__
16231 - name: service-type
16233 description: Value defined by orchestration to identify this service across ECOMP.
16236 example: __SERVICE-TYPE__
16237 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}:
16241 summary: returns service-subscription
16242 description: returns service-subscription
16243 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16249 description: successful operation
16251 $ref: "#/getDefinitions/service-subscription"
16253 description: Response codes found in [response codes](https://wiki.onap.org/).
16255 - name: global-customer-id
16257 description: Global customer id used across ECOMP to uniquely identify customer.
16260 example: __GLOBAL-CUSTOMER-ID__
16261 - name: service-type
16263 description: Value defined by orchestration to identify this service across ECOMP.
16266 example: __SERVICE-TYPE__
16267 - name: subscriber-name
16269 description: Subscriber name, an alternate way to retrieve a customer.
16272 - name: subscriber-type
16274 description: Subscriber type, a way to provide VID with only the INFRA customers.
16280 summary: create or update an existing service-subscription
16282 Create or update an existing service-subscription.
16284 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16285 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16294 description: Response codes found in [response codes](https://wiki.onap.org/).
16296 - name: global-customer-id
16298 description: Global customer id used across ECOMP to uniquely identify customer.
16301 example: __GLOBAL-CUSTOMER-ID__
16302 - name: service-type
16304 description: Value defined by orchestration to identify this service across ECOMP.
16307 example: __SERVICE-TYPE__
16310 description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
16313 $ref: "#/definitions/service-subscription"
16317 summary: update an existing service-subscription
16319 Update an existing service-subscription
16321 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16322 The PUT operation will entirely replace an existing object.
16323 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16325 Other differences between PUT and PATCH are:
16327 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16328 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16329 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16330 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16339 description: Response codes found in [response codes](https://wiki.onap.org/).
16341 - name: global-customer-id
16343 description: Global customer id used across ECOMP to uniquely identify customer.
16346 example: __GLOBAL-CUSTOMER-ID__
16347 - name: service-type
16349 description: Value defined by orchestration to identify this service across ECOMP.
16352 example: __SERVICE-TYPE__
16355 description: service-subscription object that needs to be created or updated.
16358 $ref: "#/patchDefinitions/service-subscription"
16362 summary: delete an existing service-subscription
16363 description: delete an existing service-subscription
16364 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16373 description: Response codes found in [response codes](https://wiki.onap.org/).
16375 - name: global-customer-id
16377 description: Global customer id used across ECOMP to uniquely identify customer.
16380 example: __GLOBAL-CUSTOMER-ID__
16381 - name: service-type
16383 description: Value defined by orchestration to identify this service across ECOMP.
16386 example: __SERVICE-TYPE__
16387 - name: resource-version
16389 description: resource-version for concurrency
16392 /business/customers/customer/{global-customer-id}/service-subscriptions:
16396 summary: returns service-subscriptions
16397 description: returns service-subscriptions
16398 operationId: getBusinessCustomersCustomerServiceSubscriptions
16404 description: successful operation
16406 $ref: "#/getDefinitions/service-subscriptions"
16408 description: Response codes found in [response codes](https://wiki.onap.org/).
16410 - name: global-customer-id
16412 description: Global customer id used across ECOMP to uniquely identify customer.
16415 example: __GLOBAL-CUSTOMER-ID__
16416 - name: subscriber-name
16418 description: Subscriber name, an alternate way to retrieve a customer.
16421 - name: subscriber-type
16423 description: Subscriber type, a way to provide VID with only the INFRA customers.
16426 /business/customers/customer/{global-customer-id}/relationship-list/relationship:
16430 summary: see node definition for valid relationships
16431 operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship
16440 description: Response codes found in [response codes](https://wiki.onap.org/).
16442 - name: global-customer-id
16444 description: Global customer id used across ECOMP to uniquely identify customer.
16447 example: __GLOBAL-CUSTOMER-ID__
16450 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomer.json)
16453 $ref: "#/definitions/relationship"
16457 summary: delete an existing relationship
16458 description: delete an existing relationship
16459 operationId: deleteBusinessCustomersCustomerRelationshipListRelationship
16468 description: Response codes found in [response codes](https://wiki.onap.org/).
16470 - name: global-customer-id
16472 description: Global customer id used across ECOMP to uniquely identify customer.
16475 example: __GLOBAL-CUSTOMER-ID__
16476 /business/customers/customer/{global-customer-id}:
16480 summary: returns customer
16481 description: returns customer
16482 operationId: getBusinessCustomersCustomer
16488 description: successful operation
16490 $ref: "#/getDefinitions/customer"
16492 description: Response codes found in [response codes](https://wiki.onap.org/).
16494 - name: global-customer-id
16496 description: Global customer id used across ECOMP to uniquely identify customer.
16499 example: __GLOBAL-CUSTOMER-ID__
16500 - name: subscriber-name
16502 description: Subscriber name, an alternate way to retrieve a customer.
16505 - name: subscriber-type
16507 description: Subscriber type, a way to provide VID with only the INFRA customers.
16513 summary: create or update an existing customer
16515 Create or update an existing customer.
16517 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16518 operationId: createOrUpdateBusinessCustomersCustomer
16527 description: Response codes found in [response codes](https://wiki.onap.org/).
16529 - name: global-customer-id
16531 description: Global customer id used across ECOMP to uniquely identify customer.
16534 example: __GLOBAL-CUSTOMER-ID__
16537 description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomer.json)
16540 $ref: "#/definitions/customer"
16544 summary: update an existing customer
16546 Update an existing customer
16548 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16549 The PUT operation will entirely replace an existing object.
16550 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16552 Other differences between PUT and PATCH are:
16554 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16555 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16556 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16557 operationId: UpdateBusinessCustomersCustomer
16566 description: Response codes found in [response codes](https://wiki.onap.org/).
16568 - name: global-customer-id
16570 description: Global customer id used across ECOMP to uniquely identify customer.
16573 example: __GLOBAL-CUSTOMER-ID__
16576 description: customer object that needs to be created or updated.
16579 $ref: "#/patchDefinitions/customer"
16583 summary: delete an existing customer
16584 description: delete an existing customer
16585 operationId: deleteBusinessCustomersCustomer
16594 description: Response codes found in [response codes](https://wiki.onap.org/).
16596 - name: global-customer-id
16598 description: Global customer id used across ECOMP to uniquely identify customer.
16601 example: __GLOBAL-CUSTOMER-ID__
16602 - name: resource-version
16604 description: resource-version for concurrency
16607 /business/customers:
16611 summary: returns customers
16612 description: returns customers
16613 operationId: getBusinessCustomers
16619 description: successful operation
16621 $ref: "#/getDefinitions/customers"
16623 description: Response codes found in [response codes](https://wiki.onap.org/).
16624 /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
16627 - ServiceDesignAndCreation
16628 summary: see node definition for valid relationships
16629 operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
16638 description: Response codes found in [response codes](https://wiki.onap.org/).
16640 - name: vnf-image-uuid
16642 description: Unique ID of this asset
16645 example: __VNF-IMAGE-UUID__
16648 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationVnfImagesVnfImage.json)
16651 $ref: "#/definitions/relationship"
16654 - ServiceDesignAndCreation
16655 summary: delete an existing relationship
16656 description: delete an existing relationship
16657 operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
16666 description: Response codes found in [response codes](https://wiki.onap.org/).
16668 - name: vnf-image-uuid
16670 description: Unique ID of this asset
16673 example: __VNF-IMAGE-UUID__
16674 /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}:
16677 - ServiceDesignAndCreation
16678 summary: returns vnf-image
16679 description: returns vnf-image
16680 operationId: getServiceDesignAndCreationVnfImagesVnfImage
16686 description: successful operation
16688 $ref: "#/getDefinitions/vnf-image"
16690 description: Response codes found in [response codes](https://wiki.onap.org/).
16692 - name: vnf-image-uuid
16694 description: Unique ID of this asset
16697 example: __VNF-IMAGE-UUID__
16698 - name: application
16700 description: The application that the image instantiates.
16703 - name: application-vendor
16705 description: The vendor of the application.
16708 - name: application-version
16710 description: The version of the application.
16715 - ServiceDesignAndCreation
16716 summary: create or update an existing vnf-image
16718 Create or update an existing vnf-image.
16720 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16721 operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage
16730 description: Response codes found in [response codes](https://wiki.onap.org/).
16732 - name: vnf-image-uuid
16734 description: Unique ID of this asset
16737 example: __VNF-IMAGE-UUID__
16740 description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationVnfImagesVnfImage.json)
16743 $ref: "#/definitions/vnf-image"
16746 - ServiceDesignAndCreation
16747 summary: update an existing vnf-image
16749 Update an existing vnf-image
16751 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16752 The PUT operation will entirely replace an existing object.
16753 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16755 Other differences between PUT and PATCH are:
16757 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16758 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16759 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16760 operationId: UpdateServiceDesignAndCreationVnfImagesVnfImage
16769 description: Response codes found in [response codes](https://wiki.onap.org/).
16771 - name: vnf-image-uuid
16773 description: Unique ID of this asset
16776 example: __VNF-IMAGE-UUID__
16779 description: vnf-image object that needs to be created or updated.
16782 $ref: "#/patchDefinitions/vnf-image"
16785 - ServiceDesignAndCreation
16786 summary: delete an existing vnf-image
16787 description: delete an existing vnf-image
16788 operationId: deleteServiceDesignAndCreationVnfImagesVnfImage
16797 description: Response codes found in [response codes](https://wiki.onap.org/).
16799 - name: vnf-image-uuid
16801 description: Unique ID of this asset
16804 example: __VNF-IMAGE-UUID__
16805 - name: resource-version
16807 description: resource-version for concurrency
16810 /service-design-and-creation/vnf-images:
16813 - ServiceDesignAndCreation
16814 summary: returns vnf-images
16815 description: returns vnf-images
16816 operationId: getServiceDesignAndCreationVnfImages
16822 description: successful operation
16824 $ref: "#/getDefinitions/vnf-images"
16826 description: Response codes found in [response codes](https://wiki.onap.org/).
16827 /service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
16830 - ServiceDesignAndCreation
16831 summary: see node definition for valid relationships
16832 operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship
16841 description: Response codes found in [response codes](https://wiki.onap.org/).
16845 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16848 example: __SERVICE-ID__
16851 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationServicesService.json)
16854 $ref: "#/definitions/relationship"
16857 - ServiceDesignAndCreation
16858 summary: delete an existing relationship
16859 description: delete an existing relationship
16860 operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship
16869 description: Response codes found in [response codes](https://wiki.onap.org/).
16873 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16876 example: __SERVICE-ID__
16877 /service-design-and-creation/services/service/{service-id}:
16880 - ServiceDesignAndCreation
16881 summary: returns service
16882 description: returns service
16883 operationId: getServiceDesignAndCreationServicesService
16889 description: successful operation
16891 $ref: "#/getDefinitions/service"
16893 description: Response codes found in [response codes](https://wiki.onap.org/).
16897 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16900 example: __SERVICE-ID__
16901 - name: service-description
16903 description: Description of the service
16908 - ServiceDesignAndCreation
16909 summary: create or update an existing service
16911 Create or update an existing service.
16913 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16914 operationId: createOrUpdateServiceDesignAndCreationServicesService
16923 description: Response codes found in [response codes](https://wiki.onap.org/).
16927 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16930 example: __SERVICE-ID__
16933 description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationServicesService.json)
16936 $ref: "#/definitions/service"
16939 - ServiceDesignAndCreation
16940 summary: update an existing service
16942 Update an existing service
16944 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16945 The PUT operation will entirely replace an existing object.
16946 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16948 Other differences between PUT and PATCH are:
16950 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16951 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16952 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16953 operationId: UpdateServiceDesignAndCreationServicesService
16962 description: Response codes found in [response codes](https://wiki.onap.org/).
16966 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16969 example: __SERVICE-ID__
16972 description: service object that needs to be created or updated.
16975 $ref: "#/patchDefinitions/service"
16978 - ServiceDesignAndCreation
16979 summary: delete an existing service
16980 description: delete an existing service
16981 operationId: deleteServiceDesignAndCreationServicesService
16990 description: Response codes found in [response codes](https://wiki.onap.org/).
16994 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16997 example: __SERVICE-ID__
16998 - name: resource-version
17000 description: resource-version for concurrency
17003 /service-design-and-creation/services:
17006 - ServiceDesignAndCreation
17007 summary: returns services
17008 description: returns services
17009 operationId: getServiceDesignAndCreationServices
17015 description: successful operation
17017 $ref: "#/getDefinitions/services"
17019 description: Response codes found in [response codes](https://wiki.onap.org/).
17020 /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
17023 - ServiceDesignAndCreation
17024 summary: see node definition for valid relationships
17025 operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
17034 description: Response codes found in [response codes](https://wiki.onap.org/).
17036 - name: service-type
17038 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17041 example: __SERVICE-TYPE__
17044 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.
17047 example: __VNF-TYPE__
17050 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
17053 $ref: "#/definitions/relationship"
17056 - ServiceDesignAndCreation
17057 summary: delete an existing relationship
17058 description: delete an existing relationship
17059 operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
17068 description: Response codes found in [response codes](https://wiki.onap.org/).
17070 - name: service-type
17072 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17075 example: __SERVICE-TYPE__
17078 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.
17081 example: __VNF-TYPE__
17082 /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
17085 - ServiceDesignAndCreation
17086 summary: returns service-capability
17087 description: returns service-capability
17088 operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability
17094 description: successful operation
17096 $ref: "#/getDefinitions/service-capability"
17098 description: Response codes found in [response codes](https://wiki.onap.org/).
17100 - name: service-type
17102 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17105 example: __SERVICE-TYPE__
17108 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.
17111 example: __VNF-TYPE__
17114 - ServiceDesignAndCreation
17115 summary: create or update an existing service-capability
17117 Create or update an existing service-capability.
17119 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17120 operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
17129 description: Response codes found in [response codes](https://wiki.onap.org/).
17131 - name: service-type
17133 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17136 example: __SERVICE-TYPE__
17139 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.
17142 example: __VNF-TYPE__
17145 description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
17148 $ref: "#/definitions/service-capability"
17151 - ServiceDesignAndCreation
17152 summary: update an existing service-capability
17154 Update an existing service-capability
17156 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17157 The PUT operation will entirely replace an existing object.
17158 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17160 Other differences between PUT and PATCH are:
17162 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17163 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17164 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17165 operationId: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
17174 description: Response codes found in [response codes](https://wiki.onap.org/).
17176 - name: service-type
17178 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17181 example: __SERVICE-TYPE__
17184 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.
17187 example: __VNF-TYPE__
17190 description: service-capability object that needs to be created or updated.
17193 $ref: "#/patchDefinitions/service-capability"
17196 - ServiceDesignAndCreation
17197 summary: delete an existing service-capability
17198 description: delete an existing service-capability
17199 operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
17208 description: Response codes found in [response codes](https://wiki.onap.org/).
17210 - name: service-type
17212 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17215 example: __SERVICE-TYPE__
17218 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.
17221 example: __VNF-TYPE__
17222 - name: resource-version
17224 description: resource-version for concurrency
17227 /service-design-and-creation/service-capabilities:
17230 - ServiceDesignAndCreation
17231 summary: returns service-capabilities
17232 description: returns service-capabilities
17233 operationId: getServiceDesignAndCreationServiceCapabilities
17239 description: successful operation
17241 $ref: "#/getDefinitions/service-capabilities"
17243 description: Response codes found in [response codes](https://wiki.onap.org/).
17244 /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:
17247 - ServiceDesignAndCreation
17248 summary: see node definition for valid relationships
17249 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
17258 description: Response codes found in [response codes](https://wiki.onap.org/).
17260 - name: model-invariant-id
17262 description: Unique identifier corresponding to the main definition of a model in ASDC
17265 example: __MODEL-INVARIANT-ID__
17266 - name: model-version-id
17268 description: Unique identifier corresponding to one version of a model in ASDC
17271 example: __MODEL-VERSION-ID__
17272 - name: model-element-uuid
17276 example: __MODEL-ELEMENT-UUID__
17277 - name: model-constraint-uuid
17281 example: __MODEL-CONSTRAINT-UUID__
17282 - name: constrained-element-set-uuid
17286 example: __CONSTRAINED-ELEMENT-SET-UUID__
17287 - name: element-choice-set-uuid
17291 example: __ELEMENT-CHOICE-SET-UUID__
17294 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
17297 $ref: "#/definitions/relationship"
17300 - ServiceDesignAndCreation
17301 summary: delete an existing relationship
17302 description: delete an existing relationship
17303 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
17312 description: Response codes found in [response codes](https://wiki.onap.org/).
17314 - name: model-invariant-id
17316 description: Unique identifier corresponding to the main definition of a model in ASDC
17319 example: __MODEL-INVARIANT-ID__
17320 - name: model-version-id
17322 description: Unique identifier corresponding to one version of a model in ASDC
17325 example: __MODEL-VERSION-ID__
17326 - name: model-element-uuid
17330 example: __MODEL-ELEMENT-UUID__
17331 - name: model-constraint-uuid
17335 example: __MODEL-CONSTRAINT-UUID__
17336 - name: constrained-element-set-uuid
17340 example: __CONSTRAINED-ELEMENT-SET-UUID__
17341 - name: element-choice-set-uuid
17345 example: __ELEMENT-CHOICE-SET-UUID__
17346 /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}:
17349 - ServiceDesignAndCreation
17350 summary: returns element-choice-set
17351 description: returns element-choice-set
17352 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
17358 description: successful operation
17360 $ref: "#/getDefinitions/element-choice-set"
17362 description: Response codes found in [response codes](https://wiki.onap.org/).
17364 - name: model-invariant-id
17366 description: Unique identifier corresponding to the main definition of a model in ASDC
17369 example: __MODEL-INVARIANT-ID__
17370 - name: model-version-id
17372 description: Unique identifier corresponding to one version of a model in ASDC
17375 example: __MODEL-VERSION-ID__
17376 - name: model-element-uuid
17380 example: __MODEL-ELEMENT-UUID__
17381 - name: model-constraint-uuid
17385 example: __MODEL-CONSTRAINT-UUID__
17386 - name: constrained-element-set-uuid
17390 example: __CONSTRAINED-ELEMENT-SET-UUID__
17391 - name: element-choice-set-uuid
17395 example: __ELEMENT-CHOICE-SET-UUID__
17398 description: Type of the model, e.g., service, resource, widget, etc.
17403 description: Name of the model, which can change from version to version.
17406 - name: model-version
17408 description: Version
17413 - ServiceDesignAndCreation
17414 summary: create or update an existing element-choice-set
17416 Create or update an existing element-choice-set.
17418 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17419 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
17428 description: Response codes found in [response codes](https://wiki.onap.org/).
17430 - name: model-invariant-id
17432 description: Unique identifier corresponding to the main definition of a model in ASDC
17435 example: __MODEL-INVARIANT-ID__
17436 - name: model-version-id
17438 description: Unique identifier corresponding to one version of a model in ASDC
17441 example: __MODEL-VERSION-ID__
17442 - name: model-element-uuid
17446 example: __MODEL-ELEMENT-UUID__
17447 - name: model-constraint-uuid
17451 example: __MODEL-CONSTRAINT-UUID__
17452 - name: constrained-element-set-uuid
17456 example: __CONSTRAINED-ELEMENT-SET-UUID__
17457 - name: element-choice-set-uuid
17461 example: __ELEMENT-CHOICE-SET-UUID__
17464 description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
17467 $ref: "#/definitions/element-choice-set"
17470 - ServiceDesignAndCreation
17471 summary: update an existing element-choice-set
17473 Update an existing element-choice-set
17475 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17476 The PUT operation will entirely replace an existing object.
17477 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17479 Other differences between PUT and PATCH are:
17481 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17482 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17483 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17484 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
17493 description: Response codes found in [response codes](https://wiki.onap.org/).
17495 - name: model-invariant-id
17497 description: Unique identifier corresponding to the main definition of a model in ASDC
17500 example: __MODEL-INVARIANT-ID__
17501 - name: model-version-id
17503 description: Unique identifier corresponding to one version of a model in ASDC
17506 example: __MODEL-VERSION-ID__
17507 - name: model-element-uuid
17511 example: __MODEL-ELEMENT-UUID__
17512 - name: model-constraint-uuid
17516 example: __MODEL-CONSTRAINT-UUID__
17517 - name: constrained-element-set-uuid
17521 example: __CONSTRAINED-ELEMENT-SET-UUID__
17522 - name: element-choice-set-uuid
17526 example: __ELEMENT-CHOICE-SET-UUID__
17529 description: element-choice-set object that needs to be created or updated.
17532 $ref: "#/patchDefinitions/element-choice-set"
17535 - ServiceDesignAndCreation
17536 summary: delete an existing element-choice-set
17537 description: delete an existing element-choice-set
17538 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
17547 description: Response codes found in [response codes](https://wiki.onap.org/).
17549 - name: model-invariant-id
17551 description: Unique identifier corresponding to the main definition of a model in ASDC
17554 example: __MODEL-INVARIANT-ID__
17555 - name: model-version-id
17557 description: Unique identifier corresponding to one version of a model in ASDC
17560 example: __MODEL-VERSION-ID__
17561 - name: model-element-uuid
17565 example: __MODEL-ELEMENT-UUID__
17566 - name: model-constraint-uuid
17570 example: __MODEL-CONSTRAINT-UUID__
17571 - name: constrained-element-set-uuid
17575 example: __CONSTRAINED-ELEMENT-SET-UUID__
17576 - name: element-choice-set-uuid
17580 example: __ELEMENT-CHOICE-SET-UUID__
17581 - name: resource-version
17583 description: resource-version for concurrency
17586 /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:
17589 - ServiceDesignAndCreation
17590 summary: returns element-choice-sets
17591 description: returns element-choice-sets
17592 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
17598 description: successful operation
17600 $ref: "#/getDefinitions/element-choice-sets"
17602 description: Response codes found in [response codes](https://wiki.onap.org/).
17604 - name: model-invariant-id
17606 description: Unique identifier corresponding to the main definition of a model in ASDC
17609 example: __MODEL-INVARIANT-ID__
17610 - name: model-version-id
17612 description: Unique identifier corresponding to one version of a model in ASDC
17615 example: __MODEL-VERSION-ID__
17616 - name: model-element-uuid
17620 example: __MODEL-ELEMENT-UUID__
17621 - name: model-constraint-uuid
17625 example: __MODEL-CONSTRAINT-UUID__
17626 - name: constrained-element-set-uuid
17630 example: __CONSTRAINED-ELEMENT-SET-UUID__
17633 description: Type of the model, e.g., service, resource, widget, etc.
17638 description: Name of the model, which can change from version to version.
17641 - name: model-version
17643 description: Version
17646 /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:
17649 - ServiceDesignAndCreation
17650 summary: see node definition for valid relationships
17651 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
17660 description: Response codes found in [response codes](https://wiki.onap.org/).
17662 - name: model-invariant-id
17664 description: Unique identifier corresponding to the main definition of a model in ASDC
17667 example: __MODEL-INVARIANT-ID__
17668 - name: model-version-id
17670 description: Unique identifier corresponding to one version of a model in ASDC
17673 example: __MODEL-VERSION-ID__
17674 - name: model-element-uuid
17678 example: __MODEL-ELEMENT-UUID__
17679 - name: model-constraint-uuid
17683 example: __MODEL-CONSTRAINT-UUID__
17684 - name: constrained-element-set-uuid
17688 example: __CONSTRAINED-ELEMENT-SET-UUID__
17691 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
17694 $ref: "#/definitions/relationship"
17697 - ServiceDesignAndCreation
17698 summary: delete an existing relationship
17699 description: delete an existing relationship
17700 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
17709 description: Response codes found in [response codes](https://wiki.onap.org/).
17711 - name: model-invariant-id
17713 description: Unique identifier corresponding to the main definition of a model in ASDC
17716 example: __MODEL-INVARIANT-ID__
17717 - name: model-version-id
17719 description: Unique identifier corresponding to one version of a model in ASDC
17722 example: __MODEL-VERSION-ID__
17723 - name: model-element-uuid
17727 example: __MODEL-ELEMENT-UUID__
17728 - name: model-constraint-uuid
17732 example: __MODEL-CONSTRAINT-UUID__
17733 - name: constrained-element-set-uuid
17737 example: __CONSTRAINED-ELEMENT-SET-UUID__
17738 /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}:
17741 - ServiceDesignAndCreation
17742 summary: returns constrained-element-set
17743 description: returns constrained-element-set
17744 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
17750 description: successful operation
17752 $ref: "#/getDefinitions/constrained-element-set"
17754 description: Response codes found in [response codes](https://wiki.onap.org/).
17756 - name: model-invariant-id
17758 description: Unique identifier corresponding to the main definition of a model in ASDC
17761 example: __MODEL-INVARIANT-ID__
17762 - name: model-version-id
17764 description: Unique identifier corresponding to one version of a model in ASDC
17767 example: __MODEL-VERSION-ID__
17768 - name: model-element-uuid
17772 example: __MODEL-ELEMENT-UUID__
17773 - name: model-constraint-uuid
17777 example: __MODEL-CONSTRAINT-UUID__
17778 - name: constrained-element-set-uuid
17782 example: __CONSTRAINED-ELEMENT-SET-UUID__
17785 description: Type of the model, e.g., service, resource, widget, etc.
17790 description: Name of the model, which can change from version to version.
17793 - name: model-version
17795 description: Version
17800 - ServiceDesignAndCreation
17801 summary: create or update an existing constrained-element-set
17803 Create or update an existing constrained-element-set.
17805 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17806 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
17815 description: Response codes found in [response codes](https://wiki.onap.org/).
17817 - name: model-invariant-id
17819 description: Unique identifier corresponding to the main definition of a model in ASDC
17822 example: __MODEL-INVARIANT-ID__
17823 - name: model-version-id
17825 description: Unique identifier corresponding to one version of a model in ASDC
17828 example: __MODEL-VERSION-ID__
17829 - name: model-element-uuid
17833 example: __MODEL-ELEMENT-UUID__
17834 - name: model-constraint-uuid
17838 example: __MODEL-CONSTRAINT-UUID__
17839 - name: constrained-element-set-uuid
17843 example: __CONSTRAINED-ELEMENT-SET-UUID__
17846 description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
17849 $ref: "#/definitions/constrained-element-set"
17852 - ServiceDesignAndCreation
17853 summary: update an existing constrained-element-set
17855 Update an existing constrained-element-set
17857 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17858 The PUT operation will entirely replace an existing object.
17859 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17861 Other differences between PUT and PATCH are:
17863 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17864 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17865 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17866 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
17875 description: Response codes found in [response codes](https://wiki.onap.org/).
17877 - name: model-invariant-id
17879 description: Unique identifier corresponding to the main definition of a model in ASDC
17882 example: __MODEL-INVARIANT-ID__
17883 - name: model-version-id
17885 description: Unique identifier corresponding to one version of a model in ASDC
17888 example: __MODEL-VERSION-ID__
17889 - name: model-element-uuid
17893 example: __MODEL-ELEMENT-UUID__
17894 - name: model-constraint-uuid
17898 example: __MODEL-CONSTRAINT-UUID__
17899 - name: constrained-element-set-uuid
17903 example: __CONSTRAINED-ELEMENT-SET-UUID__
17906 description: constrained-element-set object that needs to be created or updated.
17909 $ref: "#/patchDefinitions/constrained-element-set"
17912 - ServiceDesignAndCreation
17913 summary: delete an existing constrained-element-set
17914 description: delete an existing constrained-element-set
17915 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
17924 description: Response codes found in [response codes](https://wiki.onap.org/).
17926 - name: model-invariant-id
17928 description: Unique identifier corresponding to the main definition of a model in ASDC
17931 example: __MODEL-INVARIANT-ID__
17932 - name: model-version-id
17934 description: Unique identifier corresponding to one version of a model in ASDC
17937 example: __MODEL-VERSION-ID__
17938 - name: model-element-uuid
17942 example: __MODEL-ELEMENT-UUID__
17943 - name: model-constraint-uuid
17947 example: __MODEL-CONSTRAINT-UUID__
17948 - name: constrained-element-set-uuid
17952 example: __CONSTRAINED-ELEMENT-SET-UUID__
17953 - name: resource-version
17955 description: resource-version for concurrency
17958 /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:
17961 - ServiceDesignAndCreation
17962 summary: returns constrained-element-sets
17963 description: returns constrained-element-sets
17964 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
17970 description: successful operation
17972 $ref: "#/getDefinitions/constrained-element-sets"
17974 description: Response codes found in [response codes](https://wiki.onap.org/).
17976 - name: model-invariant-id
17978 description: Unique identifier corresponding to the main definition of a model in ASDC
17981 example: __MODEL-INVARIANT-ID__
17982 - name: model-version-id
17984 description: Unique identifier corresponding to one version of a model in ASDC
17987 example: __MODEL-VERSION-ID__
17988 - name: model-element-uuid
17992 example: __MODEL-ELEMENT-UUID__
17993 - name: model-constraint-uuid
17997 example: __MODEL-CONSTRAINT-UUID__
18000 description: Type of the model, e.g., service, resource, widget, etc.
18005 description: Name of the model, which can change from version to version.
18008 - name: model-version
18010 description: Version
18013 /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}:
18016 - ServiceDesignAndCreation
18017 summary: returns model-constraint
18018 description: returns model-constraint
18019 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
18025 description: successful operation
18027 $ref: "#/getDefinitions/model-constraint"
18029 description: Response codes found in [response codes](https://wiki.onap.org/).
18031 - name: model-invariant-id
18033 description: Unique identifier corresponding to the main definition of a model in ASDC
18036 example: __MODEL-INVARIANT-ID__
18037 - name: model-version-id
18039 description: Unique identifier corresponding to one version of a model in ASDC
18042 example: __MODEL-VERSION-ID__
18043 - name: model-element-uuid
18047 example: __MODEL-ELEMENT-UUID__
18048 - name: model-constraint-uuid
18052 example: __MODEL-CONSTRAINT-UUID__
18055 description: Type of the model, e.g., service, resource, widget, etc.
18060 description: Name of the model, which can change from version to version.
18063 - name: model-version
18065 description: Version
18070 - ServiceDesignAndCreation
18071 summary: create or update an existing model-constraint
18073 Create or update an existing model-constraint.
18075 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18076 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
18085 description: Response codes found in [response codes](https://wiki.onap.org/).
18087 - name: model-invariant-id
18089 description: Unique identifier corresponding to the main definition of a model in ASDC
18092 example: __MODEL-INVARIANT-ID__
18093 - name: model-version-id
18095 description: Unique identifier corresponding to one version of a model in ASDC
18098 example: __MODEL-VERSION-ID__
18099 - name: model-element-uuid
18103 example: __MODEL-ELEMENT-UUID__
18104 - name: model-constraint-uuid
18108 example: __MODEL-CONSTRAINT-UUID__
18111 description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)
18114 $ref: "#/definitions/model-constraint"
18117 - ServiceDesignAndCreation
18118 summary: update an existing model-constraint
18120 Update an existing model-constraint
18122 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18123 The PUT operation will entirely replace an existing object.
18124 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18126 Other differences between PUT and PATCH are:
18128 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18129 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18130 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18131 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
18140 description: Response codes found in [response codes](https://wiki.onap.org/).
18142 - name: model-invariant-id
18144 description: Unique identifier corresponding to the main definition of a model in ASDC
18147 example: __MODEL-INVARIANT-ID__
18148 - name: model-version-id
18150 description: Unique identifier corresponding to one version of a model in ASDC
18153 example: __MODEL-VERSION-ID__
18154 - name: model-element-uuid
18158 example: __MODEL-ELEMENT-UUID__
18159 - name: model-constraint-uuid
18163 example: __MODEL-CONSTRAINT-UUID__
18166 description: model-constraint object that needs to be created or updated.
18169 $ref: "#/patchDefinitions/model-constraint"
18172 - ServiceDesignAndCreation
18173 summary: delete an existing model-constraint
18174 description: delete an existing model-constraint
18175 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
18184 description: Response codes found in [response codes](https://wiki.onap.org/).
18186 - name: model-invariant-id
18188 description: Unique identifier corresponding to the main definition of a model in ASDC
18191 example: __MODEL-INVARIANT-ID__
18192 - name: model-version-id
18194 description: Unique identifier corresponding to one version of a model in ASDC
18197 example: __MODEL-VERSION-ID__
18198 - name: model-element-uuid
18202 example: __MODEL-ELEMENT-UUID__
18203 - name: model-constraint-uuid
18207 example: __MODEL-CONSTRAINT-UUID__
18208 - name: resource-version
18210 description: resource-version for concurrency
18213 /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:
18216 - ServiceDesignAndCreation
18217 summary: returns model-constraints
18218 description: returns model-constraints
18219 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints
18225 description: successful operation
18227 $ref: "#/getDefinitions/model-constraints"
18229 description: Response codes found in [response codes](https://wiki.onap.org/).
18231 - name: model-invariant-id
18233 description: Unique identifier corresponding to the main definition of a model in ASDC
18236 example: __MODEL-INVARIANT-ID__
18237 - name: model-version-id
18239 description: Unique identifier corresponding to one version of a model in ASDC
18242 example: __MODEL-VERSION-ID__
18243 - name: model-element-uuid
18247 example: __MODEL-ELEMENT-UUID__
18250 description: Type of the model, e.g., service, resource, widget, etc.
18255 description: Name of the model, which can change from version to version.
18258 - name: model-version
18260 description: Version
18263 /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:
18266 - ServiceDesignAndCreation
18267 summary: see node definition for valid relationships
18268 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
18277 description: Response codes found in [response codes](https://wiki.onap.org/).
18279 - name: model-invariant-id
18281 description: Unique identifier corresponding to the main definition of a model in ASDC
18284 example: __MODEL-INVARIANT-ID__
18285 - name: model-version-id
18287 description: Unique identifier corresponding to one version of a model in ASDC
18290 example: __MODEL-VERSION-ID__
18291 - name: model-element-uuid
18295 example: __MODEL-ELEMENT-UUID__
18298 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
18301 $ref: "#/definitions/relationship"
18304 - ServiceDesignAndCreation
18305 summary: delete an existing relationship
18306 description: delete an existing relationship
18307 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
18316 description: Response codes found in [response codes](https://wiki.onap.org/).
18318 - name: model-invariant-id
18320 description: Unique identifier corresponding to the main definition of a model in ASDC
18323 example: __MODEL-INVARIANT-ID__
18324 - name: model-version-id
18326 description: Unique identifier corresponding to one version of a model in ASDC
18329 example: __MODEL-VERSION-ID__
18330 - name: model-element-uuid
18334 example: __MODEL-ELEMENT-UUID__
18335 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}:
18338 - ServiceDesignAndCreation
18339 summary: returns model-element
18340 description: returns model-element
18341 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
18347 description: successful operation
18349 $ref: "#/getDefinitions/model-element"
18351 description: Response codes found in [response codes](https://wiki.onap.org/).
18353 - name: model-invariant-id
18355 description: Unique identifier corresponding to the main definition of a model in ASDC
18358 example: __MODEL-INVARIANT-ID__
18359 - name: model-version-id
18361 description: Unique identifier corresponding to one version of a model in ASDC
18364 example: __MODEL-VERSION-ID__
18365 - name: model-element-uuid
18369 example: __MODEL-ELEMENT-UUID__
18372 description: Type of the model, e.g., service, resource, widget, etc.
18377 description: Name of the model, which can change from version to version.
18380 - name: model-version
18382 description: Version
18387 - ServiceDesignAndCreation
18388 summary: create or update an existing model-element
18390 Create or update an existing model-element.
18392 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18393 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
18402 description: Response codes found in [response codes](https://wiki.onap.org/).
18404 - name: model-invariant-id
18406 description: Unique identifier corresponding to the main definition of a model in ASDC
18409 example: __MODEL-INVARIANT-ID__
18410 - name: model-version-id
18412 description: Unique identifier corresponding to one version of a model in ASDC
18415 example: __MODEL-VERSION-ID__
18416 - name: model-element-uuid
18420 example: __MODEL-ELEMENT-UUID__
18423 description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
18426 $ref: "#/definitions/model-element"
18429 - ServiceDesignAndCreation
18430 summary: update an existing model-element
18432 Update an existing model-element
18434 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18435 The PUT operation will entirely replace an existing object.
18436 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18438 Other differences between PUT and PATCH are:
18440 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18441 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18442 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18443 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
18452 description: Response codes found in [response codes](https://wiki.onap.org/).
18454 - name: model-invariant-id
18456 description: Unique identifier corresponding to the main definition of a model in ASDC
18459 example: __MODEL-INVARIANT-ID__
18460 - name: model-version-id
18462 description: Unique identifier corresponding to one version of a model in ASDC
18465 example: __MODEL-VERSION-ID__
18466 - name: model-element-uuid
18470 example: __MODEL-ELEMENT-UUID__
18473 description: model-element object that needs to be created or updated.
18476 $ref: "#/patchDefinitions/model-element"
18479 - ServiceDesignAndCreation
18480 summary: delete an existing model-element
18481 description: delete an existing model-element
18482 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
18491 description: Response codes found in [response codes](https://wiki.onap.org/).
18493 - name: model-invariant-id
18495 description: Unique identifier corresponding to the main definition of a model in ASDC
18498 example: __MODEL-INVARIANT-ID__
18499 - name: model-version-id
18501 description: Unique identifier corresponding to one version of a model in ASDC
18504 example: __MODEL-VERSION-ID__
18505 - name: model-element-uuid
18509 example: __MODEL-ELEMENT-UUID__
18510 - name: resource-version
18512 description: resource-version for concurrency
18515 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements:
18518 - ServiceDesignAndCreation
18519 summary: returns model-elements
18520 description: returns model-elements
18521 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements
18527 description: successful operation
18529 $ref: "#/getDefinitions/model-elements"
18531 description: Response codes found in [response codes](https://wiki.onap.org/).
18533 - name: model-invariant-id
18535 description: Unique identifier corresponding to the main definition of a model in ASDC
18538 example: __MODEL-INVARIANT-ID__
18539 - name: model-version-id
18541 description: Unique identifier corresponding to one version of a model in ASDC
18544 example: __MODEL-VERSION-ID__
18547 description: Type of the model, e.g., service, resource, widget, etc.
18552 description: Name of the model, which can change from version to version.
18555 - name: model-version
18557 description: Version
18560 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}:
18563 - ServiceDesignAndCreation
18564 summary: returns metadatum
18565 description: returns metadatum
18566 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
18572 description: successful operation
18574 $ref: "#/getDefinitions/metadatum"
18576 description: Response codes found in [response codes](https://wiki.onap.org/).
18578 - name: model-invariant-id
18580 description: Unique identifier corresponding to the main definition of a model in ASDC
18583 example: __MODEL-INVARIANT-ID__
18584 - name: model-version-id
18586 description: Unique identifier corresponding to one version of a model in ASDC
18589 example: __MODEL-VERSION-ID__
18594 example: __METANAME__
18597 description: Type of the model, e.g., service, resource, widget, etc.
18602 description: Name of the model, which can change from version to version.
18605 - name: model-version
18607 description: Version
18612 - ServiceDesignAndCreation
18613 summary: create or update an existing metadatum
18615 Create or update an existing metadatum.
18617 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18618 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
18627 description: Response codes found in [response codes](https://wiki.onap.org/).
18629 - name: model-invariant-id
18631 description: Unique identifier corresponding to the main definition of a model in ASDC
18634 example: __MODEL-INVARIANT-ID__
18635 - name: model-version-id
18637 description: Unique identifier corresponding to one version of a model in ASDC
18640 example: __MODEL-VERSION-ID__
18645 example: __METANAME__
18648 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json)
18651 $ref: "#/definitions/metadatum"
18654 - ServiceDesignAndCreation
18655 summary: update an existing metadatum
18657 Update an existing metadatum
18659 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18660 The PUT operation will entirely replace an existing object.
18661 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18663 Other differences between PUT and PATCH are:
18665 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18666 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18667 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18668 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
18677 description: Response codes found in [response codes](https://wiki.onap.org/).
18679 - name: model-invariant-id
18681 description: Unique identifier corresponding to the main definition of a model in ASDC
18684 example: __MODEL-INVARIANT-ID__
18685 - name: model-version-id
18687 description: Unique identifier corresponding to one version of a model in ASDC
18690 example: __MODEL-VERSION-ID__
18695 example: __METANAME__
18698 description: metadatum object that needs to be created or updated.
18701 $ref: "#/patchDefinitions/metadatum"
18704 - ServiceDesignAndCreation
18705 summary: delete an existing metadatum
18706 description: delete an existing metadatum
18707 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
18716 description: Response codes found in [response codes](https://wiki.onap.org/).
18718 - name: model-invariant-id
18720 description: Unique identifier corresponding to the main definition of a model in ASDC
18723 example: __MODEL-INVARIANT-ID__
18724 - name: model-version-id
18726 description: Unique identifier corresponding to one version of a model in ASDC
18729 example: __MODEL-VERSION-ID__
18734 example: __METANAME__
18735 - name: resource-version
18737 description: resource-version for concurrency
18740 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata:
18743 - ServiceDesignAndCreation
18744 summary: returns metadata
18745 description: returns metadata
18746 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata
18752 description: successful operation
18754 $ref: "#/getDefinitions/metadata"
18756 description: Response codes found in [response codes](https://wiki.onap.org/).
18758 - name: model-invariant-id
18760 description: Unique identifier corresponding to the main definition of a model in ASDC
18763 example: __MODEL-INVARIANT-ID__
18764 - name: model-version-id
18766 description: Unique identifier corresponding to one version of a model in ASDC
18769 example: __MODEL-VERSION-ID__
18772 description: Type of the model, e.g., service, resource, widget, etc.
18777 description: Name of the model, which can change from version to version.
18780 - name: model-version
18782 description: Version
18785 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship:
18788 - ServiceDesignAndCreation
18789 summary: see node definition for valid relationships
18790 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
18799 description: Response codes found in [response codes](https://wiki.onap.org/).
18801 - name: model-invariant-id
18803 description: Unique identifier corresponding to the main definition of a model in ASDC
18806 example: __MODEL-INVARIANT-ID__
18807 - name: model-version-id
18809 description: Unique identifier corresponding to one version of a model in ASDC
18812 example: __MODEL-VERSION-ID__
18815 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
18818 $ref: "#/definitions/relationship"
18821 - ServiceDesignAndCreation
18822 summary: delete an existing relationship
18823 description: delete an existing relationship
18824 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
18833 description: Response codes found in [response codes](https://wiki.onap.org/).
18835 - name: model-invariant-id
18837 description: Unique identifier corresponding to the main definition of a model in ASDC
18840 example: __MODEL-INVARIANT-ID__
18841 - name: model-version-id
18843 description: Unique identifier corresponding to one version of a model in ASDC
18846 example: __MODEL-VERSION-ID__
18847 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}:
18850 - ServiceDesignAndCreation
18851 summary: returns model-ver
18852 description: returns model-ver
18853 operationId: getServiceDesignAndCreationModelsModelModelVersModelVer
18859 description: successful operation
18861 $ref: "#/getDefinitions/model-ver"
18863 description: Response codes found in [response codes](https://wiki.onap.org/).
18865 - name: model-invariant-id
18867 description: Unique identifier corresponding to the main definition of a model in ASDC
18870 example: __MODEL-INVARIANT-ID__
18871 - name: model-version-id
18873 description: Unique identifier corresponding to one version of a model in ASDC
18876 example: __MODEL-VERSION-ID__
18879 description: Type of the model, e.g., service, resource, widget, etc.
18884 description: Name of the model, which can change from version to version.
18887 - name: model-version
18889 description: Version
18894 - ServiceDesignAndCreation
18895 summary: create or update an existing model-ver
18897 Create or update an existing model-ver.
18899 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18900 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer
18909 description: Response codes found in [response codes](https://wiki.onap.org/).
18911 - name: model-invariant-id
18913 description: Unique identifier corresponding to the main definition of a model in ASDC
18916 example: __MODEL-INVARIANT-ID__
18917 - name: model-version-id
18919 description: Unique identifier corresponding to one version of a model in ASDC
18922 example: __MODEL-VERSION-ID__
18925 description: model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
18928 $ref: "#/definitions/model-ver"
18931 - ServiceDesignAndCreation
18932 summary: update an existing model-ver
18934 Update an existing model-ver
18936 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18937 The PUT operation will entirely replace an existing object.
18938 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18940 Other differences between PUT and PATCH are:
18942 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18943 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18944 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18945 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVer
18954 description: Response codes found in [response codes](https://wiki.onap.org/).
18956 - name: model-invariant-id
18958 description: Unique identifier corresponding to the main definition of a model in ASDC
18961 example: __MODEL-INVARIANT-ID__
18962 - name: model-version-id
18964 description: Unique identifier corresponding to one version of a model in ASDC
18967 example: __MODEL-VERSION-ID__
18970 description: model-ver object that needs to be created or updated.
18973 $ref: "#/patchDefinitions/model-ver"
18976 - ServiceDesignAndCreation
18977 summary: delete an existing model-ver
18978 description: delete an existing model-ver
18979 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVer
18988 description: Response codes found in [response codes](https://wiki.onap.org/).
18990 - name: model-invariant-id
18992 description: Unique identifier corresponding to the main definition of a model in ASDC
18995 example: __MODEL-INVARIANT-ID__
18996 - name: model-version-id
18998 description: Unique identifier corresponding to one version of a model in ASDC
19001 example: __MODEL-VERSION-ID__
19002 - name: resource-version
19004 description: resource-version for concurrency
19007 /service-design-and-creation/models/model/{model-invariant-id}/model-vers:
19010 - ServiceDesignAndCreation
19011 summary: returns model-vers
19012 description: returns model-vers
19013 operationId: getServiceDesignAndCreationModelsModelModelVers
19019 description: successful operation
19021 $ref: "#/getDefinitions/model-vers"
19023 description: Response codes found in [response codes](https://wiki.onap.org/).
19025 - name: model-invariant-id
19027 description: Unique identifier corresponding to the main definition of a model in ASDC
19030 example: __MODEL-INVARIANT-ID__
19033 description: Type of the model, e.g., service, resource, widget, etc.
19036 /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship:
19039 - ServiceDesignAndCreation
19040 summary: see node definition for valid relationships
19041 operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship
19050 description: Response codes found in [response codes](https://wiki.onap.org/).
19052 - name: model-invariant-id
19054 description: Unique identifier corresponding to the main definition of a model in ASDC
19057 example: __MODEL-INVARIANT-ID__
19060 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModel.json)
19063 $ref: "#/definitions/relationship"
19066 - ServiceDesignAndCreation
19067 summary: delete an existing relationship
19068 description: delete an existing relationship
19069 operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship
19078 description: Response codes found in [response codes](https://wiki.onap.org/).
19080 - name: model-invariant-id
19082 description: Unique identifier corresponding to the main definition of a model in ASDC
19085 example: __MODEL-INVARIANT-ID__
19086 /service-design-and-creation/models/model/{model-invariant-id}:
19089 - ServiceDesignAndCreation
19090 summary: returns model
19091 description: returns model
19092 operationId: getServiceDesignAndCreationModelsModel
19098 description: successful operation
19100 $ref: "#/getDefinitions/model"
19102 description: Response codes found in [response codes](https://wiki.onap.org/).
19104 - name: model-invariant-id
19106 description: Unique identifier corresponding to the main definition of a model in ASDC
19109 example: __MODEL-INVARIANT-ID__
19112 description: Type of the model, e.g., service, resource, widget, etc.
19117 - ServiceDesignAndCreation
19118 summary: create or update an existing model
19120 Create or update an existing model.
19122 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19123 operationId: createOrUpdateServiceDesignAndCreationModelsModel
19132 description: Response codes found in [response codes](https://wiki.onap.org/).
19134 - name: model-invariant-id
19136 description: Unique identifier corresponding to the main definition of a model in ASDC
19139 example: __MODEL-INVARIANT-ID__
19142 description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModel.json)
19145 $ref: "#/definitions/model"
19148 - ServiceDesignAndCreation
19149 summary: update an existing model
19151 Update an existing model
19153 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19154 The PUT operation will entirely replace an existing object.
19155 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19157 Other differences between PUT and PATCH are:
19159 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19160 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19161 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19162 operationId: UpdateServiceDesignAndCreationModelsModel
19171 description: Response codes found in [response codes](https://wiki.onap.org/).
19173 - name: model-invariant-id
19175 description: Unique identifier corresponding to the main definition of a model in ASDC
19178 example: __MODEL-INVARIANT-ID__
19181 description: model object that needs to be created or updated.
19184 $ref: "#/patchDefinitions/model"
19187 - ServiceDesignAndCreation
19188 summary: delete an existing model
19189 description: delete an existing model
19190 operationId: deleteServiceDesignAndCreationModelsModel
19199 description: Response codes found in [response codes](https://wiki.onap.org/).
19201 - name: model-invariant-id
19203 description: Unique identifier corresponding to the main definition of a model in ASDC
19206 example: __MODEL-INVARIANT-ID__
19207 - name: resource-version
19209 description: resource-version for concurrency
19212 /service-design-and-creation/models:
19215 - ServiceDesignAndCreation
19216 summary: returns models
19217 description: returns models
19218 operationId: getServiceDesignAndCreationModels
19224 description: successful operation
19226 $ref: "#/getDefinitions/models"
19228 description: Response codes found in [response codes](https://wiki.onap.org/).
19229 /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:
19232 - ServiceDesignAndCreation
19233 summary: see node definition for valid relationships
19234 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
19243 description: Response codes found in [response codes](https://wiki.onap.org/).
19245 - name: named-query-uuid
19249 example: __NAMED-QUERY-UUID__
19250 - name: named-query-element-uuid
19254 example: __NAMED-QUERY-ELEMENT-UUID__
19255 - name: related-lookup-uuid
19259 example: __RELATED-LOOKUP-UUID__
19262 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
19265 $ref: "#/definitions/relationship"
19268 - ServiceDesignAndCreation
19269 summary: delete an existing relationship
19270 description: delete an existing relationship
19271 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
19280 description: Response codes found in [response codes](https://wiki.onap.org/).
19282 - name: named-query-uuid
19286 example: __NAMED-QUERY-UUID__
19287 - name: named-query-element-uuid
19291 example: __NAMED-QUERY-ELEMENT-UUID__
19292 - name: related-lookup-uuid
19296 example: __RELATED-LOOKUP-UUID__
19297 /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}:
19300 - ServiceDesignAndCreation
19301 summary: returns related-lookup
19302 description: returns related-lookup
19303 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
19309 description: successful operation
19311 $ref: "#/getDefinitions/related-lookup"
19313 description: Response codes found in [response codes](https://wiki.onap.org/).
19315 - name: named-query-uuid
19319 example: __NAMED-QUERY-UUID__
19320 - name: named-query-element-uuid
19324 example: __NAMED-QUERY-ELEMENT-UUID__
19325 - name: related-lookup-uuid
19329 example: __RELATED-LOOKUP-UUID__
19330 - name: named-query-name
19336 - ServiceDesignAndCreation
19337 summary: create or update an existing related-lookup
19339 Create or update an existing related-lookup.
19341 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19342 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
19351 description: Response codes found in [response codes](https://wiki.onap.org/).
19353 - name: named-query-uuid
19357 example: __NAMED-QUERY-UUID__
19358 - name: named-query-element-uuid
19362 example: __NAMED-QUERY-ELEMENT-UUID__
19363 - name: related-lookup-uuid
19367 example: __RELATED-LOOKUP-UUID__
19370 description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
19373 $ref: "#/definitions/related-lookup"
19376 - ServiceDesignAndCreation
19377 summary: update an existing related-lookup
19379 Update an existing related-lookup
19381 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19382 The PUT operation will entirely replace an existing object.
19383 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19385 Other differences between PUT and PATCH are:
19387 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19388 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19389 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19390 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
19399 description: Response codes found in [response codes](https://wiki.onap.org/).
19401 - name: named-query-uuid
19405 example: __NAMED-QUERY-UUID__
19406 - name: named-query-element-uuid
19410 example: __NAMED-QUERY-ELEMENT-UUID__
19411 - name: related-lookup-uuid
19415 example: __RELATED-LOOKUP-UUID__
19418 description: related-lookup object that needs to be created or updated.
19421 $ref: "#/patchDefinitions/related-lookup"
19424 - ServiceDesignAndCreation
19425 summary: delete an existing related-lookup
19426 description: delete an existing related-lookup
19427 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
19436 description: Response codes found in [response codes](https://wiki.onap.org/).
19438 - name: named-query-uuid
19442 example: __NAMED-QUERY-UUID__
19443 - name: named-query-element-uuid
19447 example: __NAMED-QUERY-ELEMENT-UUID__
19448 - name: related-lookup-uuid
19452 example: __RELATED-LOOKUP-UUID__
19453 - name: resource-version
19455 description: resource-version for concurrency
19458 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups:
19461 - ServiceDesignAndCreation
19462 summary: returns related-lookups
19463 description: returns related-lookups
19464 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups
19470 description: successful operation
19472 $ref: "#/getDefinitions/related-lookups"
19474 description: Response codes found in [response codes](https://wiki.onap.org/).
19476 - name: named-query-uuid
19480 example: __NAMED-QUERY-UUID__
19481 - name: named-query-element-uuid
19485 example: __NAMED-QUERY-ELEMENT-UUID__
19486 - name: named-query-name
19490 /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}:
19493 - ServiceDesignAndCreation
19494 summary: returns property-constraint
19495 description: returns property-constraint
19496 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
19502 description: successful operation
19504 $ref: "#/getDefinitions/property-constraint"
19506 description: Response codes found in [response codes](https://wiki.onap.org/).
19508 - name: named-query-uuid
19512 example: __NAMED-QUERY-UUID__
19513 - name: named-query-element-uuid
19517 example: __NAMED-QUERY-ELEMENT-UUID__
19518 - name: property-constraint-uuid
19522 example: __PROPERTY-CONSTRAINT-UUID__
19523 - name: named-query-name
19529 - ServiceDesignAndCreation
19530 summary: create or update an existing property-constraint
19532 Create or update an existing property-constraint.
19534 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19535 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
19544 description: Response codes found in [response codes](https://wiki.onap.org/).
19546 - name: named-query-uuid
19550 example: __NAMED-QUERY-UUID__
19551 - name: named-query-element-uuid
19555 example: __NAMED-QUERY-ELEMENT-UUID__
19556 - name: property-constraint-uuid
19560 example: __PROPERTY-CONSTRAINT-UUID__
19563 description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)
19566 $ref: "#/definitions/property-constraint"
19569 - ServiceDesignAndCreation
19570 summary: update an existing property-constraint
19572 Update an existing property-constraint
19574 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19575 The PUT operation will entirely replace an existing object.
19576 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19578 Other differences between PUT and PATCH are:
19580 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19581 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19582 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19583 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
19592 description: Response codes found in [response codes](https://wiki.onap.org/).
19594 - name: named-query-uuid
19598 example: __NAMED-QUERY-UUID__
19599 - name: named-query-element-uuid
19603 example: __NAMED-QUERY-ELEMENT-UUID__
19604 - name: property-constraint-uuid
19608 example: __PROPERTY-CONSTRAINT-UUID__
19611 description: property-constraint object that needs to be created or updated.
19614 $ref: "#/patchDefinitions/property-constraint"
19617 - ServiceDesignAndCreation
19618 summary: delete an existing property-constraint
19619 description: delete an existing property-constraint
19620 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
19629 description: Response codes found in [response codes](https://wiki.onap.org/).
19631 - name: named-query-uuid
19635 example: __NAMED-QUERY-UUID__
19636 - name: named-query-element-uuid
19640 example: __NAMED-QUERY-ELEMENT-UUID__
19641 - name: property-constraint-uuid
19645 example: __PROPERTY-CONSTRAINT-UUID__
19646 - name: resource-version
19648 description: resource-version for concurrency
19651 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints:
19654 - ServiceDesignAndCreation
19655 summary: returns property-constraints
19656 description: returns property-constraints
19657 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints
19663 description: successful operation
19665 $ref: "#/getDefinitions/property-constraints"
19667 description: Response codes found in [response codes](https://wiki.onap.org/).
19669 - name: named-query-uuid
19673 example: __NAMED-QUERY-UUID__
19674 - name: named-query-element-uuid
19678 example: __NAMED-QUERY-ELEMENT-UUID__
19679 - name: named-query-name
19683 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship:
19686 - ServiceDesignAndCreation
19687 summary: see node definition for valid relationships
19688 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
19697 description: Response codes found in [response codes](https://wiki.onap.org/).
19699 - name: named-query-uuid
19703 example: __NAMED-QUERY-UUID__
19704 - name: named-query-element-uuid
19708 example: __NAMED-QUERY-ELEMENT-UUID__
19711 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
19714 $ref: "#/definitions/relationship"
19717 - ServiceDesignAndCreation
19718 summary: delete an existing relationship
19719 description: delete an existing relationship
19720 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
19729 description: Response codes found in [response codes](https://wiki.onap.org/).
19731 - name: named-query-uuid
19735 example: __NAMED-QUERY-UUID__
19736 - name: named-query-element-uuid
19740 example: __NAMED-QUERY-ELEMENT-UUID__
19741 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}:
19744 - ServiceDesignAndCreation
19745 summary: returns named-query-element
19746 description: returns named-query-element
19747 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
19753 description: successful operation
19755 $ref: "#/getDefinitions/named-query-element"
19757 description: Response codes found in [response codes](https://wiki.onap.org/).
19759 - name: named-query-uuid
19763 example: __NAMED-QUERY-UUID__
19764 - name: named-query-element-uuid
19768 example: __NAMED-QUERY-ELEMENT-UUID__
19769 - name: named-query-name
19775 - ServiceDesignAndCreation
19776 summary: create or update an existing named-query-element
19778 Create or update an existing named-query-element.
19780 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19781 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
19790 description: Response codes found in [response codes](https://wiki.onap.org/).
19792 - name: named-query-uuid
19796 example: __NAMED-QUERY-UUID__
19797 - name: named-query-element-uuid
19801 example: __NAMED-QUERY-ELEMENT-UUID__
19804 description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
19807 $ref: "#/definitions/named-query-element"
19810 - ServiceDesignAndCreation
19811 summary: update an existing named-query-element
19813 Update an existing named-query-element
19815 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19816 The PUT operation will entirely replace an existing object.
19817 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19819 Other differences between PUT and PATCH are:
19821 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19822 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19823 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19824 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
19833 description: Response codes found in [response codes](https://wiki.onap.org/).
19835 - name: named-query-uuid
19839 example: __NAMED-QUERY-UUID__
19840 - name: named-query-element-uuid
19844 example: __NAMED-QUERY-ELEMENT-UUID__
19847 description: named-query-element object that needs to be created or updated.
19850 $ref: "#/patchDefinitions/named-query-element"
19853 - ServiceDesignAndCreation
19854 summary: delete an existing named-query-element
19855 description: delete an existing named-query-element
19856 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
19865 description: Response codes found in [response codes](https://wiki.onap.org/).
19867 - name: named-query-uuid
19871 example: __NAMED-QUERY-UUID__
19872 - name: named-query-element-uuid
19876 example: __NAMED-QUERY-ELEMENT-UUID__
19877 - name: resource-version
19879 description: resource-version for concurrency
19882 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements:
19885 - ServiceDesignAndCreation
19886 summary: returns named-query-elements
19887 description: returns named-query-elements
19888 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements
19894 description: successful operation
19896 $ref: "#/getDefinitions/named-query-elements"
19898 description: Response codes found in [response codes](https://wiki.onap.org/).
19900 - name: named-query-uuid
19904 example: __NAMED-QUERY-UUID__
19905 - name: named-query-name
19909 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship:
19912 - ServiceDesignAndCreation
19913 summary: see node definition for valid relationships
19914 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
19923 description: Response codes found in [response codes](https://wiki.onap.org/).
19925 - name: named-query-uuid
19929 example: __NAMED-QUERY-UUID__
19932 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
19935 $ref: "#/definitions/relationship"
19938 - ServiceDesignAndCreation
19939 summary: delete an existing relationship
19940 description: delete an existing relationship
19941 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
19950 description: Response codes found in [response codes](https://wiki.onap.org/).
19952 - name: named-query-uuid
19956 example: __NAMED-QUERY-UUID__
19957 /service-design-and-creation/named-queries/named-query/{named-query-uuid}:
19960 - ServiceDesignAndCreation
19961 summary: returns named-query
19962 description: returns named-query
19963 operationId: getServiceDesignAndCreationNamedQueriesNamedQuery
19969 description: successful operation
19971 $ref: "#/getDefinitions/named-query"
19973 description: Response codes found in [response codes](https://wiki.onap.org/).
19975 - name: named-query-uuid
19979 example: __NAMED-QUERY-UUID__
19980 - name: named-query-name
19986 - ServiceDesignAndCreation
19987 summary: create or update an existing named-query
19989 Create or update an existing named-query.
19991 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19992 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery
20001 description: Response codes found in [response codes](https://wiki.onap.org/).
20003 - name: named-query-uuid
20007 example: __NAMED-QUERY-UUID__
20010 description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
20013 $ref: "#/definitions/named-query"
20016 - ServiceDesignAndCreation
20017 summary: update an existing named-query
20019 Update an existing named-query
20021 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20022 The PUT operation will entirely replace an existing object.
20023 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20025 Other differences between PUT and PATCH are:
20027 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20028 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20029 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20030 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQuery
20039 description: Response codes found in [response codes](https://wiki.onap.org/).
20041 - name: named-query-uuid
20045 example: __NAMED-QUERY-UUID__
20048 description: named-query object that needs to be created or updated.
20051 $ref: "#/patchDefinitions/named-query"
20054 - ServiceDesignAndCreation
20055 summary: delete an existing named-query
20056 description: delete an existing named-query
20057 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery
20066 description: Response codes found in [response codes](https://wiki.onap.org/).
20068 - name: named-query-uuid
20072 example: __NAMED-QUERY-UUID__
20073 - name: resource-version
20075 description: resource-version for concurrency
20078 /service-design-and-creation/named-queries:
20081 - ServiceDesignAndCreation
20082 summary: returns named-queries
20083 description: returns named-queries
20084 operationId: getServiceDesignAndCreationNamedQueries
20090 description: successful operation
20092 $ref: "#/getDefinitions/named-queries"
20094 description: Response codes found in [response codes](https://wiki.onap.org/).
20095 /network/logical-links/logical-link/{link-name}/relationship-list/relationship:
20099 summary: see node definition for valid relationships
20100 operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship
20109 description: Response codes found in [response codes](https://wiki.onap.org/).
20113 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20116 example: __LINK-NAME__
20119 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkLogicalLinksLogicalLink.json)
20122 $ref: "#/definitions/relationship"
20126 summary: delete an existing relationship
20127 description: delete an existing relationship
20128 operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship
20137 description: Response codes found in [response codes](https://wiki.onap.org/).
20141 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20144 example: __LINK-NAME__
20145 /network/logical-links/logical-link/{link-name}:
20149 summary: returns logical-link
20150 description: returns logical-link
20151 operationId: getNetworkLogicalLinksLogicalLink
20157 description: successful operation
20159 $ref: "#/getDefinitions/logical-link"
20161 description: Response codes found in [response codes](https://wiki.onap.org/).
20165 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20168 example: __LINK-NAME__
20169 - name: model-invariant-id
20171 description: the ASDC model id for this resource or service model.
20174 - name: model-version-id
20176 description: the ASDC model version for this resource or service model.
20179 - name: widget-model-id
20181 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
20184 - name: widget-model-version
20186 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
20189 - name: prov-status
20191 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
20196 description: UUID of the logical-link, SDNC generates this.
20201 description: Circuit id
20206 description: Reason for this entity, role it is playing
20212 summary: create or update an existing logical-link
20214 Create or update an existing logical-link.
20216 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20217 operationId: createOrUpdateNetworkLogicalLinksLogicalLink
20226 description: Response codes found in [response codes](https://wiki.onap.org/).
20230 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20233 example: __LINK-NAME__
20236 description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkLogicalLinksLogicalLink.json)
20239 $ref: "#/definitions/logical-link"
20243 summary: update an existing logical-link
20245 Update an existing logical-link
20247 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20248 The PUT operation will entirely replace an existing object.
20249 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20251 Other differences between PUT and PATCH are:
20253 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20254 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20255 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20256 operationId: UpdateNetworkLogicalLinksLogicalLink
20265 description: Response codes found in [response codes](https://wiki.onap.org/).
20269 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20272 example: __LINK-NAME__
20275 description: logical-link object that needs to be created or updated.
20278 $ref: "#/patchDefinitions/logical-link"
20282 summary: delete an existing logical-link
20283 description: delete an existing logical-link
20284 operationId: deleteNetworkLogicalLinksLogicalLink
20293 description: Response codes found in [response codes](https://wiki.onap.org/).
20297 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20300 example: __LINK-NAME__
20301 - name: resource-version
20303 description: resource-version for concurrency
20306 /network/logical-links:
20310 summary: returns logical-links
20311 description: returns logical-links
20312 operationId: getNetworkLogicalLinks
20318 description: successful operation
20320 $ref: "#/getDefinitions/logical-links"
20322 description: Response codes found in [response codes](https://wiki.onap.org/).
20323 /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:
20327 summary: see node definition for valid relationships
20328 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
20337 description: Response codes found in [response codes](https://wiki.onap.org/).
20339 - name: site-pair-set-id
20341 description: Unique id of site pair set.
20344 example: __SITE-PAIR-SET-ID__
20345 - name: routing-instance-id
20347 description: Unique id of routing instance
20350 example: __ROUTING-INSTANCE-ID__
20351 - name: site-pair-id
20353 description: unique identifier of probe
20356 example: __SITE-PAIR-ID__
20359 description: unique identifier of probe
20365 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
20368 $ref: "#/definitions/relationship"
20372 summary: delete an existing relationship
20373 description: delete an existing relationship
20374 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
20383 description: Response codes found in [response codes](https://wiki.onap.org/).
20385 - name: site-pair-set-id
20387 description: Unique id of site pair set.
20390 example: __SITE-PAIR-SET-ID__
20391 - name: routing-instance-id
20393 description: Unique id of routing instance
20396 example: __ROUTING-INSTANCE-ID__
20397 - name: site-pair-id
20399 description: unique identifier of probe
20402 example: __SITE-PAIR-ID__
20405 description: unique identifier of probe
20409 /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}:
20413 summary: returns class-of-service
20414 description: returns class-of-service
20415 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
20421 description: successful operation
20423 $ref: "#/getDefinitions/class-of-service"
20425 description: Response codes found in [response codes](https://wiki.onap.org/).
20427 - name: site-pair-set-id
20429 description: Unique id of site pair set.
20432 example: __SITE-PAIR-SET-ID__
20433 - name: routing-instance-id
20435 description: Unique id of routing instance
20438 example: __ROUTING-INSTANCE-ID__
20439 - name: site-pair-id
20441 description: unique identifier of probe
20444 example: __SITE-PAIR-ID__
20447 description: unique identifier of probe
20454 summary: create or update an existing class-of-service
20456 Create or update an existing class-of-service.
20458 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20459 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
20468 description: Response codes found in [response codes](https://wiki.onap.org/).
20470 - name: site-pair-set-id
20472 description: Unique id of site pair set.
20475 example: __SITE-PAIR-SET-ID__
20476 - name: routing-instance-id
20478 description: Unique id of routing instance
20481 example: __ROUTING-INSTANCE-ID__
20482 - name: site-pair-id
20484 description: unique identifier of probe
20487 example: __SITE-PAIR-ID__
20490 description: unique identifier of probe
20496 description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
20499 $ref: "#/definitions/class-of-service"
20503 summary: update an existing class-of-service
20505 Update an existing class-of-service
20507 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20508 The PUT operation will entirely replace an existing object.
20509 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20511 Other differences between PUT and PATCH are:
20513 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20514 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20515 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20516 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
20525 description: Response codes found in [response codes](https://wiki.onap.org/).
20527 - name: site-pair-set-id
20529 description: Unique id of site pair set.
20532 example: __SITE-PAIR-SET-ID__
20533 - name: routing-instance-id
20535 description: Unique id of routing instance
20538 example: __ROUTING-INSTANCE-ID__
20539 - name: site-pair-id
20541 description: unique identifier of probe
20544 example: __SITE-PAIR-ID__
20547 description: unique identifier of probe
20553 description: class-of-service object that needs to be created or updated.
20556 $ref: "#/patchDefinitions/class-of-service"
20560 summary: delete an existing class-of-service
20561 description: delete an existing class-of-service
20562 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
20571 description: Response codes found in [response codes](https://wiki.onap.org/).
20573 - name: site-pair-set-id
20575 description: Unique id of site pair set.
20578 example: __SITE-PAIR-SET-ID__
20579 - name: routing-instance-id
20581 description: Unique id of routing instance
20584 example: __ROUTING-INSTANCE-ID__
20585 - name: site-pair-id
20587 description: unique identifier of probe
20590 example: __SITE-PAIR-ID__
20593 description: unique identifier of probe
20597 - name: resource-version
20599 description: resource-version for concurrency
20602 /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:
20606 summary: returns classes-of-service
20607 description: returns classes-of-service
20608 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService
20614 description: successful operation
20616 $ref: "#/getDefinitions/classes-of-service"
20618 description: Response codes found in [response codes](https://wiki.onap.org/).
20620 - name: site-pair-set-id
20622 description: Unique id of site pair set.
20625 example: __SITE-PAIR-SET-ID__
20626 - name: routing-instance-id
20628 description: Unique id of routing instance
20631 example: __ROUTING-INSTANCE-ID__
20632 - name: site-pair-id
20634 description: unique identifier of probe
20637 example: __SITE-PAIR-ID__
20638 /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:
20642 summary: see node definition for valid relationships
20643 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
20652 description: Response codes found in [response codes](https://wiki.onap.org/).
20654 - name: site-pair-set-id
20656 description: Unique id of site pair set.
20659 example: __SITE-PAIR-SET-ID__
20660 - name: routing-instance-id
20662 description: Unique id of routing instance
20665 example: __ROUTING-INSTANCE-ID__
20666 - name: site-pair-id
20668 description: unique identifier of probe
20671 example: __SITE-PAIR-ID__
20674 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
20677 $ref: "#/definitions/relationship"
20681 summary: delete an existing relationship
20682 description: delete an existing relationship
20683 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
20692 description: Response codes found in [response codes](https://wiki.onap.org/).
20694 - name: site-pair-set-id
20696 description: Unique id of site pair set.
20699 example: __SITE-PAIR-SET-ID__
20700 - name: routing-instance-id
20702 description: Unique id of routing instance
20705 example: __ROUTING-INSTANCE-ID__
20706 - name: site-pair-id
20708 description: unique identifier of probe
20711 example: __SITE-PAIR-ID__
20712 /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}:
20716 summary: returns site-pair
20717 description: returns site-pair
20718 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
20724 description: successful operation
20726 $ref: "#/getDefinitions/site-pair"
20728 description: Response codes found in [response codes](https://wiki.onap.org/).
20730 - name: site-pair-set-id
20732 description: Unique id of site pair set.
20735 example: __SITE-PAIR-SET-ID__
20736 - name: routing-instance-id
20738 description: Unique id of routing instance
20741 example: __ROUTING-INSTANCE-ID__
20742 - name: site-pair-id
20744 description: unique identifier of probe
20747 example: __SITE-PAIR-ID__
20751 summary: create or update an existing site-pair
20753 Create or update an existing site-pair.
20755 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20756 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
20765 description: Response codes found in [response codes](https://wiki.onap.org/).
20767 - name: site-pair-set-id
20769 description: Unique id of site pair set.
20772 example: __SITE-PAIR-SET-ID__
20773 - name: routing-instance-id
20775 description: Unique id of routing instance
20778 example: __ROUTING-INSTANCE-ID__
20779 - name: site-pair-id
20781 description: unique identifier of probe
20784 example: __SITE-PAIR-ID__
20787 description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
20790 $ref: "#/definitions/site-pair"
20794 summary: update an existing site-pair
20796 Update an existing site-pair
20798 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20799 The PUT operation will entirely replace an existing object.
20800 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20802 Other differences between PUT and PATCH are:
20804 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20805 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20806 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20807 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
20816 description: Response codes found in [response codes](https://wiki.onap.org/).
20818 - name: site-pair-set-id
20820 description: Unique id of site pair set.
20823 example: __SITE-PAIR-SET-ID__
20824 - name: routing-instance-id
20826 description: Unique id of routing instance
20829 example: __ROUTING-INSTANCE-ID__
20830 - name: site-pair-id
20832 description: unique identifier of probe
20835 example: __SITE-PAIR-ID__
20838 description: site-pair object that needs to be created or updated.
20841 $ref: "#/patchDefinitions/site-pair"
20845 summary: delete an existing site-pair
20846 description: delete an existing site-pair
20847 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
20856 description: Response codes found in [response codes](https://wiki.onap.org/).
20858 - name: site-pair-set-id
20860 description: Unique id of site pair set.
20863 example: __SITE-PAIR-SET-ID__
20864 - name: routing-instance-id
20866 description: Unique id of routing instance
20869 example: __ROUTING-INSTANCE-ID__
20870 - name: site-pair-id
20872 description: unique identifier of probe
20875 example: __SITE-PAIR-ID__
20876 - name: resource-version
20878 description: resource-version for concurrency
20881 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs:
20885 summary: returns site-pairs
20886 description: returns site-pairs
20887 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs
20893 description: successful operation
20895 $ref: "#/getDefinitions/site-pairs"
20897 description: Response codes found in [response codes](https://wiki.onap.org/).
20899 - name: site-pair-set-id
20901 description: Unique id of site pair set.
20904 example: __SITE-PAIR-SET-ID__
20905 - name: routing-instance-id
20907 description: Unique id of routing instance
20910 example: __ROUTING-INSTANCE-ID__
20911 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship:
20915 summary: see node definition for valid relationships
20916 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
20925 description: Response codes found in [response codes](https://wiki.onap.org/).
20927 - name: site-pair-set-id
20929 description: Unique id of site pair set.
20932 example: __SITE-PAIR-SET-ID__
20933 - name: routing-instance-id
20935 description: Unique id of routing instance
20938 example: __ROUTING-INSTANCE-ID__
20941 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
20944 $ref: "#/definitions/relationship"
20948 summary: delete an existing relationship
20949 description: delete an existing relationship
20950 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
20959 description: Response codes found in [response codes](https://wiki.onap.org/).
20961 - name: site-pair-set-id
20963 description: Unique id of site pair set.
20966 example: __SITE-PAIR-SET-ID__
20967 - name: routing-instance-id
20969 description: Unique id of routing instance
20972 example: __ROUTING-INSTANCE-ID__
20973 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}:
20977 summary: returns routing-instance
20978 description: returns routing-instance
20979 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
20985 description: successful operation
20987 $ref: "#/getDefinitions/routing-instance"
20989 description: Response codes found in [response codes](https://wiki.onap.org/).
20991 - name: site-pair-set-id
20993 description: Unique id of site pair set.
20996 example: __SITE-PAIR-SET-ID__
20997 - name: routing-instance-id
20999 description: Unique id of routing instance
21002 example: __ROUTING-INSTANCE-ID__
21006 summary: create or update an existing routing-instance
21008 Create or update an existing routing-instance.
21010 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21011 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
21020 description: Response codes found in [response codes](https://wiki.onap.org/).
21022 - name: site-pair-set-id
21024 description: Unique id of site pair set.
21027 example: __SITE-PAIR-SET-ID__
21028 - name: routing-instance-id
21030 description: Unique id of routing instance
21033 example: __ROUTING-INSTANCE-ID__
21036 description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
21039 $ref: "#/definitions/routing-instance"
21043 summary: update an existing routing-instance
21045 Update an existing routing-instance
21047 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21048 The PUT operation will entirely replace an existing object.
21049 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21051 Other differences between PUT and PATCH are:
21053 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21054 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21055 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21056 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
21065 description: Response codes found in [response codes](https://wiki.onap.org/).
21067 - name: site-pair-set-id
21069 description: Unique id of site pair set.
21072 example: __SITE-PAIR-SET-ID__
21073 - name: routing-instance-id
21075 description: Unique id of routing instance
21078 example: __ROUTING-INSTANCE-ID__
21081 description: routing-instance object that needs to be created or updated.
21084 $ref: "#/patchDefinitions/routing-instance"
21088 summary: delete an existing routing-instance
21089 description: delete an existing routing-instance
21090 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
21099 description: Response codes found in [response codes](https://wiki.onap.org/).
21101 - name: site-pair-set-id
21103 description: Unique id of site pair set.
21106 example: __SITE-PAIR-SET-ID__
21107 - name: routing-instance-id
21109 description: Unique id of routing instance
21112 example: __ROUTING-INSTANCE-ID__
21113 - name: resource-version
21115 description: resource-version for concurrency
21118 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances:
21122 summary: returns routing-instances
21123 description: returns routing-instances
21124 operationId: getNetworkSitePairSetsSitePairSetRoutingInstances
21130 description: successful operation
21132 $ref: "#/getDefinitions/routing-instances"
21134 description: Response codes found in [response codes](https://wiki.onap.org/).
21136 - name: site-pair-set-id
21138 description: Unique id of site pair set.
21141 example: __SITE-PAIR-SET-ID__
21142 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship:
21146 summary: see node definition for valid relationships
21147 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship
21156 description: Response codes found in [response codes](https://wiki.onap.org/).
21158 - name: site-pair-set-id
21160 description: Unique id of site pair set.
21163 example: __SITE-PAIR-SET-ID__
21166 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSet.json)
21169 $ref: "#/definitions/relationship"
21173 summary: delete an existing relationship
21174 description: delete an existing relationship
21175 operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship
21184 description: Response codes found in [response codes](https://wiki.onap.org/).
21186 - name: site-pair-set-id
21188 description: Unique id of site pair set.
21191 example: __SITE-PAIR-SET-ID__
21192 /network/site-pair-sets/site-pair-set/{site-pair-set-id}:
21196 summary: returns site-pair-set
21197 description: returns site-pair-set
21198 operationId: getNetworkSitePairSetsSitePairSet
21204 description: successful operation
21206 $ref: "#/getDefinitions/site-pair-set"
21208 description: Response codes found in [response codes](https://wiki.onap.org/).
21210 - name: site-pair-set-id
21212 description: Unique id of site pair set.
21215 example: __SITE-PAIR-SET-ID__
21219 summary: create or update an existing site-pair-set
21221 Create or update an existing site-pair-set.
21223 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21224 operationId: createOrUpdateNetworkSitePairSetsSitePairSet
21233 description: Response codes found in [response codes](https://wiki.onap.org/).
21235 - name: site-pair-set-id
21237 description: Unique id of site pair set.
21240 example: __SITE-PAIR-SET-ID__
21243 description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSet.json)
21246 $ref: "#/definitions/site-pair-set"
21250 summary: update an existing site-pair-set
21252 Update an existing site-pair-set
21254 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21255 The PUT operation will entirely replace an existing object.
21256 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21258 Other differences between PUT and PATCH are:
21260 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21261 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21262 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21263 operationId: UpdateNetworkSitePairSetsSitePairSet
21272 description: Response codes found in [response codes](https://wiki.onap.org/).
21274 - name: site-pair-set-id
21276 description: Unique id of site pair set.
21279 example: __SITE-PAIR-SET-ID__
21282 description: site-pair-set object that needs to be created or updated.
21285 $ref: "#/patchDefinitions/site-pair-set"
21289 summary: delete an existing site-pair-set
21290 description: delete an existing site-pair-set
21291 operationId: deleteNetworkSitePairSetsSitePairSet
21300 description: Response codes found in [response codes](https://wiki.onap.org/).
21302 - name: site-pair-set-id
21304 description: Unique id of site pair set.
21307 example: __SITE-PAIR-SET-ID__
21308 - name: resource-version
21310 description: resource-version for concurrency
21313 /network/site-pair-sets:
21317 summary: returns site-pair-sets
21318 description: returns site-pair-sets
21319 operationId: getNetworkSitePairSets
21325 description: successful operation
21327 $ref: "#/getDefinitions/site-pair-sets"
21329 description: Response codes found in [response codes](https://wiki.onap.org/).
21330 /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship:
21334 summary: see node definition for valid relationships
21335 operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
21344 description: Response codes found in [response codes](https://wiki.onap.org/).
21348 description: VPN ID, globally unique within A&AI
21351 example: __VPN-ID__
21352 - name: global-route-target
21354 description: Number used to identify an RT, globally unique in the network
21357 example: __GLOBAL-ROUTE-TARGET__
21358 - name: route-target-role
21360 description: Role assigned to this route target
21363 example: __ROUTE-TARGET-ROLE__
21366 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
21369 $ref: "#/definitions/relationship"
21373 summary: delete an existing relationship
21374 description: delete an existing relationship
21375 operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
21384 description: Response codes found in [response codes](https://wiki.onap.org/).
21388 description: VPN ID, globally unique within A&AI
21391 example: __VPN-ID__
21392 - name: global-route-target
21394 description: Number used to identify an RT, globally unique in the network
21397 example: __GLOBAL-ROUTE-TARGET__
21398 - name: route-target-role
21400 description: Role assigned to this route target
21403 example: __ROUTE-TARGET-ROLE__
21404 /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}:
21408 summary: returns route-target
21409 description: returns route-target
21410 operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
21416 description: successful operation
21418 $ref: "#/getDefinitions/route-target"
21420 description: Response codes found in [response codes](https://wiki.onap.org/).
21424 description: VPN ID, globally unique within A&AI
21427 example: __VPN-ID__
21428 - name: global-route-target
21430 description: Number used to identify an RT, globally unique in the network
21433 example: __GLOBAL-ROUTE-TARGET__
21434 - name: route-target-role
21436 description: Role assigned to this route target
21439 example: __ROUTE-TARGET-ROLE__
21442 description: VPN Name
21447 description: Type of the vpn, should be taken from enumerated/valid values
21453 summary: create or update an existing route-target
21455 Create or update an existing route-target.
21457 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21458 operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
21467 description: Response codes found in [response codes](https://wiki.onap.org/).
21471 description: VPN ID, globally unique within A&AI
21474 example: __VPN-ID__
21475 - name: global-route-target
21477 description: Number used to identify an RT, globally unique in the network
21480 example: __GLOBAL-ROUTE-TARGET__
21481 - name: route-target-role
21483 description: Role assigned to this route target
21486 example: __ROUTE-TARGET-ROLE__
21489 description: route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
21492 $ref: "#/definitions/route-target"
21496 summary: update an existing route-target
21498 Update an existing route-target
21500 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21501 The PUT operation will entirely replace an existing object.
21502 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21504 Other differences between PUT and PATCH are:
21506 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21507 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21508 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21509 operationId: UpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
21518 description: Response codes found in [response codes](https://wiki.onap.org/).
21522 description: VPN ID, globally unique within A&AI
21525 example: __VPN-ID__
21526 - name: global-route-target
21528 description: Number used to identify an RT, globally unique in the network
21531 example: __GLOBAL-ROUTE-TARGET__
21532 - name: route-target-role
21534 description: Role assigned to this route target
21537 example: __ROUTE-TARGET-ROLE__
21540 description: route-target object that needs to be created or updated.
21543 $ref: "#/patchDefinitions/route-target"
21547 summary: delete an existing route-target
21548 description: delete an existing route-target
21549 operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
21558 description: Response codes found in [response codes](https://wiki.onap.org/).
21562 description: VPN ID, globally unique within A&AI
21565 example: __VPN-ID__
21566 - name: global-route-target
21568 description: Number used to identify an RT, globally unique in the network
21571 example: __GLOBAL-ROUTE-TARGET__
21572 - name: route-target-role
21574 description: Role assigned to this route target
21577 example: __ROUTE-TARGET-ROLE__
21578 - name: resource-version
21580 description: resource-version for concurrency
21583 /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets:
21587 summary: returns route-targets
21588 description: returns route-targets
21589 operationId: getNetworkVpnBindingsVpnBindingRouteTargets
21595 description: successful operation
21597 $ref: "#/getDefinitions/route-targets"
21599 description: Response codes found in [response codes](https://wiki.onap.org/).
21603 description: VPN ID, globally unique within A&AI
21606 example: __VPN-ID__
21609 description: VPN Name
21614 description: Type of the vpn, should be taken from enumerated/valid values
21617 /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship:
21621 summary: see node definition for valid relationships
21622 operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship
21631 description: Response codes found in [response codes](https://wiki.onap.org/).
21635 description: VPN ID, globally unique within A&AI
21638 example: __VPN-ID__
21641 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVpnBindingsVpnBinding.json)
21644 $ref: "#/definitions/relationship"
21648 summary: delete an existing relationship
21649 description: delete an existing relationship
21650 operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship
21659 description: Response codes found in [response codes](https://wiki.onap.org/).
21663 description: VPN ID, globally unique within A&AI
21666 example: __VPN-ID__
21667 /network/vpn-bindings/vpn-binding/{vpn-id}:
21671 summary: returns vpn-binding
21672 description: returns vpn-binding
21673 operationId: getNetworkVpnBindingsVpnBinding
21679 description: successful operation
21681 $ref: "#/getDefinitions/vpn-binding"
21683 description: Response codes found in [response codes](https://wiki.onap.org/).
21687 description: VPN ID, globally unique within A&AI
21690 example: __VPN-ID__
21693 description: VPN Name
21698 description: Type of the vpn, should be taken from enumerated/valid values
21704 summary: create or update an existing vpn-binding
21706 Create or update an existing vpn-binding.
21708 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21709 operationId: createOrUpdateNetworkVpnBindingsVpnBinding
21718 description: Response codes found in [response codes](https://wiki.onap.org/).
21722 description: VPN ID, globally unique within A&AI
21725 example: __VPN-ID__
21728 description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVpnBindingsVpnBinding.json)
21731 $ref: "#/definitions/vpn-binding"
21735 summary: update an existing vpn-binding
21737 Update an existing vpn-binding
21739 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21740 The PUT operation will entirely replace an existing object.
21741 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21743 Other differences between PUT and PATCH are:
21745 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21746 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21747 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21748 operationId: UpdateNetworkVpnBindingsVpnBinding
21757 description: Response codes found in [response codes](https://wiki.onap.org/).
21761 description: VPN ID, globally unique within A&AI
21764 example: __VPN-ID__
21767 description: vpn-binding object that needs to be created or updated.
21770 $ref: "#/patchDefinitions/vpn-binding"
21774 summary: delete an existing vpn-binding
21775 description: delete an existing vpn-binding
21776 operationId: deleteNetworkVpnBindingsVpnBinding
21785 description: Response codes found in [response codes](https://wiki.onap.org/).
21789 description: VPN ID, globally unique within A&AI
21792 example: __VPN-ID__
21793 - name: resource-version
21795 description: resource-version for concurrency
21798 /network/vpn-bindings:
21802 summary: returns vpn-bindings
21803 description: returns vpn-bindings
21804 operationId: getNetworkVpnBindings
21810 description: successful operation
21812 $ref: "#/getDefinitions/vpn-bindings"
21814 description: Response codes found in [response codes](https://wiki.onap.org/).
21815 /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
21819 summary: see node definition for valid relationships
21820 operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship
21829 description: Response codes found in [response codes](https://wiki.onap.org/).
21831 - name: equipment-name
21835 example: __EQUIPMENT-NAME__
21838 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPe.json)
21841 $ref: "#/definitions/relationship"
21845 summary: delete an existing relationship
21846 description: delete an existing relationship
21847 operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship
21856 description: Response codes found in [response codes](https://wiki.onap.org/).
21858 - name: equipment-name
21862 example: __EQUIPMENT-NAME__
21863 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
21867 summary: see node definition for valid relationships
21868 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
21877 description: Response codes found in [response codes](https://wiki.onap.org/).
21879 - name: equipment-name
21883 example: __EQUIPMENT-NAME__
21884 - name: interface-name
21886 description: Name that identifies the physical interface
21889 example: __INTERFACE-NAME__
21892 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterface.json)
21895 $ref: "#/definitions/relationship"
21899 summary: delete an existing relationship
21900 description: delete an existing relationship
21901 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
21910 description: Response codes found in [response codes](https://wiki.onap.org/).
21912 - name: equipment-name
21916 example: __EQUIPMENT-NAME__
21917 - name: interface-name
21919 description: Name that identifies the physical interface
21922 example: __INTERFACE-NAME__
21923 /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:
21927 summary: see node definition for valid relationships
21928 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
21937 description: Response codes found in [response codes](https://wiki.onap.org/).
21939 - name: equipment-name
21943 example: __EQUIPMENT-NAME__
21944 - name: interface-name
21946 description: Name that identifies the physical interface
21949 example: __INTERFACE-NAME__
21950 - name: interface-name
21952 description: Name given to the interface
21955 example: __INTERFACE-NAME__
21956 - name: vlan-interface
21958 description: String that identifies the interface
21961 example: __VLAN-INTERFACE__
21964 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
21967 $ref: "#/definitions/relationship"
21971 summary: delete an existing relationship
21972 description: delete an existing relationship
21973 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
21982 description: Response codes found in [response codes](https://wiki.onap.org/).
21984 - name: equipment-name
21988 example: __EQUIPMENT-NAME__
21989 - name: interface-name
21991 description: Name that identifies the physical interface
21994 example: __INTERFACE-NAME__
21995 - name: interface-name
21997 description: Name given to the interface
22000 example: __INTERFACE-NAME__
22001 - name: vlan-interface
22003 description: String that identifies the interface
22006 example: __VLAN-INTERFACE__
22007 /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:
22011 summary: see node definition for valid relationships
22012 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
22021 description: Response codes found in [response codes](https://wiki.onap.org/).
22023 - name: equipment-name
22027 example: __EQUIPMENT-NAME__
22028 - name: interface-name
22030 description: Name that identifies the physical interface
22033 example: __INTERFACE-NAME__
22034 - name: interface-name
22036 description: Name given to the interface
22039 example: __INTERFACE-NAME__
22040 - name: vlan-interface
22042 description: String that identifies the interface
22045 example: __VLAN-INTERFACE__
22046 - name: l3-interface-ipv4-address
22048 description: IP address
22051 example: __L3-INTERFACE-IPV4-ADDRESS__
22054 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
22057 $ref: "#/definitions/relationship"
22061 summary: delete an existing relationship
22062 description: delete an existing relationship
22063 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
22072 description: Response codes found in [response codes](https://wiki.onap.org/).
22074 - name: equipment-name
22078 example: __EQUIPMENT-NAME__
22079 - name: interface-name
22081 description: Name that identifies the physical interface
22084 example: __INTERFACE-NAME__
22085 - name: interface-name
22087 description: Name given to the interface
22090 example: __INTERFACE-NAME__
22091 - name: vlan-interface
22093 description: String that identifies the interface
22096 example: __VLAN-INTERFACE__
22097 - name: l3-interface-ipv4-address
22099 description: IP address
22102 example: __L3-INTERFACE-IPV4-ADDRESS__
22103 /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}:
22107 summary: returns l3-interface-ipv4-address-list
22108 description: returns l3-interface-ipv4-address-list
22109 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22115 description: successful operation
22117 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
22119 description: Response codes found in [response codes](https://wiki.onap.org/).
22121 - name: equipment-name
22125 example: __EQUIPMENT-NAME__
22126 - name: interface-name
22128 description: Name that identifies the physical interface
22131 example: __INTERFACE-NAME__
22132 - name: interface-name
22134 description: Name given to the interface
22137 example: __INTERFACE-NAME__
22138 - name: vlan-interface
22140 description: String that identifies the interface
22143 example: __VLAN-INTERFACE__
22144 - name: l3-interface-ipv4-address
22146 description: IP address
22149 example: __L3-INTERFACE-IPV4-ADDRESS__
22150 - name: prov-status
22152 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22155 - name: prov-status
22157 description: Trigger for operational monitoring of this resource by Service Assurance systems.
22160 - name: interface-id
22162 description: ID of interface
22167 description: MAC address for the interface
22170 - name: network-name
22172 description: Name of the network
22175 - name: vlan-id-inner
22177 description: Inner VLAN tag
22183 description: This indicates the customers VPN ID associated with this vlan
22186 - name: vlan-id-inner
22188 description: Inner VLAN tag
22192 - name: neutron-network-id
22194 description: Neutron network id of the interface that address belongs to
22197 - name: neutron-subnet-id
22199 description: Neutron id of subnet that address belongs to
22205 summary: create or update an existing l3-interface-ipv4-address-list
22207 Create or update an existing l3-interface-ipv4-address-list.
22209 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22210 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22219 description: Response codes found in [response codes](https://wiki.onap.org/).
22221 - name: equipment-name
22225 example: __EQUIPMENT-NAME__
22226 - name: interface-name
22228 description: Name that identifies the physical interface
22231 example: __INTERFACE-NAME__
22232 - name: interface-name
22234 description: Name given to the interface
22237 example: __INTERFACE-NAME__
22238 - name: vlan-interface
22240 description: String that identifies the interface
22243 example: __VLAN-INTERFACE__
22244 - name: l3-interface-ipv4-address
22246 description: IP address
22249 example: __L3-INTERFACE-IPV4-ADDRESS__
22252 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
22255 $ref: "#/definitions/l3-interface-ipv4-address-list"
22259 summary: update an existing l3-interface-ipv4-address-list
22261 Update an existing l3-interface-ipv4-address-list
22263 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22264 The PUT operation will entirely replace an existing object.
22265 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22267 Other differences between PUT and PATCH are:
22269 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22270 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22271 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22272 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22281 description: Response codes found in [response codes](https://wiki.onap.org/).
22283 - name: equipment-name
22287 example: __EQUIPMENT-NAME__
22288 - name: interface-name
22290 description: Name that identifies the physical interface
22293 example: __INTERFACE-NAME__
22294 - name: interface-name
22296 description: Name given to the interface
22299 example: __INTERFACE-NAME__
22300 - name: vlan-interface
22302 description: String that identifies the interface
22305 example: __VLAN-INTERFACE__
22306 - name: l3-interface-ipv4-address
22308 description: IP address
22311 example: __L3-INTERFACE-IPV4-ADDRESS__
22314 description: l3-interface-ipv4-address-list object that needs to be created or updated.
22317 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
22321 summary: delete an existing l3-interface-ipv4-address-list
22322 description: delete an existing l3-interface-ipv4-address-list
22323 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22332 description: Response codes found in [response codes](https://wiki.onap.org/).
22334 - name: equipment-name
22338 example: __EQUIPMENT-NAME__
22339 - name: interface-name
22341 description: Name that identifies the physical interface
22344 example: __INTERFACE-NAME__
22345 - name: interface-name
22347 description: Name given to the interface
22350 example: __INTERFACE-NAME__
22351 - name: vlan-interface
22353 description: String that identifies the interface
22356 example: __VLAN-INTERFACE__
22357 - name: l3-interface-ipv4-address
22359 description: IP address
22362 example: __L3-INTERFACE-IPV4-ADDRESS__
22363 - name: resource-version
22365 description: resource-version for concurrency
22368 /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:
22372 summary: see node definition for valid relationships
22373 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
22382 description: Response codes found in [response codes](https://wiki.onap.org/).
22384 - name: equipment-name
22388 example: __EQUIPMENT-NAME__
22389 - name: interface-name
22391 description: Name that identifies the physical interface
22394 example: __INTERFACE-NAME__
22395 - name: interface-name
22397 description: Name given to the interface
22400 example: __INTERFACE-NAME__
22401 - name: vlan-interface
22403 description: String that identifies the interface
22406 example: __VLAN-INTERFACE__
22407 - name: l3-interface-ipv6-address
22409 description: IP address
22412 example: __L3-INTERFACE-IPV6-ADDRESS__
22415 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
22418 $ref: "#/definitions/relationship"
22422 summary: delete an existing relationship
22423 description: delete an existing relationship
22424 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
22433 description: Response codes found in [response codes](https://wiki.onap.org/).
22435 - name: equipment-name
22439 example: __EQUIPMENT-NAME__
22440 - name: interface-name
22442 description: Name that identifies the physical interface
22445 example: __INTERFACE-NAME__
22446 - name: interface-name
22448 description: Name given to the interface
22451 example: __INTERFACE-NAME__
22452 - name: vlan-interface
22454 description: String that identifies the interface
22457 example: __VLAN-INTERFACE__
22458 - name: l3-interface-ipv6-address
22460 description: IP address
22463 example: __L3-INTERFACE-IPV6-ADDRESS__
22464 /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}:
22468 summary: returns l3-interface-ipv6-address-list
22469 description: returns l3-interface-ipv6-address-list
22470 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22476 description: successful operation
22478 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
22480 description: Response codes found in [response codes](https://wiki.onap.org/).
22482 - name: equipment-name
22486 example: __EQUIPMENT-NAME__
22487 - name: interface-name
22489 description: Name that identifies the physical interface
22492 example: __INTERFACE-NAME__
22493 - name: interface-name
22495 description: Name given to the interface
22498 example: __INTERFACE-NAME__
22499 - name: vlan-interface
22501 description: String that identifies the interface
22504 example: __VLAN-INTERFACE__
22505 - name: l3-interface-ipv6-address
22507 description: IP address
22510 example: __L3-INTERFACE-IPV6-ADDRESS__
22511 - name: prov-status
22513 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22516 - name: prov-status
22518 description: Trigger for operational monitoring of this resource by Service Assurance systems.
22521 - name: interface-id
22523 description: ID of interface
22528 description: MAC address for the interface
22531 - name: network-name
22533 description: Name of the network
22536 - name: vlan-id-inner
22538 description: Inner VLAN tag
22544 description: This indicates the customers VPN ID associated with this vlan
22547 - name: vlan-id-inner
22549 description: Inner VLAN tag
22553 - name: neutron-network-id
22555 description: Neutron network id of the interface that address belongs to
22558 - name: neutron-subnet-id
22560 description: Neutron id of subnet that address belongs to
22566 summary: create or update an existing l3-interface-ipv6-address-list
22568 Create or update an existing l3-interface-ipv6-address-list.
22570 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22571 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22580 description: Response codes found in [response codes](https://wiki.onap.org/).
22582 - name: equipment-name
22586 example: __EQUIPMENT-NAME__
22587 - name: interface-name
22589 description: Name that identifies the physical interface
22592 example: __INTERFACE-NAME__
22593 - name: interface-name
22595 description: Name given to the interface
22598 example: __INTERFACE-NAME__
22599 - name: vlan-interface
22601 description: String that identifies the interface
22604 example: __VLAN-INTERFACE__
22605 - name: l3-interface-ipv6-address
22607 description: IP address
22610 example: __L3-INTERFACE-IPV6-ADDRESS__
22613 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
22616 $ref: "#/definitions/l3-interface-ipv6-address-list"
22620 summary: update an existing l3-interface-ipv6-address-list
22622 Update an existing l3-interface-ipv6-address-list
22624 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22625 The PUT operation will entirely replace an existing object.
22626 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22628 Other differences between PUT and PATCH are:
22630 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22631 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22632 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22633 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22642 description: Response codes found in [response codes](https://wiki.onap.org/).
22644 - name: equipment-name
22648 example: __EQUIPMENT-NAME__
22649 - name: interface-name
22651 description: Name that identifies the physical interface
22654 example: __INTERFACE-NAME__
22655 - name: interface-name
22657 description: Name given to the interface
22660 example: __INTERFACE-NAME__
22661 - name: vlan-interface
22663 description: String that identifies the interface
22666 example: __VLAN-INTERFACE__
22667 - name: l3-interface-ipv6-address
22669 description: IP address
22672 example: __L3-INTERFACE-IPV6-ADDRESS__
22675 description: l3-interface-ipv6-address-list object that needs to be created or updated.
22678 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
22682 summary: delete an existing l3-interface-ipv6-address-list
22683 description: delete an existing l3-interface-ipv6-address-list
22684 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22693 description: Response codes found in [response codes](https://wiki.onap.org/).
22695 - name: equipment-name
22699 example: __EQUIPMENT-NAME__
22700 - name: interface-name
22702 description: Name that identifies the physical interface
22705 example: __INTERFACE-NAME__
22706 - name: interface-name
22708 description: Name given to the interface
22711 example: __INTERFACE-NAME__
22712 - name: vlan-interface
22714 description: String that identifies the interface
22717 example: __VLAN-INTERFACE__
22718 - name: l3-interface-ipv6-address
22720 description: IP address
22723 example: __L3-INTERFACE-IPV6-ADDRESS__
22724 - name: resource-version
22726 description: resource-version for concurrency
22729 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
22733 summary: returns vlan
22734 description: returns vlan
22735 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
22741 description: successful operation
22743 $ref: "#/getDefinitions/vlan"
22745 description: Response codes found in [response codes](https://wiki.onap.org/).
22747 - name: equipment-name
22751 example: __EQUIPMENT-NAME__
22752 - name: interface-name
22754 description: Name that identifies the physical interface
22757 example: __INTERFACE-NAME__
22758 - name: interface-name
22760 description: Name given to the interface
22763 example: __INTERFACE-NAME__
22764 - name: vlan-interface
22766 description: String that identifies the interface
22769 example: __VLAN-INTERFACE__
22770 - name: prov-status
22772 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22775 - name: prov-status
22777 description: Trigger for operational monitoring of this resource by Service Assurance systems.
22780 - name: interface-id
22782 description: ID of interface
22787 description: MAC address for the interface
22790 - name: network-name
22792 description: Name of the network
22795 - name: vlan-id-inner
22797 description: Inner VLAN tag
22803 description: This indicates the customers VPN ID associated with this vlan
22809 summary: create or update an existing vlan
22811 Create or update an existing vlan.
22813 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22814 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
22823 description: Response codes found in [response codes](https://wiki.onap.org/).
22825 - name: equipment-name
22829 example: __EQUIPMENT-NAME__
22830 - name: interface-name
22832 description: Name that identifies the physical interface
22835 example: __INTERFACE-NAME__
22836 - name: interface-name
22838 description: Name given to the interface
22841 example: __INTERFACE-NAME__
22842 - name: vlan-interface
22844 description: String that identifies the interface
22847 example: __VLAN-INTERFACE__
22850 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
22853 $ref: "#/definitions/vlan"
22857 summary: update an existing vlan
22859 Update an existing vlan
22861 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22862 The PUT operation will entirely replace an existing object.
22863 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22865 Other differences between PUT and PATCH are:
22867 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22868 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22869 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22870 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
22879 description: Response codes found in [response codes](https://wiki.onap.org/).
22881 - name: equipment-name
22885 example: __EQUIPMENT-NAME__
22886 - name: interface-name
22888 description: Name that identifies the physical interface
22891 example: __INTERFACE-NAME__
22892 - name: interface-name
22894 description: Name given to the interface
22897 example: __INTERFACE-NAME__
22898 - name: vlan-interface
22900 description: String that identifies the interface
22903 example: __VLAN-INTERFACE__
22906 description: vlan object that needs to be created or updated.
22909 $ref: "#/patchDefinitions/vlan"
22913 summary: delete an existing vlan
22914 description: delete an existing vlan
22915 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
22924 description: Response codes found in [response codes](https://wiki.onap.org/).
22926 - name: equipment-name
22930 example: __EQUIPMENT-NAME__
22931 - name: interface-name
22933 description: Name that identifies the physical interface
22936 example: __INTERFACE-NAME__
22937 - name: interface-name
22939 description: Name given to the interface
22942 example: __INTERFACE-NAME__
22943 - name: vlan-interface
22945 description: String that identifies the interface
22948 example: __VLAN-INTERFACE__
22949 - name: resource-version
22951 description: resource-version for concurrency
22954 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
22958 summary: returns vlans
22959 description: returns vlans
22960 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans
22966 description: successful operation
22968 $ref: "#/getDefinitions/vlans"
22970 description: Response codes found in [response codes](https://wiki.onap.org/).
22972 - name: equipment-name
22976 example: __EQUIPMENT-NAME__
22977 - name: interface-name
22979 description: Name that identifies the physical interface
22982 example: __INTERFACE-NAME__
22983 - name: interface-name
22985 description: Name given to the interface
22988 example: __INTERFACE-NAME__
22989 - name: prov-status
22991 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22994 - name: prov-status
22996 description: Trigger for operational monitoring of this resource by Service Assurance systems.
22999 - name: interface-id
23001 description: ID of interface
23006 description: MAC address for the interface
23009 - name: network-name
23011 description: Name of the network
23014 /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:
23018 summary: see node definition for valid relationships
23019 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
23028 description: Response codes found in [response codes](https://wiki.onap.org/).
23030 - name: equipment-name
23034 example: __EQUIPMENT-NAME__
23035 - name: interface-name
23037 description: Name that identifies the physical interface
23040 example: __INTERFACE-NAME__
23041 - name: interface-name
23043 description: Name given to the interface
23046 example: __INTERFACE-NAME__
23049 description: PCI ID used to identify the sriov-vf
23052 example: __PCI-ID__
23055 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
23058 $ref: "#/definitions/relationship"
23062 summary: delete an existing relationship
23063 description: delete an existing relationship
23064 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
23073 description: Response codes found in [response codes](https://wiki.onap.org/).
23075 - name: equipment-name
23079 example: __EQUIPMENT-NAME__
23080 - name: interface-name
23082 description: Name that identifies the physical interface
23085 example: __INTERFACE-NAME__
23086 - name: interface-name
23088 description: Name given to the interface
23091 example: __INTERFACE-NAME__
23094 description: PCI ID used to identify the sriov-vf
23097 example: __PCI-ID__
23098 /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}:
23102 summary: returns sriov-vf
23103 description: returns sriov-vf
23104 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
23110 description: successful operation
23112 $ref: "#/getDefinitions/sriov-vf"
23114 description: Response codes found in [response codes](https://wiki.onap.org/).
23116 - name: equipment-name
23120 example: __EQUIPMENT-NAME__
23121 - name: interface-name
23123 description: Name that identifies the physical interface
23126 example: __INTERFACE-NAME__
23127 - name: interface-name
23129 description: Name given to the interface
23132 example: __INTERFACE-NAME__
23135 description: PCI ID used to identify the sriov-vf
23138 example: __PCI-ID__
23139 - name: prov-status
23141 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
23144 - name: prov-status
23146 description: Trigger for operational monitoring of this resource by Service Assurance systems.
23149 - name: interface-id
23151 description: ID of interface
23156 description: MAC address for the interface
23159 - name: network-name
23161 description: Name of the network
23164 - name: vf-vlan-filter
23166 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
23169 - name: vf-mac-filter
23171 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
23174 - name: vf-vlan-strip
23176 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
23179 - name: neutron-network-id
23181 description: Neutron network id of the interface
23187 summary: create or update an existing sriov-vf
23189 Create or update an existing sriov-vf.
23191 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23192 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
23201 description: Response codes found in [response codes](https://wiki.onap.org/).
23203 - name: equipment-name
23207 example: __EQUIPMENT-NAME__
23208 - name: interface-name
23210 description: Name that identifies the physical interface
23213 example: __INTERFACE-NAME__
23214 - name: interface-name
23216 description: Name given to the interface
23219 example: __INTERFACE-NAME__
23222 description: PCI ID used to identify the sriov-vf
23225 example: __PCI-ID__
23228 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
23231 $ref: "#/definitions/sriov-vf"
23235 summary: update an existing sriov-vf
23237 Update an existing sriov-vf
23239 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23240 The PUT operation will entirely replace an existing object.
23241 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23243 Other differences between PUT and PATCH are:
23245 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23246 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23247 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23248 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
23257 description: Response codes found in [response codes](https://wiki.onap.org/).
23259 - name: equipment-name
23263 example: __EQUIPMENT-NAME__
23264 - name: interface-name
23266 description: Name that identifies the physical interface
23269 example: __INTERFACE-NAME__
23270 - name: interface-name
23272 description: Name given to the interface
23275 example: __INTERFACE-NAME__
23278 description: PCI ID used to identify the sriov-vf
23281 example: __PCI-ID__
23284 description: sriov-vf object that needs to be created or updated.
23287 $ref: "#/patchDefinitions/sriov-vf"
23291 summary: delete an existing sriov-vf
23292 description: delete an existing sriov-vf
23293 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
23302 description: Response codes found in [response codes](https://wiki.onap.org/).
23304 - name: equipment-name
23308 example: __EQUIPMENT-NAME__
23309 - name: interface-name
23311 description: Name that identifies the physical interface
23314 example: __INTERFACE-NAME__
23315 - name: interface-name
23317 description: Name given to the interface
23320 example: __INTERFACE-NAME__
23323 description: PCI ID used to identify the sriov-vf
23326 example: __PCI-ID__
23327 - name: resource-version
23329 description: resource-version for concurrency
23332 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
23336 summary: returns sriov-vfs
23337 description: returns sriov-vfs
23338 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
23344 description: successful operation
23346 $ref: "#/getDefinitions/sriov-vfs"
23348 description: Response codes found in [response codes](https://wiki.onap.org/).
23350 - name: equipment-name
23354 example: __EQUIPMENT-NAME__
23355 - name: interface-name
23357 description: Name that identifies the physical interface
23360 example: __INTERFACE-NAME__
23361 - name: interface-name
23363 description: Name given to the interface
23366 example: __INTERFACE-NAME__
23367 - name: prov-status
23369 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
23372 - name: prov-status
23374 description: Trigger for operational monitoring of this resource by Service Assurance systems.
23377 - name: interface-id
23379 description: ID of interface
23384 description: MAC address for the interface
23387 - name: network-name
23389 description: Name of the network
23392 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
23396 summary: see node definition for valid relationships
23397 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
23406 description: Response codes found in [response codes](https://wiki.onap.org/).
23408 - name: equipment-name
23412 example: __EQUIPMENT-NAME__
23413 - name: interface-name
23415 description: Name that identifies the physical interface
23418 example: __INTERFACE-NAME__
23419 - name: interface-name
23421 description: Name given to the interface
23424 example: __INTERFACE-NAME__
23427 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
23430 $ref: "#/definitions/relationship"
23434 summary: delete an existing relationship
23435 description: delete an existing relationship
23436 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
23445 description: Response codes found in [response codes](https://wiki.onap.org/).
23447 - name: equipment-name
23451 example: __EQUIPMENT-NAME__
23452 - name: interface-name
23454 description: Name that identifies the physical interface
23457 example: __INTERFACE-NAME__
23458 - name: interface-name
23460 description: Name given to the interface
23463 example: __INTERFACE-NAME__
23464 /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:
23468 summary: see node definition for valid relationships
23469 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
23478 description: Response codes found in [response codes](https://wiki.onap.org/).
23480 - name: equipment-name
23484 example: __EQUIPMENT-NAME__
23485 - name: interface-name
23487 description: Name that identifies the physical interface
23490 example: __INTERFACE-NAME__
23491 - name: interface-name
23493 description: Name given to the interface
23496 example: __INTERFACE-NAME__
23497 - name: l3-interface-ipv4-address
23499 description: IP address
23502 example: __L3-INTERFACE-IPV4-ADDRESS__
23505 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
23508 $ref: "#/definitions/relationship"
23512 summary: delete an existing relationship
23513 description: delete an existing relationship
23514 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
23523 description: Response codes found in [response codes](https://wiki.onap.org/).
23525 - name: equipment-name
23529 example: __EQUIPMENT-NAME__
23530 - name: interface-name
23532 description: Name that identifies the physical interface
23535 example: __INTERFACE-NAME__
23536 - name: interface-name
23538 description: Name given to the interface
23541 example: __INTERFACE-NAME__
23542 - name: l3-interface-ipv4-address
23544 description: IP address
23547 example: __L3-INTERFACE-IPV4-ADDRESS__
23548 /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}:
23552 summary: returns l3-interface-ipv4-address-list
23553 description: returns l3-interface-ipv4-address-list
23554 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23560 description: successful operation
23562 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
23564 description: Response codes found in [response codes](https://wiki.onap.org/).
23566 - name: equipment-name
23570 example: __EQUIPMENT-NAME__
23571 - name: interface-name
23573 description: Name that identifies the physical interface
23576 example: __INTERFACE-NAME__
23577 - name: interface-name
23579 description: Name given to the interface
23582 example: __INTERFACE-NAME__
23583 - name: l3-interface-ipv4-address
23585 description: IP address
23588 example: __L3-INTERFACE-IPV4-ADDRESS__
23589 - name: prov-status
23591 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
23594 - name: prov-status
23596 description: Trigger for operational monitoring of this resource by Service Assurance systems.
23599 - name: interface-id
23601 description: ID of interface
23606 description: MAC address for the interface
23609 - name: network-name
23611 description: Name of the network
23614 - name: vlan-id-inner
23616 description: Inner VLAN tag
23620 - name: neutron-network-id
23622 description: Neutron network id of the interface that address belongs to
23625 - name: neutron-subnet-id
23627 description: Neutron id of subnet that address belongs to
23633 summary: create or update an existing l3-interface-ipv4-address-list
23635 Create or update an existing l3-interface-ipv4-address-list.
23637 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23638 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23647 description: Response codes found in [response codes](https://wiki.onap.org/).
23649 - name: equipment-name
23653 example: __EQUIPMENT-NAME__
23654 - name: interface-name
23656 description: Name that identifies the physical interface
23659 example: __INTERFACE-NAME__
23660 - name: interface-name
23662 description: Name given to the interface
23665 example: __INTERFACE-NAME__
23666 - name: l3-interface-ipv4-address
23668 description: IP address
23671 example: __L3-INTERFACE-IPV4-ADDRESS__
23674 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
23677 $ref: "#/definitions/l3-interface-ipv4-address-list"
23681 summary: update an existing l3-interface-ipv4-address-list
23683 Update an existing l3-interface-ipv4-address-list
23685 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23686 The PUT operation will entirely replace an existing object.
23687 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23689 Other differences between PUT and PATCH are:
23691 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23692 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23693 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23694 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23703 description: Response codes found in [response codes](https://wiki.onap.org/).
23705 - name: equipment-name
23709 example: __EQUIPMENT-NAME__
23710 - name: interface-name
23712 description: Name that identifies the physical interface
23715 example: __INTERFACE-NAME__
23716 - name: interface-name
23718 description: Name given to the interface
23721 example: __INTERFACE-NAME__
23722 - name: l3-interface-ipv4-address
23724 description: IP address
23727 example: __L3-INTERFACE-IPV4-ADDRESS__
23730 description: l3-interface-ipv4-address-list object that needs to be created or updated.
23733 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
23737 summary: delete an existing l3-interface-ipv4-address-list
23738 description: delete an existing l3-interface-ipv4-address-list
23739 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23748 description: Response codes found in [response codes](https://wiki.onap.org/).
23750 - name: equipment-name
23754 example: __EQUIPMENT-NAME__
23755 - name: interface-name
23757 description: Name that identifies the physical interface
23760 example: __INTERFACE-NAME__
23761 - name: interface-name
23763 description: Name given to the interface
23766 example: __INTERFACE-NAME__
23767 - name: l3-interface-ipv4-address
23769 description: IP address
23772 example: __L3-INTERFACE-IPV4-ADDRESS__
23773 - name: resource-version
23775 description: resource-version for concurrency
23778 /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:
23782 summary: see node definition for valid relationships
23783 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
23792 description: Response codes found in [response codes](https://wiki.onap.org/).
23794 - name: equipment-name
23798 example: __EQUIPMENT-NAME__
23799 - name: interface-name
23801 description: Name that identifies the physical interface
23804 example: __INTERFACE-NAME__
23805 - name: interface-name
23807 description: Name given to the interface
23810 example: __INTERFACE-NAME__
23811 - name: l3-interface-ipv6-address
23813 description: IP address
23816 example: __L3-INTERFACE-IPV6-ADDRESS__
23819 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
23822 $ref: "#/definitions/relationship"
23826 summary: delete an existing relationship
23827 description: delete an existing relationship
23828 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
23837 description: Response codes found in [response codes](https://wiki.onap.org/).
23839 - name: equipment-name
23843 example: __EQUIPMENT-NAME__
23844 - name: interface-name
23846 description: Name that identifies the physical interface
23849 example: __INTERFACE-NAME__
23850 - name: interface-name
23852 description: Name given to the interface
23855 example: __INTERFACE-NAME__
23856 - name: l3-interface-ipv6-address
23858 description: IP address
23861 example: __L3-INTERFACE-IPV6-ADDRESS__
23862 /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}:
23866 summary: returns l3-interface-ipv6-address-list
23867 description: returns l3-interface-ipv6-address-list
23868 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23874 description: successful operation
23876 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
23878 description: Response codes found in [response codes](https://wiki.onap.org/).
23880 - name: equipment-name
23884 example: __EQUIPMENT-NAME__
23885 - name: interface-name
23887 description: Name that identifies the physical interface
23890 example: __INTERFACE-NAME__
23891 - name: interface-name
23893 description: Name given to the interface
23896 example: __INTERFACE-NAME__
23897 - name: l3-interface-ipv6-address
23899 description: IP address
23902 example: __L3-INTERFACE-IPV6-ADDRESS__
23903 - name: prov-status
23905 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
23908 - name: prov-status
23910 description: Trigger for operational monitoring of this resource by Service Assurance systems.
23913 - name: interface-id
23915 description: ID of interface
23920 description: MAC address for the interface
23923 - name: network-name
23925 description: Name of the network
23928 - name: vlan-id-inner
23930 description: Inner VLAN tag
23934 - name: neutron-network-id
23936 description: Neutron network id of the interface that address belongs to
23939 - name: neutron-subnet-id
23941 description: Neutron id of subnet that address belongs to
23947 summary: create or update an existing l3-interface-ipv6-address-list
23949 Create or update an existing l3-interface-ipv6-address-list.
23951 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23952 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23961 description: Response codes found in [response codes](https://wiki.onap.org/).
23963 - name: equipment-name
23967 example: __EQUIPMENT-NAME__
23968 - name: interface-name
23970 description: Name that identifies the physical interface
23973 example: __INTERFACE-NAME__
23974 - name: interface-name
23976 description: Name given to the interface
23979 example: __INTERFACE-NAME__
23980 - name: l3-interface-ipv6-address
23982 description: IP address
23985 example: __L3-INTERFACE-IPV6-ADDRESS__
23988 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
23991 $ref: "#/definitions/l3-interface-ipv6-address-list"
23995 summary: update an existing l3-interface-ipv6-address-list
23997 Update an existing l3-interface-ipv6-address-list
23999 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24000 The PUT operation will entirely replace an existing object.
24001 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24003 Other differences between PUT and PATCH are:
24005 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24006 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24007 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24008 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
24017 description: Response codes found in [response codes](https://wiki.onap.org/).
24019 - name: equipment-name
24023 example: __EQUIPMENT-NAME__
24024 - name: interface-name
24026 description: Name that identifies the physical interface
24029 example: __INTERFACE-NAME__
24030 - name: interface-name
24032 description: Name given to the interface
24035 example: __INTERFACE-NAME__
24036 - name: l3-interface-ipv6-address
24038 description: IP address
24041 example: __L3-INTERFACE-IPV6-ADDRESS__
24044 description: l3-interface-ipv6-address-list object that needs to be created or updated.
24047 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
24051 summary: delete an existing l3-interface-ipv6-address-list
24052 description: delete an existing l3-interface-ipv6-address-list
24053 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
24062 description: Response codes found in [response codes](https://wiki.onap.org/).
24064 - name: equipment-name
24068 example: __EQUIPMENT-NAME__
24069 - name: interface-name
24071 description: Name that identifies the physical interface
24074 example: __INTERFACE-NAME__
24075 - name: interface-name
24077 description: Name given to the interface
24080 example: __INTERFACE-NAME__
24081 - name: l3-interface-ipv6-address
24083 description: IP address
24086 example: __L3-INTERFACE-IPV6-ADDRESS__
24087 - name: resource-version
24089 description: resource-version for concurrency
24092 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
24096 summary: returns l-interface
24097 description: returns l-interface
24098 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
24104 description: successful operation
24106 $ref: "#/getDefinitions/l-interface"
24108 description: Response codes found in [response codes](https://wiki.onap.org/).
24110 - name: equipment-name
24114 example: __EQUIPMENT-NAME__
24115 - name: interface-name
24117 description: Name that identifies the physical interface
24120 example: __INTERFACE-NAME__
24121 - name: interface-name
24123 description: Name given to the interface
24126 example: __INTERFACE-NAME__
24127 - name: prov-status
24129 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24132 - name: prov-status
24134 description: Trigger for operational monitoring of this resource by Service Assurance systems.
24137 - name: interface-id
24139 description: ID of interface
24144 description: MAC address for the interface
24147 - name: network-name
24149 description: Name of the network
24155 summary: create or update an existing l-interface
24157 Create or update an existing l-interface.
24159 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24160 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
24169 description: Response codes found in [response codes](https://wiki.onap.org/).
24171 - name: equipment-name
24175 example: __EQUIPMENT-NAME__
24176 - name: interface-name
24178 description: Name that identifies the physical interface
24181 example: __INTERFACE-NAME__
24182 - name: interface-name
24184 description: Name given to the interface
24187 example: __INTERFACE-NAME__
24190 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
24193 $ref: "#/definitions/l-interface"
24197 summary: update an existing l-interface
24199 Update an existing l-interface
24201 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24202 The PUT operation will entirely replace an existing object.
24203 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24205 Other differences between PUT and PATCH are:
24207 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24208 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24209 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24210 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
24219 description: Response codes found in [response codes](https://wiki.onap.org/).
24221 - name: equipment-name
24225 example: __EQUIPMENT-NAME__
24226 - name: interface-name
24228 description: Name that identifies the physical interface
24231 example: __INTERFACE-NAME__
24232 - name: interface-name
24234 description: Name given to the interface
24237 example: __INTERFACE-NAME__
24240 description: l-interface object that needs to be created or updated.
24243 $ref: "#/patchDefinitions/l-interface"
24247 summary: delete an existing l-interface
24248 description: delete an existing l-interface
24249 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
24258 description: Response codes found in [response codes](https://wiki.onap.org/).
24260 - name: equipment-name
24264 example: __EQUIPMENT-NAME__
24265 - name: interface-name
24267 description: Name that identifies the physical interface
24270 example: __INTERFACE-NAME__
24271 - name: interface-name
24273 description: Name given to the interface
24276 example: __INTERFACE-NAME__
24277 - name: resource-version
24279 description: resource-version for concurrency
24282 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
24286 summary: returns l-interfaces
24287 description: returns l-interfaces
24288 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces
24294 description: successful operation
24296 $ref: "#/getDefinitions/l-interfaces"
24298 description: Response codes found in [response codes](https://wiki.onap.org/).
24300 - name: equipment-name
24304 example: __EQUIPMENT-NAME__
24305 - name: interface-name
24307 description: Name that identifies the physical interface
24310 example: __INTERFACE-NAME__
24311 - name: prov-status
24313 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24316 - name: prov-status
24318 description: Trigger for operational monitoring of this resource by Service Assurance systems.
24321 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}:
24325 summary: returns p-interface
24326 description: returns p-interface
24327 operationId: getNetworkVplsPesVplsPePInterfacesPInterface
24333 description: successful operation
24335 $ref: "#/getDefinitions/p-interface"
24337 description: Response codes found in [response codes](https://wiki.onap.org/).
24339 - name: equipment-name
24343 example: __EQUIPMENT-NAME__
24344 - name: interface-name
24346 description: Name that identifies the physical interface
24349 example: __INTERFACE-NAME__
24350 - name: prov-status
24352 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24355 - name: prov-status
24357 description: Trigger for operational monitoring of this resource by Service Assurance systems.
24363 summary: create or update an existing p-interface
24365 Create or update an existing p-interface.
24367 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24368 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface
24377 description: Response codes found in [response codes](https://wiki.onap.org/).
24379 - name: equipment-name
24383 example: __EQUIPMENT-NAME__
24384 - name: interface-name
24386 description: Name that identifies the physical interface
24389 example: __INTERFACE-NAME__
24392 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterface.json)
24395 $ref: "#/definitions/p-interface"
24399 summary: update an existing p-interface
24401 Update an existing p-interface
24403 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24404 The PUT operation will entirely replace an existing object.
24405 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24407 Other differences between PUT and PATCH are:
24409 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24410 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24411 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24412 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterface
24421 description: Response codes found in [response codes](https://wiki.onap.org/).
24423 - name: equipment-name
24427 example: __EQUIPMENT-NAME__
24428 - name: interface-name
24430 description: Name that identifies the physical interface
24433 example: __INTERFACE-NAME__
24436 description: p-interface object that needs to be created or updated.
24439 $ref: "#/patchDefinitions/p-interface"
24443 summary: delete an existing p-interface
24444 description: delete an existing p-interface
24445 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface
24454 description: Response codes found in [response codes](https://wiki.onap.org/).
24456 - name: equipment-name
24460 example: __EQUIPMENT-NAME__
24461 - name: interface-name
24463 description: Name that identifies the physical interface
24466 example: __INTERFACE-NAME__
24467 - name: resource-version
24469 description: resource-version for concurrency
24472 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces:
24476 summary: returns p-interfaces
24477 description: returns p-interfaces
24478 operationId: getNetworkVplsPesVplsPePInterfaces
24484 description: successful operation
24486 $ref: "#/getDefinitions/p-interfaces"
24488 description: Response codes found in [response codes](https://wiki.onap.org/).
24490 - name: equipment-name
24494 example: __EQUIPMENT-NAME__
24495 - name: prov-status
24497 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24500 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
24504 summary: see node definition for valid relationships
24505 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
24514 description: Response codes found in [response codes](https://wiki.onap.org/).
24516 - name: equipment-name
24520 example: __EQUIPMENT-NAME__
24521 - name: interface-name
24523 description: Name that identifies the link aggregate interface
24526 example: __INTERFACE-NAME__
24529 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
24532 $ref: "#/definitions/relationship"
24536 summary: delete an existing relationship
24537 description: delete an existing relationship
24538 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
24547 description: Response codes found in [response codes](https://wiki.onap.org/).
24549 - name: equipment-name
24553 example: __EQUIPMENT-NAME__
24554 - name: interface-name
24556 description: Name that identifies the link aggregate interface
24559 example: __INTERFACE-NAME__
24560 /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:
24564 summary: see node definition for valid relationships
24565 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
24574 description: Response codes found in [response codes](https://wiki.onap.org/).
24576 - name: equipment-name
24580 example: __EQUIPMENT-NAME__
24581 - name: interface-name
24583 description: Name that identifies the link aggregate interface
24586 example: __INTERFACE-NAME__
24587 - name: interface-name
24589 description: Name given to the interface
24592 example: __INTERFACE-NAME__
24593 - name: vlan-interface
24595 description: String that identifies the interface
24598 example: __VLAN-INTERFACE__
24601 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
24604 $ref: "#/definitions/relationship"
24608 summary: delete an existing relationship
24609 description: delete an existing relationship
24610 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
24619 description: Response codes found in [response codes](https://wiki.onap.org/).
24621 - name: equipment-name
24625 example: __EQUIPMENT-NAME__
24626 - name: interface-name
24628 description: Name that identifies the link aggregate interface
24631 example: __INTERFACE-NAME__
24632 - name: interface-name
24634 description: Name given to the interface
24637 example: __INTERFACE-NAME__
24638 - name: vlan-interface
24640 description: String that identifies the interface
24643 example: __VLAN-INTERFACE__
24644 /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:
24648 summary: see node definition for valid relationships
24649 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
24658 description: Response codes found in [response codes](https://wiki.onap.org/).
24660 - name: equipment-name
24664 example: __EQUIPMENT-NAME__
24665 - name: interface-name
24667 description: Name that identifies the link aggregate interface
24670 example: __INTERFACE-NAME__
24671 - name: interface-name
24673 description: Name given to the interface
24676 example: __INTERFACE-NAME__
24677 - name: vlan-interface
24679 description: String that identifies the interface
24682 example: __VLAN-INTERFACE__
24683 - name: l3-interface-ipv4-address
24685 description: IP address
24688 example: __L3-INTERFACE-IPV4-ADDRESS__
24691 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
24694 $ref: "#/definitions/relationship"
24698 summary: delete an existing relationship
24699 description: delete an existing relationship
24700 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
24709 description: Response codes found in [response codes](https://wiki.onap.org/).
24711 - name: equipment-name
24715 example: __EQUIPMENT-NAME__
24716 - name: interface-name
24718 description: Name that identifies the link aggregate interface
24721 example: __INTERFACE-NAME__
24722 - name: interface-name
24724 description: Name given to the interface
24727 example: __INTERFACE-NAME__
24728 - name: vlan-interface
24730 description: String that identifies the interface
24733 example: __VLAN-INTERFACE__
24734 - name: l3-interface-ipv4-address
24736 description: IP address
24739 example: __L3-INTERFACE-IPV4-ADDRESS__
24740 /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}:
24744 summary: returns l3-interface-ipv4-address-list
24745 description: returns l3-interface-ipv4-address-list
24746 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24752 description: successful operation
24754 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
24756 description: Response codes found in [response codes](https://wiki.onap.org/).
24758 - name: equipment-name
24762 example: __EQUIPMENT-NAME__
24763 - name: interface-name
24765 description: Name that identifies the link aggregate interface
24768 example: __INTERFACE-NAME__
24769 - name: interface-name
24771 description: Name given to the interface
24774 example: __INTERFACE-NAME__
24775 - name: vlan-interface
24777 description: String that identifies the interface
24780 example: __VLAN-INTERFACE__
24781 - name: l3-interface-ipv4-address
24783 description: IP address
24786 example: __L3-INTERFACE-IPV4-ADDRESS__
24787 - name: prov-status
24789 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24792 - name: interface-id
24794 description: ID of interface
24797 - name: interface-role
24799 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
24802 - name: interface-id
24804 description: ID of interface
24809 description: MAC address for the interface
24812 - name: network-name
24814 description: Name of the network
24817 - name: vlan-id-inner
24819 description: Inner VLAN tag
24825 description: This indicates the customers VPN ID associated with this vlan
24828 - name: vlan-id-inner
24830 description: Inner VLAN tag
24834 - name: neutron-network-id
24836 description: Neutron network id of the interface that address belongs to
24839 - name: neutron-subnet-id
24841 description: Neutron id of subnet that address belongs to
24847 summary: create or update an existing l3-interface-ipv4-address-list
24849 Create or update an existing l3-interface-ipv4-address-list.
24851 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24852 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24861 description: Response codes found in [response codes](https://wiki.onap.org/).
24863 - name: equipment-name
24867 example: __EQUIPMENT-NAME__
24868 - name: interface-name
24870 description: Name that identifies the link aggregate interface
24873 example: __INTERFACE-NAME__
24874 - name: interface-name
24876 description: Name given to the interface
24879 example: __INTERFACE-NAME__
24880 - name: vlan-interface
24882 description: String that identifies the interface
24885 example: __VLAN-INTERFACE__
24886 - name: l3-interface-ipv4-address
24888 description: IP address
24891 example: __L3-INTERFACE-IPV4-ADDRESS__
24894 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
24897 $ref: "#/definitions/l3-interface-ipv4-address-list"
24901 summary: update an existing l3-interface-ipv4-address-list
24903 Update an existing l3-interface-ipv4-address-list
24905 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24906 The PUT operation will entirely replace an existing object.
24907 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24909 Other differences between PUT and PATCH are:
24911 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24912 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24913 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24914 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24923 description: Response codes found in [response codes](https://wiki.onap.org/).
24925 - name: equipment-name
24929 example: __EQUIPMENT-NAME__
24930 - name: interface-name
24932 description: Name that identifies the link aggregate interface
24935 example: __INTERFACE-NAME__
24936 - name: interface-name
24938 description: Name given to the interface
24941 example: __INTERFACE-NAME__
24942 - name: vlan-interface
24944 description: String that identifies the interface
24947 example: __VLAN-INTERFACE__
24948 - name: l3-interface-ipv4-address
24950 description: IP address
24953 example: __L3-INTERFACE-IPV4-ADDRESS__
24956 description: l3-interface-ipv4-address-list object that needs to be created or updated.
24959 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
24963 summary: delete an existing l3-interface-ipv4-address-list
24964 description: delete an existing l3-interface-ipv4-address-list
24965 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24974 description: Response codes found in [response codes](https://wiki.onap.org/).
24976 - name: equipment-name
24980 example: __EQUIPMENT-NAME__
24981 - name: interface-name
24983 description: Name that identifies the link aggregate interface
24986 example: __INTERFACE-NAME__
24987 - name: interface-name
24989 description: Name given to the interface
24992 example: __INTERFACE-NAME__
24993 - name: vlan-interface
24995 description: String that identifies the interface
24998 example: __VLAN-INTERFACE__
24999 - name: l3-interface-ipv4-address
25001 description: IP address
25004 example: __L3-INTERFACE-IPV4-ADDRESS__
25005 - name: resource-version
25007 description: resource-version for concurrency
25010 /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:
25014 summary: see node definition for valid relationships
25015 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
25024 description: Response codes found in [response codes](https://wiki.onap.org/).
25026 - name: equipment-name
25030 example: __EQUIPMENT-NAME__
25031 - name: interface-name
25033 description: Name that identifies the link aggregate interface
25036 example: __INTERFACE-NAME__
25037 - name: interface-name
25039 description: Name given to the interface
25042 example: __INTERFACE-NAME__
25043 - name: vlan-interface
25045 description: String that identifies the interface
25048 example: __VLAN-INTERFACE__
25049 - name: l3-interface-ipv6-address
25051 description: IP address
25054 example: __L3-INTERFACE-IPV6-ADDRESS__
25057 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
25060 $ref: "#/definitions/relationship"
25064 summary: delete an existing relationship
25065 description: delete an existing relationship
25066 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
25075 description: Response codes found in [response codes](https://wiki.onap.org/).
25077 - name: equipment-name
25081 example: __EQUIPMENT-NAME__
25082 - name: interface-name
25084 description: Name that identifies the link aggregate interface
25087 example: __INTERFACE-NAME__
25088 - name: interface-name
25090 description: Name given to the interface
25093 example: __INTERFACE-NAME__
25094 - name: vlan-interface
25096 description: String that identifies the interface
25099 example: __VLAN-INTERFACE__
25100 - name: l3-interface-ipv6-address
25102 description: IP address
25105 example: __L3-INTERFACE-IPV6-ADDRESS__
25106 /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}:
25110 summary: returns l3-interface-ipv6-address-list
25111 description: returns l3-interface-ipv6-address-list
25112 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25118 description: successful operation
25120 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
25122 description: Response codes found in [response codes](https://wiki.onap.org/).
25124 - name: equipment-name
25128 example: __EQUIPMENT-NAME__
25129 - name: interface-name
25131 description: Name that identifies the link aggregate interface
25134 example: __INTERFACE-NAME__
25135 - name: interface-name
25137 description: Name given to the interface
25140 example: __INTERFACE-NAME__
25141 - name: vlan-interface
25143 description: String that identifies the interface
25146 example: __VLAN-INTERFACE__
25147 - name: l3-interface-ipv6-address
25149 description: IP address
25152 example: __L3-INTERFACE-IPV6-ADDRESS__
25153 - name: prov-status
25155 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25158 - name: interface-id
25160 description: ID of interface
25163 - name: interface-role
25165 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
25168 - name: interface-id
25170 description: ID of interface
25175 description: MAC address for the interface
25178 - name: network-name
25180 description: Name of the network
25183 - name: vlan-id-inner
25185 description: Inner VLAN tag
25191 description: This indicates the customers VPN ID associated with this vlan
25194 - name: vlan-id-inner
25196 description: Inner VLAN tag
25200 - name: neutron-network-id
25202 description: Neutron network id of the interface that address belongs to
25205 - name: neutron-subnet-id
25207 description: Neutron id of subnet that address belongs to
25213 summary: create or update an existing l3-interface-ipv6-address-list
25215 Create or update an existing l3-interface-ipv6-address-list.
25217 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25218 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25227 description: Response codes found in [response codes](https://wiki.onap.org/).
25229 - name: equipment-name
25233 example: __EQUIPMENT-NAME__
25234 - name: interface-name
25236 description: Name that identifies the link aggregate interface
25239 example: __INTERFACE-NAME__
25240 - name: interface-name
25242 description: Name given to the interface
25245 example: __INTERFACE-NAME__
25246 - name: vlan-interface
25248 description: String that identifies the interface
25251 example: __VLAN-INTERFACE__
25252 - name: l3-interface-ipv6-address
25254 description: IP address
25257 example: __L3-INTERFACE-IPV6-ADDRESS__
25260 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
25263 $ref: "#/definitions/l3-interface-ipv6-address-list"
25267 summary: update an existing l3-interface-ipv6-address-list
25269 Update an existing l3-interface-ipv6-address-list
25271 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25272 The PUT operation will entirely replace an existing object.
25273 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25275 Other differences between PUT and PATCH are:
25277 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25278 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25279 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25280 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25289 description: Response codes found in [response codes](https://wiki.onap.org/).
25291 - name: equipment-name
25295 example: __EQUIPMENT-NAME__
25296 - name: interface-name
25298 description: Name that identifies the link aggregate interface
25301 example: __INTERFACE-NAME__
25302 - name: interface-name
25304 description: Name given to the interface
25307 example: __INTERFACE-NAME__
25308 - name: vlan-interface
25310 description: String that identifies the interface
25313 example: __VLAN-INTERFACE__
25314 - name: l3-interface-ipv6-address
25316 description: IP address
25319 example: __L3-INTERFACE-IPV6-ADDRESS__
25322 description: l3-interface-ipv6-address-list object that needs to be created or updated.
25325 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
25329 summary: delete an existing l3-interface-ipv6-address-list
25330 description: delete an existing l3-interface-ipv6-address-list
25331 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25340 description: Response codes found in [response codes](https://wiki.onap.org/).
25342 - name: equipment-name
25346 example: __EQUIPMENT-NAME__
25347 - name: interface-name
25349 description: Name that identifies the link aggregate interface
25352 example: __INTERFACE-NAME__
25353 - name: interface-name
25355 description: Name given to the interface
25358 example: __INTERFACE-NAME__
25359 - name: vlan-interface
25361 description: String that identifies the interface
25364 example: __VLAN-INTERFACE__
25365 - name: l3-interface-ipv6-address
25367 description: IP address
25370 example: __L3-INTERFACE-IPV6-ADDRESS__
25371 - name: resource-version
25373 description: resource-version for concurrency
25376 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
25380 summary: returns vlan
25381 description: returns vlan
25382 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
25388 description: successful operation
25390 $ref: "#/getDefinitions/vlan"
25392 description: Response codes found in [response codes](https://wiki.onap.org/).
25394 - name: equipment-name
25398 example: __EQUIPMENT-NAME__
25399 - name: interface-name
25401 description: Name that identifies the link aggregate interface
25404 example: __INTERFACE-NAME__
25405 - name: interface-name
25407 description: Name given to the interface
25410 example: __INTERFACE-NAME__
25411 - name: vlan-interface
25413 description: String that identifies the interface
25416 example: __VLAN-INTERFACE__
25417 - name: prov-status
25419 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25422 - name: interface-id
25424 description: ID of interface
25427 - name: interface-role
25429 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
25432 - name: interface-id
25434 description: ID of interface
25439 description: MAC address for the interface
25442 - name: network-name
25444 description: Name of the network
25447 - name: vlan-id-inner
25449 description: Inner VLAN tag
25455 description: This indicates the customers VPN ID associated with this vlan
25461 summary: create or update an existing vlan
25463 Create or update an existing vlan.
25465 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25466 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
25475 description: Response codes found in [response codes](https://wiki.onap.org/).
25477 - name: equipment-name
25481 example: __EQUIPMENT-NAME__
25482 - name: interface-name
25484 description: Name that identifies the link aggregate interface
25487 example: __INTERFACE-NAME__
25488 - name: interface-name
25490 description: Name given to the interface
25493 example: __INTERFACE-NAME__
25494 - name: vlan-interface
25496 description: String that identifies the interface
25499 example: __VLAN-INTERFACE__
25502 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
25505 $ref: "#/definitions/vlan"
25509 summary: update an existing vlan
25511 Update an existing vlan
25513 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25514 The PUT operation will entirely replace an existing object.
25515 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25517 Other differences between PUT and PATCH are:
25519 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25520 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25521 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25522 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
25531 description: Response codes found in [response codes](https://wiki.onap.org/).
25533 - name: equipment-name
25537 example: __EQUIPMENT-NAME__
25538 - name: interface-name
25540 description: Name that identifies the link aggregate interface
25543 example: __INTERFACE-NAME__
25544 - name: interface-name
25546 description: Name given to the interface
25549 example: __INTERFACE-NAME__
25550 - name: vlan-interface
25552 description: String that identifies the interface
25555 example: __VLAN-INTERFACE__
25558 description: vlan object that needs to be created or updated.
25561 $ref: "#/patchDefinitions/vlan"
25565 summary: delete an existing vlan
25566 description: delete an existing vlan
25567 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
25576 description: Response codes found in [response codes](https://wiki.onap.org/).
25578 - name: equipment-name
25582 example: __EQUIPMENT-NAME__
25583 - name: interface-name
25585 description: Name that identifies the link aggregate interface
25588 example: __INTERFACE-NAME__
25589 - name: interface-name
25591 description: Name given to the interface
25594 example: __INTERFACE-NAME__
25595 - name: vlan-interface
25597 description: String that identifies the interface
25600 example: __VLAN-INTERFACE__
25601 - name: resource-version
25603 description: resource-version for concurrency
25606 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
25610 summary: returns vlans
25611 description: returns vlans
25612 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
25618 description: successful operation
25620 $ref: "#/getDefinitions/vlans"
25622 description: Response codes found in [response codes](https://wiki.onap.org/).
25624 - name: equipment-name
25628 example: __EQUIPMENT-NAME__
25629 - name: interface-name
25631 description: Name that identifies the link aggregate interface
25634 example: __INTERFACE-NAME__
25635 - name: interface-name
25637 description: Name given to the interface
25640 example: __INTERFACE-NAME__
25641 - name: prov-status
25643 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25646 - name: interface-id
25648 description: ID of interface
25651 - name: interface-role
25653 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
25656 - name: interface-id
25658 description: ID of interface
25663 description: MAC address for the interface
25666 - name: network-name
25668 description: Name of the network
25671 /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:
25675 summary: see node definition for valid relationships
25676 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
25685 description: Response codes found in [response codes](https://wiki.onap.org/).
25687 - name: equipment-name
25691 example: __EQUIPMENT-NAME__
25692 - name: interface-name
25694 description: Name that identifies the link aggregate interface
25697 example: __INTERFACE-NAME__
25698 - name: interface-name
25700 description: Name given to the interface
25703 example: __INTERFACE-NAME__
25706 description: PCI ID used to identify the sriov-vf
25709 example: __PCI-ID__
25712 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
25715 $ref: "#/definitions/relationship"
25719 summary: delete an existing relationship
25720 description: delete an existing relationship
25721 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
25730 description: Response codes found in [response codes](https://wiki.onap.org/).
25732 - name: equipment-name
25736 example: __EQUIPMENT-NAME__
25737 - name: interface-name
25739 description: Name that identifies the link aggregate interface
25742 example: __INTERFACE-NAME__
25743 - name: interface-name
25745 description: Name given to the interface
25748 example: __INTERFACE-NAME__
25751 description: PCI ID used to identify the sriov-vf
25754 example: __PCI-ID__
25755 /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}:
25759 summary: returns sriov-vf
25760 description: returns sriov-vf
25761 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25767 description: successful operation
25769 $ref: "#/getDefinitions/sriov-vf"
25771 description: Response codes found in [response codes](https://wiki.onap.org/).
25773 - name: equipment-name
25777 example: __EQUIPMENT-NAME__
25778 - name: interface-name
25780 description: Name that identifies the link aggregate interface
25783 example: __INTERFACE-NAME__
25784 - name: interface-name
25786 description: Name given to the interface
25789 example: __INTERFACE-NAME__
25792 description: PCI ID used to identify the sriov-vf
25795 example: __PCI-ID__
25796 - name: prov-status
25798 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25801 - name: interface-id
25803 description: ID of interface
25806 - name: interface-role
25808 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
25811 - name: interface-id
25813 description: ID of interface
25818 description: MAC address for the interface
25821 - name: network-name
25823 description: Name of the network
25826 - name: vf-vlan-filter
25828 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
25831 - name: vf-mac-filter
25833 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
25836 - name: vf-vlan-strip
25838 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
25841 - name: neutron-network-id
25843 description: Neutron network id of the interface
25849 summary: create or update an existing sriov-vf
25851 Create or update an existing sriov-vf.
25853 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25854 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25863 description: Response codes found in [response codes](https://wiki.onap.org/).
25865 - name: equipment-name
25869 example: __EQUIPMENT-NAME__
25870 - name: interface-name
25872 description: Name that identifies the link aggregate interface
25875 example: __INTERFACE-NAME__
25876 - name: interface-name
25878 description: Name given to the interface
25881 example: __INTERFACE-NAME__
25884 description: PCI ID used to identify the sriov-vf
25887 example: __PCI-ID__
25890 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
25893 $ref: "#/definitions/sriov-vf"
25897 summary: update an existing sriov-vf
25899 Update an existing sriov-vf
25901 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25902 The PUT operation will entirely replace an existing object.
25903 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25905 Other differences between PUT and PATCH are:
25907 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25908 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25909 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25910 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25919 description: Response codes found in [response codes](https://wiki.onap.org/).
25921 - name: equipment-name
25925 example: __EQUIPMENT-NAME__
25926 - name: interface-name
25928 description: Name that identifies the link aggregate interface
25931 example: __INTERFACE-NAME__
25932 - name: interface-name
25934 description: Name given to the interface
25937 example: __INTERFACE-NAME__
25940 description: PCI ID used to identify the sriov-vf
25943 example: __PCI-ID__
25946 description: sriov-vf object that needs to be created or updated.
25949 $ref: "#/patchDefinitions/sriov-vf"
25953 summary: delete an existing sriov-vf
25954 description: delete an existing sriov-vf
25955 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25964 description: Response codes found in [response codes](https://wiki.onap.org/).
25966 - name: equipment-name
25970 example: __EQUIPMENT-NAME__
25971 - name: interface-name
25973 description: Name that identifies the link aggregate interface
25976 example: __INTERFACE-NAME__
25977 - name: interface-name
25979 description: Name given to the interface
25982 example: __INTERFACE-NAME__
25985 description: PCI ID used to identify the sriov-vf
25988 example: __PCI-ID__
25989 - name: resource-version
25991 description: resource-version for concurrency
25994 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
25998 summary: returns sriov-vfs
25999 description: returns sriov-vfs
26000 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
26006 description: successful operation
26008 $ref: "#/getDefinitions/sriov-vfs"
26010 description: Response codes found in [response codes](https://wiki.onap.org/).
26012 - name: equipment-name
26016 example: __EQUIPMENT-NAME__
26017 - name: interface-name
26019 description: Name that identifies the link aggregate interface
26022 example: __INTERFACE-NAME__
26023 - name: interface-name
26025 description: Name given to the interface
26028 example: __INTERFACE-NAME__
26029 - name: prov-status
26031 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26034 - name: interface-id
26036 description: ID of interface
26039 - name: interface-role
26041 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
26044 - name: interface-id
26046 description: ID of interface
26051 description: MAC address for the interface
26054 - name: network-name
26056 description: Name of the network
26059 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
26063 summary: see node definition for valid relationships
26064 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
26073 description: Response codes found in [response codes](https://wiki.onap.org/).
26075 - name: equipment-name
26079 example: __EQUIPMENT-NAME__
26080 - name: interface-name
26082 description: Name that identifies the link aggregate interface
26085 example: __INTERFACE-NAME__
26086 - name: interface-name
26088 description: Name given to the interface
26091 example: __INTERFACE-NAME__
26094 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
26097 $ref: "#/definitions/relationship"
26101 summary: delete an existing relationship
26102 description: delete an existing relationship
26103 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
26112 description: Response codes found in [response codes](https://wiki.onap.org/).
26114 - name: equipment-name
26118 example: __EQUIPMENT-NAME__
26119 - name: interface-name
26121 description: Name that identifies the link aggregate interface
26124 example: __INTERFACE-NAME__
26125 - name: interface-name
26127 description: Name given to the interface
26130 example: __INTERFACE-NAME__
26131 /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:
26135 summary: see node definition for valid relationships
26136 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
26145 description: Response codes found in [response codes](https://wiki.onap.org/).
26147 - name: equipment-name
26151 example: __EQUIPMENT-NAME__
26152 - name: interface-name
26154 description: Name that identifies the link aggregate interface
26157 example: __INTERFACE-NAME__
26158 - name: interface-name
26160 description: Name given to the interface
26163 example: __INTERFACE-NAME__
26164 - name: l3-interface-ipv4-address
26166 description: IP address
26169 example: __L3-INTERFACE-IPV4-ADDRESS__
26172 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
26175 $ref: "#/definitions/relationship"
26179 summary: delete an existing relationship
26180 description: delete an existing relationship
26181 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
26190 description: Response codes found in [response codes](https://wiki.onap.org/).
26192 - name: equipment-name
26196 example: __EQUIPMENT-NAME__
26197 - name: interface-name
26199 description: Name that identifies the link aggregate interface
26202 example: __INTERFACE-NAME__
26203 - name: interface-name
26205 description: Name given to the interface
26208 example: __INTERFACE-NAME__
26209 - name: l3-interface-ipv4-address
26211 description: IP address
26214 example: __L3-INTERFACE-IPV4-ADDRESS__
26215 /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}:
26219 summary: returns l3-interface-ipv4-address-list
26220 description: returns l3-interface-ipv4-address-list
26221 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26227 description: successful operation
26229 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
26231 description: Response codes found in [response codes](https://wiki.onap.org/).
26233 - name: equipment-name
26237 example: __EQUIPMENT-NAME__
26238 - name: interface-name
26240 description: Name that identifies the link aggregate interface
26243 example: __INTERFACE-NAME__
26244 - name: interface-name
26246 description: Name given to the interface
26249 example: __INTERFACE-NAME__
26250 - name: l3-interface-ipv4-address
26252 description: IP address
26255 example: __L3-INTERFACE-IPV4-ADDRESS__
26256 - name: prov-status
26258 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26261 - name: interface-id
26263 description: ID of interface
26266 - name: interface-role
26268 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
26271 - name: interface-id
26273 description: ID of interface
26278 description: MAC address for the interface
26281 - name: network-name
26283 description: Name of the network
26286 - name: vlan-id-inner
26288 description: Inner VLAN tag
26292 - name: neutron-network-id
26294 description: Neutron network id of the interface that address belongs to
26297 - name: neutron-subnet-id
26299 description: Neutron id of subnet that address belongs to
26305 summary: create or update an existing l3-interface-ipv4-address-list
26307 Create or update an existing l3-interface-ipv4-address-list.
26309 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26310 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26319 description: Response codes found in [response codes](https://wiki.onap.org/).
26321 - name: equipment-name
26325 example: __EQUIPMENT-NAME__
26326 - name: interface-name
26328 description: Name that identifies the link aggregate interface
26331 example: __INTERFACE-NAME__
26332 - name: interface-name
26334 description: Name given to the interface
26337 example: __INTERFACE-NAME__
26338 - name: l3-interface-ipv4-address
26340 description: IP address
26343 example: __L3-INTERFACE-IPV4-ADDRESS__
26346 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
26349 $ref: "#/definitions/l3-interface-ipv4-address-list"
26353 summary: update an existing l3-interface-ipv4-address-list
26355 Update an existing l3-interface-ipv4-address-list
26357 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26358 The PUT operation will entirely replace an existing object.
26359 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26361 Other differences between PUT and PATCH are:
26363 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26364 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26365 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26366 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26375 description: Response codes found in [response codes](https://wiki.onap.org/).
26377 - name: equipment-name
26381 example: __EQUIPMENT-NAME__
26382 - name: interface-name
26384 description: Name that identifies the link aggregate interface
26387 example: __INTERFACE-NAME__
26388 - name: interface-name
26390 description: Name given to the interface
26393 example: __INTERFACE-NAME__
26394 - name: l3-interface-ipv4-address
26396 description: IP address
26399 example: __L3-INTERFACE-IPV4-ADDRESS__
26402 description: l3-interface-ipv4-address-list object that needs to be created or updated.
26405 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
26409 summary: delete an existing l3-interface-ipv4-address-list
26410 description: delete an existing l3-interface-ipv4-address-list
26411 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26420 description: Response codes found in [response codes](https://wiki.onap.org/).
26422 - name: equipment-name
26426 example: __EQUIPMENT-NAME__
26427 - name: interface-name
26429 description: Name that identifies the link aggregate interface
26432 example: __INTERFACE-NAME__
26433 - name: interface-name
26435 description: Name given to the interface
26438 example: __INTERFACE-NAME__
26439 - name: l3-interface-ipv4-address
26441 description: IP address
26444 example: __L3-INTERFACE-IPV4-ADDRESS__
26445 - name: resource-version
26447 description: resource-version for concurrency
26450 /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:
26454 summary: see node definition for valid relationships
26455 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
26464 description: Response codes found in [response codes](https://wiki.onap.org/).
26466 - name: equipment-name
26470 example: __EQUIPMENT-NAME__
26471 - name: interface-name
26473 description: Name that identifies the link aggregate interface
26476 example: __INTERFACE-NAME__
26477 - name: interface-name
26479 description: Name given to the interface
26482 example: __INTERFACE-NAME__
26483 - name: l3-interface-ipv6-address
26485 description: IP address
26488 example: __L3-INTERFACE-IPV6-ADDRESS__
26491 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
26494 $ref: "#/definitions/relationship"
26498 summary: delete an existing relationship
26499 description: delete an existing relationship
26500 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
26509 description: Response codes found in [response codes](https://wiki.onap.org/).
26511 - name: equipment-name
26515 example: __EQUIPMENT-NAME__
26516 - name: interface-name
26518 description: Name that identifies the link aggregate interface
26521 example: __INTERFACE-NAME__
26522 - name: interface-name
26524 description: Name given to the interface
26527 example: __INTERFACE-NAME__
26528 - name: l3-interface-ipv6-address
26530 description: IP address
26533 example: __L3-INTERFACE-IPV6-ADDRESS__
26534 /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}:
26538 summary: returns l3-interface-ipv6-address-list
26539 description: returns l3-interface-ipv6-address-list
26540 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26546 description: successful operation
26548 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
26550 description: Response codes found in [response codes](https://wiki.onap.org/).
26552 - name: equipment-name
26556 example: __EQUIPMENT-NAME__
26557 - name: interface-name
26559 description: Name that identifies the link aggregate interface
26562 example: __INTERFACE-NAME__
26563 - name: interface-name
26565 description: Name given to the interface
26568 example: __INTERFACE-NAME__
26569 - name: l3-interface-ipv6-address
26571 description: IP address
26574 example: __L3-INTERFACE-IPV6-ADDRESS__
26575 - name: prov-status
26577 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26580 - name: interface-id
26582 description: ID of interface
26585 - name: interface-role
26587 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
26590 - name: interface-id
26592 description: ID of interface
26597 description: MAC address for the interface
26600 - name: network-name
26602 description: Name of the network
26605 - name: vlan-id-inner
26607 description: Inner VLAN tag
26611 - name: neutron-network-id
26613 description: Neutron network id of the interface that address belongs to
26616 - name: neutron-subnet-id
26618 description: Neutron id of subnet that address belongs to
26624 summary: create or update an existing l3-interface-ipv6-address-list
26626 Create or update an existing l3-interface-ipv6-address-list.
26628 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26629 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26638 description: Response codes found in [response codes](https://wiki.onap.org/).
26640 - name: equipment-name
26644 example: __EQUIPMENT-NAME__
26645 - name: interface-name
26647 description: Name that identifies the link aggregate interface
26650 example: __INTERFACE-NAME__
26651 - name: interface-name
26653 description: Name given to the interface
26656 example: __INTERFACE-NAME__
26657 - name: l3-interface-ipv6-address
26659 description: IP address
26662 example: __L3-INTERFACE-IPV6-ADDRESS__
26665 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
26668 $ref: "#/definitions/l3-interface-ipv6-address-list"
26672 summary: update an existing l3-interface-ipv6-address-list
26674 Update an existing l3-interface-ipv6-address-list
26676 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26677 The PUT operation will entirely replace an existing object.
26678 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26680 Other differences between PUT and PATCH are:
26682 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26683 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26684 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26685 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26694 description: Response codes found in [response codes](https://wiki.onap.org/).
26696 - name: equipment-name
26700 example: __EQUIPMENT-NAME__
26701 - name: interface-name
26703 description: Name that identifies the link aggregate interface
26706 example: __INTERFACE-NAME__
26707 - name: interface-name
26709 description: Name given to the interface
26712 example: __INTERFACE-NAME__
26713 - name: l3-interface-ipv6-address
26715 description: IP address
26718 example: __L3-INTERFACE-IPV6-ADDRESS__
26721 description: l3-interface-ipv6-address-list object that needs to be created or updated.
26724 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
26728 summary: delete an existing l3-interface-ipv6-address-list
26729 description: delete an existing l3-interface-ipv6-address-list
26730 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26739 description: Response codes found in [response codes](https://wiki.onap.org/).
26741 - name: equipment-name
26745 example: __EQUIPMENT-NAME__
26746 - name: interface-name
26748 description: Name that identifies the link aggregate interface
26751 example: __INTERFACE-NAME__
26752 - name: interface-name
26754 description: Name given to the interface
26757 example: __INTERFACE-NAME__
26758 - name: l3-interface-ipv6-address
26760 description: IP address
26763 example: __L3-INTERFACE-IPV6-ADDRESS__
26764 - name: resource-version
26766 description: resource-version for concurrency
26769 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
26773 summary: returns l-interface
26774 description: returns l-interface
26775 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
26781 description: successful operation
26783 $ref: "#/getDefinitions/l-interface"
26785 description: Response codes found in [response codes](https://wiki.onap.org/).
26787 - name: equipment-name
26791 example: __EQUIPMENT-NAME__
26792 - name: interface-name
26794 description: Name that identifies the link aggregate interface
26797 example: __INTERFACE-NAME__
26798 - name: interface-name
26800 description: Name given to the interface
26803 example: __INTERFACE-NAME__
26804 - name: prov-status
26806 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26809 - name: interface-id
26811 description: ID of interface
26814 - name: interface-role
26816 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
26819 - name: interface-id
26821 description: ID of interface
26826 description: MAC address for the interface
26829 - name: network-name
26831 description: Name of the network
26837 summary: create or update an existing l-interface
26839 Create or update an existing l-interface.
26841 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26842 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
26851 description: Response codes found in [response codes](https://wiki.onap.org/).
26853 - name: equipment-name
26857 example: __EQUIPMENT-NAME__
26858 - name: interface-name
26860 description: Name that identifies the link aggregate interface
26863 example: __INTERFACE-NAME__
26864 - name: interface-name
26866 description: Name given to the interface
26869 example: __INTERFACE-NAME__
26872 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
26875 $ref: "#/definitions/l-interface"
26879 summary: update an existing l-interface
26881 Update an existing l-interface
26883 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26884 The PUT operation will entirely replace an existing object.
26885 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26887 Other differences between PUT and PATCH are:
26889 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26890 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26891 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26892 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
26901 description: Response codes found in [response codes](https://wiki.onap.org/).
26903 - name: equipment-name
26907 example: __EQUIPMENT-NAME__
26908 - name: interface-name
26910 description: Name that identifies the link aggregate interface
26913 example: __INTERFACE-NAME__
26914 - name: interface-name
26916 description: Name given to the interface
26919 example: __INTERFACE-NAME__
26922 description: l-interface object that needs to be created or updated.
26925 $ref: "#/patchDefinitions/l-interface"
26929 summary: delete an existing l-interface
26930 description: delete an existing l-interface
26931 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
26940 description: Response codes found in [response codes](https://wiki.onap.org/).
26942 - name: equipment-name
26946 example: __EQUIPMENT-NAME__
26947 - name: interface-name
26949 description: Name that identifies the link aggregate interface
26952 example: __INTERFACE-NAME__
26953 - name: interface-name
26955 description: Name given to the interface
26958 example: __INTERFACE-NAME__
26959 - name: resource-version
26961 description: resource-version for concurrency
26964 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
26968 summary: returns l-interfaces
26969 description: returns l-interfaces
26970 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces
26976 description: successful operation
26978 $ref: "#/getDefinitions/l-interfaces"
26980 description: Response codes found in [response codes](https://wiki.onap.org/).
26982 - name: equipment-name
26986 example: __EQUIPMENT-NAME__
26987 - name: interface-name
26989 description: Name that identifies the link aggregate interface
26992 example: __INTERFACE-NAME__
26993 - name: prov-status
26995 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26998 - name: interface-id
27000 description: ID of interface
27003 - name: interface-role
27005 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
27008 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}:
27012 summary: returns lag-interface
27013 description: returns lag-interface
27014 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface
27020 description: successful operation
27022 $ref: "#/getDefinitions/lag-interface"
27024 description: Response codes found in [response codes](https://wiki.onap.org/).
27026 - name: equipment-name
27030 example: __EQUIPMENT-NAME__
27031 - name: interface-name
27033 description: Name that identifies the link aggregate interface
27036 example: __INTERFACE-NAME__
27037 - name: prov-status
27039 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
27042 - name: interface-id
27044 description: ID of interface
27047 - name: interface-role
27049 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
27055 summary: create or update an existing lag-interface
27057 Create or update an existing lag-interface.
27059 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27060 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
27069 description: Response codes found in [response codes](https://wiki.onap.org/).
27071 - name: equipment-name
27075 example: __EQUIPMENT-NAME__
27076 - name: interface-name
27078 description: Name that identifies the link aggregate interface
27081 example: __INTERFACE-NAME__
27084 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
27087 $ref: "#/definitions/lag-interface"
27091 summary: update an existing lag-interface
27093 Update an existing lag-interface
27095 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27096 The PUT operation will entirely replace an existing object.
27097 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27099 Other differences between PUT and PATCH are:
27101 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27102 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27103 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27104 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
27113 description: Response codes found in [response codes](https://wiki.onap.org/).
27115 - name: equipment-name
27119 example: __EQUIPMENT-NAME__
27120 - name: interface-name
27122 description: Name that identifies the link aggregate interface
27125 example: __INTERFACE-NAME__
27128 description: lag-interface object that needs to be created or updated.
27131 $ref: "#/patchDefinitions/lag-interface"
27135 summary: delete an existing lag-interface
27136 description: delete an existing lag-interface
27137 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface
27146 description: Response codes found in [response codes](https://wiki.onap.org/).
27148 - name: equipment-name
27152 example: __EQUIPMENT-NAME__
27153 - name: interface-name
27155 description: Name that identifies the link aggregate interface
27158 example: __INTERFACE-NAME__
27159 - name: resource-version
27161 description: resource-version for concurrency
27164 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces:
27168 summary: returns lag-interfaces
27169 description: returns lag-interfaces
27170 operationId: getNetworkVplsPesVplsPeLagInterfaces
27176 description: successful operation
27178 $ref: "#/getDefinitions/lag-interfaces"
27180 description: Response codes found in [response codes](https://wiki.onap.org/).
27182 - name: equipment-name
27186 example: __EQUIPMENT-NAME__
27187 - name: prov-status
27189 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
27192 /network/vpls-pes/vpls-pe/{equipment-name}:
27196 summary: returns vpls-pe
27197 description: returns vpls-pe
27198 operationId: getNetworkVplsPesVplsPe
27204 description: successful operation
27206 $ref: "#/getDefinitions/vpls-pe"
27208 description: Response codes found in [response codes](https://wiki.onap.org/).
27210 - name: equipment-name
27214 example: __EQUIPMENT-NAME__
27215 - name: prov-status
27217 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
27223 summary: create or update an existing vpls-pe
27225 Create or update an existing vpls-pe.
27227 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27228 operationId: createOrUpdateNetworkVplsPesVplsPe
27237 description: Response codes found in [response codes](https://wiki.onap.org/).
27239 - name: equipment-name
27243 example: __EQUIPMENT-NAME__
27246 description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPe.json)
27249 $ref: "#/definitions/vpls-pe"
27253 summary: update an existing vpls-pe
27255 Update an existing vpls-pe
27257 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27258 The PUT operation will entirely replace an existing object.
27259 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27261 Other differences between PUT and PATCH are:
27263 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27264 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27265 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27266 operationId: UpdateNetworkVplsPesVplsPe
27275 description: Response codes found in [response codes](https://wiki.onap.org/).
27277 - name: equipment-name
27281 example: __EQUIPMENT-NAME__
27284 description: vpls-pe object that needs to be created or updated.
27287 $ref: "#/patchDefinitions/vpls-pe"
27291 summary: delete an existing vpls-pe
27292 description: delete an existing vpls-pe
27293 operationId: deleteNetworkVplsPesVplsPe
27302 description: Response codes found in [response codes](https://wiki.onap.org/).
27304 - name: equipment-name
27308 example: __EQUIPMENT-NAME__
27309 - name: resource-version
27311 description: resource-version for concurrency
27318 summary: returns vpls-pes
27319 description: returns vpls-pes
27320 operationId: getNetworkVplsPes
27326 description: successful operation
27328 $ref: "#/getDefinitions/vpls-pes"
27330 description: Response codes found in [response codes](https://wiki.onap.org/).
27331 /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
27335 summary: see node definition for valid relationships
27336 operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
27345 description: Response codes found in [response codes](https://wiki.onap.org/).
27347 - name: multicast-configuration-id
27349 description: Unique id of multicast configuration.
27352 example: __MULTICAST-CONFIGURATION-ID__
27355 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkMulticastConfigurationsMulticastConfiguration.json)
27358 $ref: "#/definitions/relationship"
27362 summary: delete an existing relationship
27363 description: delete an existing relationship
27364 operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
27373 description: Response codes found in [response codes](https://wiki.onap.org/).
27375 - name: multicast-configuration-id
27377 description: Unique id of multicast configuration.
27380 example: __MULTICAST-CONFIGURATION-ID__
27381 /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}:
27385 summary: returns multicast-configuration
27386 description: returns multicast-configuration
27387 operationId: getNetworkMulticastConfigurationsMulticastConfiguration
27393 description: successful operation
27395 $ref: "#/getDefinitions/multicast-configuration"
27397 description: Response codes found in [response codes](https://wiki.onap.org/).
27399 - name: multicast-configuration-id
27401 description: Unique id of multicast configuration.
27404 example: __MULTICAST-CONFIGURATION-ID__
27408 summary: create or update an existing multicast-configuration
27410 Create or update an existing multicast-configuration.
27412 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27413 operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration
27422 description: Response codes found in [response codes](https://wiki.onap.org/).
27424 - name: multicast-configuration-id
27426 description: Unique id of multicast configuration.
27429 example: __MULTICAST-CONFIGURATION-ID__
27432 description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkMulticastConfigurationsMulticastConfiguration.json)
27435 $ref: "#/definitions/multicast-configuration"
27439 summary: update an existing multicast-configuration
27441 Update an existing multicast-configuration
27443 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27444 The PUT operation will entirely replace an existing object.
27445 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27447 Other differences between PUT and PATCH are:
27449 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27450 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27451 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27452 operationId: UpdateNetworkMulticastConfigurationsMulticastConfiguration
27461 description: Response codes found in [response codes](https://wiki.onap.org/).
27463 - name: multicast-configuration-id
27465 description: Unique id of multicast configuration.
27468 example: __MULTICAST-CONFIGURATION-ID__
27471 description: multicast-configuration object that needs to be created or updated.
27474 $ref: "#/patchDefinitions/multicast-configuration"
27478 summary: delete an existing multicast-configuration
27479 description: delete an existing multicast-configuration
27480 operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration
27489 description: Response codes found in [response codes](https://wiki.onap.org/).
27491 - name: multicast-configuration-id
27493 description: Unique id of multicast configuration.
27496 example: __MULTICAST-CONFIGURATION-ID__
27497 - name: resource-version
27499 description: resource-version for concurrency
27502 /network/multicast-configurations:
27506 summary: returns multicast-configurations
27507 description: returns multicast-configurations
27508 operationId: getNetworkMulticastConfigurations
27514 description: successful operation
27516 $ref: "#/getDefinitions/multicast-configurations"
27518 description: Response codes found in [response codes](https://wiki.onap.org/).
27519 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship:
27523 summary: see node definition for valid relationships
27524 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
27533 description: Response codes found in [response codes](https://wiki.onap.org/).
27537 description: Unique id of VNF. This is unique across the graph.
27540 example: __VNF-ID__
27541 - name: interface-id
27543 description: Unique ID of the interface
27546 example: __INTERFACE-ID__
27549 description: See mis-na-virtualization-platform.yang
27553 example: __CVLAN-TAG__
27556 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
27559 $ref: "#/definitions/relationship"
27563 summary: delete an existing relationship
27564 description: delete an existing relationship
27565 operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
27574 description: Response codes found in [response codes](https://wiki.onap.org/).
27578 description: Unique id of VNF. This is unique across the graph.
27581 example: __VNF-ID__
27582 - name: interface-id
27584 description: Unique ID of the interface
27587 example: __INTERFACE-ID__
27590 description: See mis-na-virtualization-platform.yang
27594 example: __CVLAN-TAG__
27595 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
27599 summary: returns cvlan-tag-entry
27600 description: returns cvlan-tag-entry
27601 operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
27607 description: successful operation
27609 $ref: "#/getDefinitions/cvlan-tag-entry"
27611 description: Response codes found in [response codes](https://wiki.onap.org/).
27615 description: Unique id of VNF. This is unique across the graph.
27618 example: __VNF-ID__
27619 - name: interface-id
27621 description: Unique ID of the interface
27624 example: __INTERFACE-ID__
27627 description: See mis-na-virtualization-platform.yang
27631 example: __CVLAN-TAG__
27634 description: Name of VNF.
27639 description: Alternate name of VNF.
27644 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.
27649 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
27652 - name: regional-resource-zone
27654 description: Regional way of organizing pservers, source of truth should define values
27657 - name: prov-status
27659 description: Trigger for operational monitoring of this resource by Service Assurance systems.
27662 - name: heat-stack-id
27664 description: Heat stack id corresponding to this instance, managed by MSO
27669 description: Unique ID of VPE connected to this VCE.
27672 - name: port-group-id
27674 description: Unique ID for port group in vmware
27677 - name: switch-name
27679 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
27682 - name: heat-stack-id
27684 description: Heat stack id corresponding to this instance, managed by MSO
27690 summary: create or update an existing cvlan-tag-entry
27692 Create or update an existing cvlan-tag-entry.
27694 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27695 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
27704 description: Response codes found in [response codes](https://wiki.onap.org/).
27708 description: Unique id of VNF. This is unique across the graph.
27711 example: __VNF-ID__
27712 - name: interface-id
27714 description: Unique ID of the interface
27717 example: __INTERFACE-ID__
27720 description: See mis-na-virtualization-platform.yang
27724 example: __CVLAN-TAG__
27727 description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
27730 $ref: "#/definitions/cvlan-tag-entry"
27734 summary: update an existing cvlan-tag-entry
27736 Update an existing cvlan-tag-entry
27738 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27739 The PUT operation will entirely replace an existing object.
27740 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27742 Other differences between PUT and PATCH are:
27744 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27745 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27746 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27747 operationId: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
27756 description: Response codes found in [response codes](https://wiki.onap.org/).
27760 description: Unique id of VNF. This is unique across the graph.
27763 example: __VNF-ID__
27764 - name: interface-id
27766 description: Unique ID of the interface
27769 example: __INTERFACE-ID__
27772 description: See mis-na-virtualization-platform.yang
27776 example: __CVLAN-TAG__
27779 description: cvlan-tag-entry object that needs to be created or updated.
27782 $ref: "#/patchDefinitions/cvlan-tag-entry"
27786 summary: delete an existing cvlan-tag-entry
27787 description: delete an existing cvlan-tag-entry
27788 operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
27797 description: Response codes found in [response codes](https://wiki.onap.org/).
27801 description: Unique id of VNF. This is unique across the graph.
27804 example: __VNF-ID__
27805 - name: interface-id
27807 description: Unique ID of the interface
27810 example: __INTERFACE-ID__
27813 description: See mis-na-virtualization-platform.yang
27817 example: __CVLAN-TAG__
27818 - name: resource-version
27820 description: resource-version for concurrency
27823 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags:
27827 summary: returns cvlan-tags
27828 description: returns cvlan-tags
27829 operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags
27835 description: successful operation
27837 $ref: "#/getDefinitions/cvlan-tags"
27839 description: Response codes found in [response codes](https://wiki.onap.org/).
27843 description: Unique id of VNF. This is unique across the graph.
27846 example: __VNF-ID__
27847 - name: interface-id
27849 description: Unique ID of the interface
27852 example: __INTERFACE-ID__
27855 description: Name of VNF.
27860 description: Alternate name of VNF.
27865 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.
27870 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
27873 - name: regional-resource-zone
27875 description: Regional way of organizing pservers, source of truth should define values
27878 - name: prov-status
27880 description: Trigger for operational monitoring of this resource by Service Assurance systems.
27883 - name: heat-stack-id
27885 description: Heat stack id corresponding to this instance, managed by MSO
27890 description: Unique ID of VPE connected to this VCE.
27893 - name: port-group-id
27895 description: Unique ID for port group in vmware
27898 - name: switch-name
27900 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
27903 - name: heat-stack-id
27905 description: Heat stack id corresponding to this instance, managed by MSO
27908 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
27912 summary: see node definition for valid relationships
27913 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
27922 description: Response codes found in [response codes](https://wiki.onap.org/).
27926 description: Unique id of VNF. This is unique across the graph.
27929 example: __VNF-ID__
27930 - name: interface-id
27932 description: Unique ID of the interface
27935 example: __INTERFACE-ID__
27938 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVcePortGroupsPortGroup.json)
27941 $ref: "#/definitions/relationship"
27945 summary: delete an existing relationship
27946 description: delete an existing relationship
27947 operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
27956 description: Response codes found in [response codes](https://wiki.onap.org/).
27960 description: Unique id of VNF. This is unique across the graph.
27963 example: __VNF-ID__
27964 - name: interface-id
27966 description: Unique ID of the interface
27969 example: __INTERFACE-ID__
27970 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
27974 summary: returns port-group
27975 description: returns port-group
27976 operationId: getNetworkVcesVcePortGroupsPortGroup
27982 description: successful operation
27984 $ref: "#/getDefinitions/port-group"
27986 description: Response codes found in [response codes](https://wiki.onap.org/).
27990 description: Unique id of VNF. This is unique across the graph.
27993 example: __VNF-ID__
27994 - name: interface-id
27996 description: Unique ID of the interface
27999 example: __INTERFACE-ID__
28002 description: Name of VNF.
28007 description: Alternate name of VNF.
28012 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.
28017 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
28020 - name: regional-resource-zone
28022 description: Regional way of organizing pservers, source of truth should define values
28025 - name: prov-status
28027 description: Trigger for operational monitoring of this resource by Service Assurance systems.
28030 - name: heat-stack-id
28032 description: Heat stack id corresponding to this instance, managed by MSO
28037 description: Unique ID of VPE connected to this VCE.
28040 - name: port-group-id
28042 description: Unique ID for port group in vmware
28045 - name: switch-name
28047 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
28050 - name: heat-stack-id
28052 description: Heat stack id corresponding to this instance, managed by MSO
28058 summary: create or update an existing port-group
28060 Create or update an existing port-group.
28062 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28063 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
28072 description: Response codes found in [response codes](https://wiki.onap.org/).
28076 description: Unique id of VNF. This is unique across the graph.
28079 example: __VNF-ID__
28080 - name: interface-id
28082 description: Unique ID of the interface
28085 example: __INTERFACE-ID__
28088 description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVcePortGroupsPortGroup.json)
28091 $ref: "#/definitions/port-group"
28095 summary: update an existing port-group
28097 Update an existing port-group
28099 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28100 The PUT operation will entirely replace an existing object.
28101 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28103 Other differences between PUT and PATCH are:
28105 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28106 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28107 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28108 operationId: UpdateNetworkVcesVcePortGroupsPortGroup
28117 description: Response codes found in [response codes](https://wiki.onap.org/).
28121 description: Unique id of VNF. This is unique across the graph.
28124 example: __VNF-ID__
28125 - name: interface-id
28127 description: Unique ID of the interface
28130 example: __INTERFACE-ID__
28133 description: port-group object that needs to be created or updated.
28136 $ref: "#/patchDefinitions/port-group"
28140 summary: delete an existing port-group
28141 description: delete an existing port-group
28142 operationId: deleteNetworkVcesVcePortGroupsPortGroup
28151 description: Response codes found in [response codes](https://wiki.onap.org/).
28155 description: Unique id of VNF. This is unique across the graph.
28158 example: __VNF-ID__
28159 - name: interface-id
28161 description: Unique ID of the interface
28164 example: __INTERFACE-ID__
28165 - name: resource-version
28167 description: resource-version for concurrency
28170 /network/vces/vce/{vnf-id}/port-groups:
28174 summary: returns port-groups
28175 description: returns port-groups
28176 operationId: getNetworkVcesVcePortGroups
28182 description: successful operation
28184 $ref: "#/getDefinitions/port-groups"
28186 description: Response codes found in [response codes](https://wiki.onap.org/).
28190 description: Unique id of VNF. This is unique across the graph.
28193 example: __VNF-ID__
28196 description: Name of VNF.
28201 description: Alternate name of VNF.
28206 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.
28211 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
28214 - name: regional-resource-zone
28216 description: Regional way of organizing pservers, source of truth should define values
28219 - name: prov-status
28221 description: Trigger for operational monitoring of this resource by Service Assurance systems.
28224 - name: heat-stack-id
28226 description: Heat stack id corresponding to this instance, managed by MSO
28231 description: Unique ID of VPE connected to this VCE.
28234 /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
28238 summary: see node definition for valid relationships
28239 operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship
28248 description: Response codes found in [response codes](https://wiki.onap.org/).
28252 description: Unique id of VNF. This is unique across the graph.
28255 example: __VNF-ID__
28258 description: Unique ID for the license group the resource belongs to, should be uuid.
28261 example: __GROUP-UUID__
28262 - name: resource-uuid
28264 description: Unique ID of a license resource.
28267 example: __RESOURCE-UUID__
28270 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVceLicensesLicense.json)
28273 $ref: "#/definitions/relationship"
28277 summary: delete an existing relationship
28278 description: delete an existing relationship
28279 operationId: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship
28288 description: Response codes found in [response codes](https://wiki.onap.org/).
28292 description: Unique id of VNF. This is unique across the graph.
28295 example: __VNF-ID__
28298 description: Unique ID for the license group the resource belongs to, should be uuid.
28301 example: __GROUP-UUID__
28302 - name: resource-uuid
28304 description: Unique ID of a license resource.
28307 example: __RESOURCE-UUID__
28308 /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
28312 summary: returns license
28313 description: returns license
28314 operationId: getNetworkVcesVceLicensesLicense
28320 description: successful operation
28322 $ref: "#/getDefinitions/license"
28324 description: Response codes found in [response codes](https://wiki.onap.org/).
28328 description: Unique id of VNF. This is unique across the graph.
28331 example: __VNF-ID__
28334 description: Unique ID for the license group the resource belongs to, should be uuid.
28337 example: __GROUP-UUID__
28338 - name: resource-uuid
28340 description: Unique ID of a license resource.
28343 example: __RESOURCE-UUID__
28346 description: Name of VNF.
28351 description: Alternate name of VNF.
28356 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.
28361 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
28364 - name: regional-resource-zone
28366 description: Regional way of organizing pservers, source of truth should define values
28369 - name: prov-status
28371 description: Trigger for operational monitoring of this resource by Service Assurance systems.
28374 - name: heat-stack-id
28376 description: Heat stack id corresponding to this instance, managed by MSO
28381 description: Unique ID of VPE connected to this VCE.
28387 summary: create or update an existing license
28389 Create or update an existing license.
28391 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28392 operationId: createOrUpdateNetworkVcesVceLicensesLicense
28401 description: Response codes found in [response codes](https://wiki.onap.org/).
28405 description: Unique id of VNF. This is unique across the graph.
28408 example: __VNF-ID__
28411 description: Unique ID for the license group the resource belongs to, should be uuid.
28414 example: __GROUP-UUID__
28415 - name: resource-uuid
28417 description: Unique ID of a license resource.
28420 example: __RESOURCE-UUID__
28423 description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVceLicensesLicense.json)
28426 $ref: "#/definitions/license"
28430 summary: update an existing license
28432 Update an existing license
28434 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28435 The PUT operation will entirely replace an existing object.
28436 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28438 Other differences between PUT and PATCH are:
28440 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28441 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28442 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28443 operationId: UpdateNetworkVcesVceLicensesLicense
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__
28462 description: Unique ID for the license group the resource belongs to, should be uuid.
28465 example: __GROUP-UUID__
28466 - name: resource-uuid
28468 description: Unique ID of a license resource.
28471 example: __RESOURCE-UUID__
28474 description: license object that needs to be created or updated.
28477 $ref: "#/patchDefinitions/license"
28481 summary: delete an existing license
28482 description: delete an existing license
28483 operationId: deleteNetworkVcesVceLicensesLicense
28492 description: Response codes found in [response codes](https://wiki.onap.org/).
28496 description: Unique id of VNF. This is unique across the graph.
28499 example: __VNF-ID__
28502 description: Unique ID for the license group the resource belongs to, should be uuid.
28505 example: __GROUP-UUID__
28506 - name: resource-uuid
28508 description: Unique ID of a license resource.
28511 example: __RESOURCE-UUID__
28512 - name: resource-version
28514 description: resource-version for concurrency
28517 /network/vces/vce/{vnf-id}/licenses:
28521 summary: returns licenses
28522 description: returns licenses
28523 operationId: getNetworkVcesVceLicenses
28529 description: successful operation
28531 $ref: "#/getDefinitions/licenses"
28533 description: Response codes found in [response codes](https://wiki.onap.org/).
28537 description: Unique id of VNF. This is unique across the graph.
28540 example: __VNF-ID__
28543 description: Name of VNF.
28548 description: Alternate name of VNF.
28553 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.
28558 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
28561 - name: regional-resource-zone
28563 description: Regional way of organizing pservers, source of truth should define values
28566 - name: prov-status
28568 description: Trigger for operational monitoring of this resource by Service Assurance systems.
28571 - name: heat-stack-id
28573 description: Heat stack id corresponding to this instance, managed by MSO
28578 description: Unique ID of VPE connected to this VCE.
28581 /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
28585 summary: see node definition for valid relationships
28586 operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
28595 description: Response codes found in [response codes](https://wiki.onap.org/).
28599 description: Unique id of VNF. This is unique across the graph.
28602 example: __VNF-ID__
28605 description: Unique ID for the entitlement group the resource comes from, should be uuid.
28608 example: __GROUP-UUID__
28609 - name: resource-uuid
28611 description: Unique ID of an entitlement resource.
28614 example: __RESOURCE-UUID__
28617 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVceEntitlementsEntitlement.json)
28620 $ref: "#/definitions/relationship"
28624 summary: delete an existing relationship
28625 description: delete an existing relationship
28626 operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
28635 description: Response codes found in [response codes](https://wiki.onap.org/).
28639 description: Unique id of VNF. This is unique across the graph.
28642 example: __VNF-ID__
28645 description: Unique ID for the entitlement group the resource comes from, should be uuid.
28648 example: __GROUP-UUID__
28649 - name: resource-uuid
28651 description: Unique ID of an entitlement resource.
28654 example: __RESOURCE-UUID__
28655 /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
28659 summary: returns entitlement
28660 description: returns entitlement
28661 operationId: getNetworkVcesVceEntitlementsEntitlement
28667 description: successful operation
28669 $ref: "#/getDefinitions/entitlement"
28671 description: Response codes found in [response codes](https://wiki.onap.org/).
28675 description: Unique id of VNF. This is unique across the graph.
28678 example: __VNF-ID__
28681 description: Unique ID for the entitlement group the resource comes from, should be uuid.
28684 example: __GROUP-UUID__
28685 - name: resource-uuid
28687 description: Unique ID of an entitlement resource.
28690 example: __RESOURCE-UUID__
28693 description: Name of VNF.
28698 description: Alternate name of VNF.
28703 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.
28708 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
28711 - name: regional-resource-zone
28713 description: Regional way of organizing pservers, source of truth should define values
28716 - name: prov-status
28718 description: Trigger for operational monitoring of this resource by Service Assurance systems.
28721 - name: heat-stack-id
28723 description: Heat stack id corresponding to this instance, managed by MSO
28728 description: Unique ID of VPE connected to this VCE.
28734 summary: create or update an existing entitlement
28736 Create or update an existing entitlement.
28738 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28739 operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement
28748 description: Response codes found in [response codes](https://wiki.onap.org/).
28752 description: Unique id of VNF. This is unique across the graph.
28755 example: __VNF-ID__
28758 description: Unique ID for the entitlement group the resource comes from, should be uuid.
28761 example: __GROUP-UUID__
28762 - name: resource-uuid
28764 description: Unique ID of an entitlement resource.
28767 example: __RESOURCE-UUID__
28770 description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVceEntitlementsEntitlement.json)
28773 $ref: "#/definitions/entitlement"
28777 summary: update an existing entitlement
28779 Update an existing entitlement
28781 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28782 The PUT operation will entirely replace an existing object.
28783 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28785 Other differences between PUT and PATCH are:
28787 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28788 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28789 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28790 operationId: UpdateNetworkVcesVceEntitlementsEntitlement
28799 description: Response codes found in [response codes](https://wiki.onap.org/).
28803 description: Unique id of VNF. This is unique across the graph.
28806 example: __VNF-ID__
28809 description: Unique ID for the entitlement group the resource comes from, should be uuid.
28812 example: __GROUP-UUID__
28813 - name: resource-uuid
28815 description: Unique ID of an entitlement resource.
28818 example: __RESOURCE-UUID__
28821 description: entitlement object that needs to be created or updated.
28824 $ref: "#/patchDefinitions/entitlement"
28828 summary: delete an existing entitlement
28829 description: delete an existing entitlement
28830 operationId: deleteNetworkVcesVceEntitlementsEntitlement
28839 description: Response codes found in [response codes](https://wiki.onap.org/).
28843 description: Unique id of VNF. This is unique across the graph.
28846 example: __VNF-ID__
28849 description: Unique ID for the entitlement group the resource comes from, should be uuid.
28852 example: __GROUP-UUID__
28853 - name: resource-uuid
28855 description: Unique ID of an entitlement resource.
28858 example: __RESOURCE-UUID__
28859 - name: resource-version
28861 description: resource-version for concurrency
28864 /network/vces/vce/{vnf-id}/entitlements:
28868 summary: returns entitlements
28869 description: returns entitlements
28870 operationId: getNetworkVcesVceEntitlements
28876 description: successful operation
28878 $ref: "#/getDefinitions/entitlements"
28880 description: Response codes found in [response codes](https://wiki.onap.org/).
28884 description: Unique id of VNF. This is unique across the graph.
28887 example: __VNF-ID__
28890 description: Name of VNF.
28895 description: Alternate name of VNF.
28900 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.
28905 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
28908 - name: regional-resource-zone
28910 description: Regional way of organizing pservers, source of truth should define values
28913 - name: prov-status
28915 description: Trigger for operational monitoring of this resource by Service Assurance systems.
28918 - name: heat-stack-id
28920 description: Heat stack id corresponding to this instance, managed by MSO
28925 description: Unique ID of VPE connected to this VCE.
28928 /network/vces/vce/{vnf-id}/relationship-list/relationship:
28932 summary: see node definition for valid relationships
28933 operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship
28942 description: Response codes found in [response codes](https://wiki.onap.org/).
28946 description: Unique id of VNF. This is unique across the graph.
28949 example: __VNF-ID__
28952 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVce.json)
28955 $ref: "#/definitions/relationship"
28959 summary: delete an existing relationship
28960 description: delete an existing relationship
28961 operationId: deleteNetworkVcesVceRelationshipListRelationship
28970 description: Response codes found in [response codes](https://wiki.onap.org/).
28974 description: Unique id of VNF. This is unique across the graph.
28977 example: __VNF-ID__
28978 /network/vces/vce/{vnf-id}:
28982 summary: returns vce
28983 description: returns vce
28984 operationId: getNetworkVcesVce
28990 description: successful operation
28992 $ref: "#/getDefinitions/vce"
28994 description: Response codes found in [response codes](https://wiki.onap.org/).
28998 description: Unique id of VNF. This is unique across the graph.
29001 example: __VNF-ID__
29004 description: Name of VNF.
29009 description: Alternate name of VNF.
29014 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.
29019 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
29022 - name: regional-resource-zone
29024 description: Regional way of organizing pservers, source of truth should define values
29027 - name: prov-status
29029 description: Trigger for operational monitoring of this resource by Service Assurance systems.
29032 - name: heat-stack-id
29034 description: Heat stack id corresponding to this instance, managed by MSO
29039 description: Unique ID of VPE connected to this VCE.
29045 summary: create or update an existing vce
29047 Create or update an existing vce.
29049 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29050 operationId: createOrUpdateNetworkVcesVce
29059 description: Response codes found in [response codes](https://wiki.onap.org/).
29063 description: Unique id of VNF. This is unique across the graph.
29066 example: __VNF-ID__
29069 description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVce.json)
29072 $ref: "#/definitions/vce"
29076 summary: update an existing vce
29078 Update an existing vce
29080 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29081 The PUT operation will entirely replace an existing object.
29082 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29084 Other differences between PUT and PATCH are:
29086 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29087 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29088 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29089 operationId: UpdateNetworkVcesVce
29098 description: Response codes found in [response codes](https://wiki.onap.org/).
29102 description: Unique id of VNF. This is unique across the graph.
29105 example: __VNF-ID__
29108 description: vce object that needs to be created or updated.
29111 $ref: "#/patchDefinitions/vce"
29115 summary: delete an existing vce
29116 description: delete an existing vce
29117 operationId: deleteNetworkVcesVce
29126 description: Response codes found in [response codes](https://wiki.onap.org/).
29130 description: Unique id of VNF. This is unique across the graph.
29133 example: __VNF-ID__
29134 - name: resource-version
29136 description: resource-version for concurrency
29143 summary: returns vces
29144 description: returns vces
29145 operationId: getNetworkVces
29151 description: successful operation
29153 $ref: "#/getDefinitions/vces"
29155 description: Response codes found in [response codes](https://wiki.onap.org/).
29156 /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
29160 summary: see node definition for valid relationships
29161 operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship
29170 description: Response codes found in [response codes](https://wiki.onap.org/).
29174 description: Unique ID of vnfc.
29177 example: __VNFC-NAME__
29180 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVnfcsVnfc.json)
29183 $ref: "#/definitions/relationship"
29187 summary: delete an existing relationship
29188 description: delete an existing relationship
29189 operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship
29198 description: Response codes found in [response codes](https://wiki.onap.org/).
29202 description: Unique ID of vnfc.
29205 example: __VNFC-NAME__
29206 /network/vnfcs/vnfc/{vnfc-name}:
29210 summary: returns vnfc
29211 description: returns vnfc
29212 operationId: getNetworkVnfcsVnfc
29218 description: successful operation
29220 $ref: "#/getDefinitions/vnfc"
29222 description: Response codes found in [response codes](https://wiki.onap.org/).
29226 description: Unique ID of vnfc.
29229 example: __VNFC-NAME__
29230 - name: vnfc-function-code
29232 description: function code
29240 - name: prov-status
29242 description: prov status of this vnfc
29245 - name: ipaddress-v4-oam-vip
29247 description: Oam V4 vip address of this vnfc
29254 - name: is-closed-loop-disabled
29258 - name: group-notation
29260 description: Group notation of VNFC
29266 summary: create or update an existing vnfc
29268 Create or update an existing vnfc.
29270 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29271 operationId: createOrUpdateNetworkVnfcsVnfc
29280 description: Response codes found in [response codes](https://wiki.onap.org/).
29284 description: Unique ID of vnfc.
29287 example: __VNFC-NAME__
29290 description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVnfcsVnfc.json)
29293 $ref: "#/definitions/vnfc"
29297 summary: update an existing vnfc
29299 Update an existing vnfc
29301 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29302 The PUT operation will entirely replace an existing object.
29303 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29305 Other differences between PUT and PATCH are:
29307 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29308 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29309 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29310 operationId: UpdateNetworkVnfcsVnfc
29319 description: Response codes found in [response codes](https://wiki.onap.org/).
29323 description: Unique ID of vnfc.
29326 example: __VNFC-NAME__
29329 description: vnfc object that needs to be created or updated.
29332 $ref: "#/patchDefinitions/vnfc"
29336 summary: delete an existing vnfc
29337 description: delete an existing vnfc
29338 operationId: deleteNetworkVnfcsVnfc
29347 description: Response codes found in [response codes](https://wiki.onap.org/).
29351 description: Unique ID of vnfc.
29354 example: __VNFC-NAME__
29355 - name: resource-version
29357 description: resource-version for concurrency
29364 summary: returns vnfcs
29365 description: returns vnfcs
29366 operationId: getNetworkVnfcs
29372 description: successful operation
29374 $ref: "#/getDefinitions/vnfcs"
29376 description: Response codes found in [response codes](https://wiki.onap.org/).
29377 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
29381 summary: see node definition for valid relationships
29382 operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
29391 description: Response codes found in [response codes](https://wiki.onap.org/).
29395 description: Network ID, should be uuid. Unique across A&AI.
29398 example: __NETWORK-ID__
29401 description: Subnet ID, should be UUID.
29404 example: __SUBNET-ID__
29407 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
29410 $ref: "#/definitions/relationship"
29414 summary: delete an existing relationship
29415 description: delete an existing relationship
29416 operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
29425 description: Response codes found in [response codes](https://wiki.onap.org/).
29429 description: Network ID, should be uuid. Unique across A&AI.
29432 example: __NETWORK-ID__
29435 description: Subnet ID, should be UUID.
29438 example: __SUBNET-ID__
29439 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}:
29443 summary: returns subnet
29444 description: returns subnet
29445 operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet
29451 description: successful operation
29453 $ref: "#/getDefinitions/subnet"
29455 description: Response codes found in [response codes](https://wiki.onap.org/).
29459 description: Network ID, should be uuid. Unique across A&AI.
29462 example: __NETWORK-ID__
29465 description: Subnet ID, should be UUID.
29468 example: __SUBNET-ID__
29469 - name: network-name
29471 description: Name of the network, governed by some naming convention..
29474 - name: network-role
29476 description: Role the network plans - who defines these values?
29481 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
29484 - name: heat-stack-id
29486 description: Heat stack id corresponding to this instance, managed by MSO
29489 - name: contrail-network-fqdn
29491 description: Contrail FQDN for the network
29494 - name: model-invariant-id
29496 description: the ASDC model id for this resource or service model.
29499 - name: model-version-id
29501 description: the ASDC model version for this resource or service model.
29504 - name: widget-model-id
29506 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
29509 - name: widget-model-version
29511 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
29514 - name: subnet-name
29516 description: Name associated with the subnet.
29522 summary: create or update an existing subnet
29524 Create or update an existing subnet.
29526 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29527 operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet
29536 description: Response codes found in [response codes](https://wiki.onap.org/).
29540 description: Network ID, should be uuid. Unique across A&AI.
29543 example: __NETWORK-ID__
29546 description: Subnet ID, should be UUID.
29549 example: __SUBNET-ID__
29552 description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
29555 $ref: "#/definitions/subnet"
29559 summary: update an existing subnet
29561 Update an existing subnet
29563 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29564 The PUT operation will entirely replace an existing object.
29565 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29567 Other differences between PUT and PATCH are:
29569 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29570 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29571 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29572 operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet
29581 description: Response codes found in [response codes](https://wiki.onap.org/).
29585 description: Network ID, should be uuid. Unique across A&AI.
29588 example: __NETWORK-ID__
29591 description: Subnet ID, should be UUID.
29594 example: __SUBNET-ID__
29597 description: subnet object that needs to be created or updated.
29600 $ref: "#/patchDefinitions/subnet"
29604 summary: delete an existing subnet
29605 description: delete an existing subnet
29606 operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet
29615 description: Response codes found in [response codes](https://wiki.onap.org/).
29619 description: Network ID, should be uuid. Unique across A&AI.
29622 example: __NETWORK-ID__
29625 description: Subnet ID, should be UUID.
29628 example: __SUBNET-ID__
29629 - name: resource-version
29631 description: resource-version for concurrency
29634 /network/l3-networks/l3-network/{network-id}/subnets:
29638 summary: returns subnets
29639 description: returns subnets
29640 operationId: getNetworkL3NetworksL3NetworkSubnets
29646 description: successful operation
29648 $ref: "#/getDefinitions/subnets"
29650 description: Response codes found in [response codes](https://wiki.onap.org/).
29654 description: Network ID, should be uuid. Unique across A&AI.
29657 example: __NETWORK-ID__
29658 - name: network-name
29660 description: Name of the network, governed by some naming convention..
29663 - name: network-role
29665 description: Role the network plans - who defines these values?
29670 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
29673 - name: heat-stack-id
29675 description: Heat stack id corresponding to this instance, managed by MSO
29678 - name: contrail-network-fqdn
29680 description: Contrail FQDN for the network
29683 - name: model-invariant-id
29685 description: the ASDC model id for this resource or service model.
29688 - name: model-version-id
29690 description: the ASDC model version for this resource or service model.
29693 - name: widget-model-id
29695 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
29698 - name: widget-model-version
29700 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
29703 /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship:
29707 summary: see node definition for valid relationships
29708 operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
29717 description: Response codes found in [response codes](https://wiki.onap.org/).
29721 description: Network ID, should be uuid. Unique across A&AI.
29724 example: __NETWORK-ID__
29725 - name: vlan-id-inner
29731 example: __VLAN-ID-INNER__
29734 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
29737 $ref: "#/definitions/relationship"
29741 summary: delete an existing relationship
29742 description: delete an existing relationship
29743 operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
29752 description: Response codes found in [response codes](https://wiki.onap.org/).
29756 description: Network ID, should be uuid. Unique across A&AI.
29759 example: __NETWORK-ID__
29760 - name: vlan-id-inner
29766 example: __VLAN-ID-INNER__
29767 /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}:
29771 summary: returns ctag-assignment
29772 description: returns ctag-assignment
29773 operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
29779 description: successful operation
29781 $ref: "#/getDefinitions/ctag-assignment"
29783 description: Response codes found in [response codes](https://wiki.onap.org/).
29787 description: Network ID, should be uuid. Unique across A&AI.
29790 example: __NETWORK-ID__
29791 - name: vlan-id-inner
29797 example: __VLAN-ID-INNER__
29798 - name: network-name
29800 description: Name of the network, governed by some naming convention..
29803 - name: network-role
29805 description: Role the network plans - who defines these values?
29810 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
29813 - name: heat-stack-id
29815 description: Heat stack id corresponding to this instance, managed by MSO
29818 - name: contrail-network-fqdn
29820 description: Contrail FQDN for the network
29823 - name: model-invariant-id
29825 description: the ASDC model id for this resource or service model.
29828 - name: model-version-id
29830 description: the ASDC model version for this resource or service model.
29833 - name: widget-model-id
29835 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
29838 - name: widget-model-version
29840 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
29846 summary: create or update an existing ctag-assignment
29848 Create or update an existing ctag-assignment.
29850 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29851 operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
29860 description: Response codes found in [response codes](https://wiki.onap.org/).
29864 description: Network ID, should be uuid. Unique across A&AI.
29867 example: __NETWORK-ID__
29868 - name: vlan-id-inner
29874 example: __VLAN-ID-INNER__
29877 description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
29880 $ref: "#/definitions/ctag-assignment"
29884 summary: update an existing ctag-assignment
29886 Update an existing ctag-assignment
29888 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29889 The PUT operation will entirely replace an existing object.
29890 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29892 Other differences between PUT and PATCH are:
29894 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29895 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29896 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29897 operationId: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
29906 description: Response codes found in [response codes](https://wiki.onap.org/).
29910 description: Network ID, should be uuid. Unique across A&AI.
29913 example: __NETWORK-ID__
29914 - name: vlan-id-inner
29920 example: __VLAN-ID-INNER__
29923 description: ctag-assignment object that needs to be created or updated.
29926 $ref: "#/patchDefinitions/ctag-assignment"
29930 summary: delete an existing ctag-assignment
29931 description: delete an existing ctag-assignment
29932 operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
29941 description: Response codes found in [response codes](https://wiki.onap.org/).
29945 description: Network ID, should be uuid. Unique across A&AI.
29948 example: __NETWORK-ID__
29949 - name: vlan-id-inner
29955 example: __VLAN-ID-INNER__
29956 - name: resource-version
29958 description: resource-version for concurrency
29961 /network/l3-networks/l3-network/{network-id}/ctag-assignments:
29965 summary: returns ctag-assignments
29966 description: returns ctag-assignments
29967 operationId: getNetworkL3NetworksL3NetworkCtagAssignments
29973 description: successful operation
29975 $ref: "#/getDefinitions/ctag-assignments"
29977 description: Response codes found in [response codes](https://wiki.onap.org/).
29981 description: Network ID, should be uuid. Unique across A&AI.
29984 example: __NETWORK-ID__
29985 - name: network-name
29987 description: Name of the network, governed by some naming convention..
29990 - name: network-role
29992 description: Role the network plans - who defines these values?
29997 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
30000 - name: heat-stack-id
30002 description: Heat stack id corresponding to this instance, managed by MSO
30005 - name: contrail-network-fqdn
30007 description: Contrail FQDN for the network
30010 - name: model-invariant-id
30012 description: the ASDC model id for this resource or service model.
30015 - name: model-version-id
30017 description: the ASDC model version for this resource or service model.
30020 - name: widget-model-id
30022 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
30025 - name: widget-model-version
30027 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
30030 /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship:
30034 summary: see node definition for valid relationships
30035 operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
30044 description: Response codes found in [response codes](https://wiki.onap.org/).
30048 description: Network ID, should be uuid. Unique across A&AI.
30051 example: __NETWORK-ID__
30052 - name: segmentation-id
30054 description: Route Table Reference id, UUID assigned to this instance.
30057 example: __SEGMENTATION-ID__
30060 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
30063 $ref: "#/definitions/relationship"
30067 summary: delete an existing relationship
30068 description: delete an existing relationship
30069 operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
30078 description: Response codes found in [response codes](https://wiki.onap.org/).
30082 description: Network ID, should be uuid. Unique across A&AI.
30085 example: __NETWORK-ID__
30086 - name: segmentation-id
30088 description: Route Table Reference id, UUID assigned to this instance.
30091 example: __SEGMENTATION-ID__
30092 /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}:
30096 summary: returns segmentation-assignment
30097 description: returns segmentation-assignment
30098 operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
30104 description: successful operation
30106 $ref: "#/getDefinitions/segmentation-assignment"
30108 description: Response codes found in [response codes](https://wiki.onap.org/).
30112 description: Network ID, should be uuid. Unique across A&AI.
30115 example: __NETWORK-ID__
30116 - name: segmentation-id
30118 description: Route Table Reference id, UUID assigned to this instance.
30121 example: __SEGMENTATION-ID__
30122 - name: network-name
30124 description: Name of the network, governed by some naming convention..
30127 - name: network-role
30129 description: Role the network plans - who defines these values?
30134 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
30137 - name: heat-stack-id
30139 description: Heat stack id corresponding to this instance, managed by MSO
30142 - name: contrail-network-fqdn
30144 description: Contrail FQDN for the network
30147 - name: model-invariant-id
30149 description: the ASDC model id for this resource or service model.
30152 - name: model-version-id
30154 description: the ASDC model version for this resource or service model.
30157 - name: widget-model-id
30159 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
30162 - name: widget-model-version
30164 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
30170 summary: create or update an existing segmentation-assignment
30172 Create or update an existing segmentation-assignment.
30174 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30175 operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
30184 description: Response codes found in [response codes](https://wiki.onap.org/).
30188 description: Network ID, should be uuid. Unique across A&AI.
30191 example: __NETWORK-ID__
30192 - name: segmentation-id
30194 description: Route Table Reference id, UUID assigned to this instance.
30197 example: __SEGMENTATION-ID__
30200 description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
30203 $ref: "#/definitions/segmentation-assignment"
30207 summary: update an existing segmentation-assignment
30209 Update an existing segmentation-assignment
30211 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30212 The PUT operation will entirely replace an existing object.
30213 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30215 Other differences between PUT and PATCH are:
30217 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30218 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30219 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30220 operationId: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
30229 description: Response codes found in [response codes](https://wiki.onap.org/).
30233 description: Network ID, should be uuid. Unique across A&AI.
30236 example: __NETWORK-ID__
30237 - name: segmentation-id
30239 description: Route Table Reference id, UUID assigned to this instance.
30242 example: __SEGMENTATION-ID__
30245 description: segmentation-assignment object that needs to be created or updated.
30248 $ref: "#/patchDefinitions/segmentation-assignment"
30252 summary: delete an existing segmentation-assignment
30253 description: delete an existing segmentation-assignment
30254 operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
30263 description: Response codes found in [response codes](https://wiki.onap.org/).
30267 description: Network ID, should be uuid. Unique across A&AI.
30270 example: __NETWORK-ID__
30271 - name: segmentation-id
30273 description: Route Table Reference id, UUID assigned to this instance.
30276 example: __SEGMENTATION-ID__
30277 - name: resource-version
30279 description: resource-version for concurrency
30282 /network/l3-networks/l3-network/{network-id}/segmentation-assignments:
30286 summary: returns segmentation-assignments
30287 description: returns segmentation-assignments
30288 operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments
30294 description: successful operation
30296 $ref: "#/getDefinitions/segmentation-assignments"
30298 description: Response codes found in [response codes](https://wiki.onap.org/).
30302 description: Network ID, should be uuid. Unique across A&AI.
30305 example: __NETWORK-ID__
30306 - name: network-name
30308 description: Name of the network, governed by some naming convention..
30311 - name: network-role
30313 description: Role the network plans - who defines these values?
30318 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
30321 - name: heat-stack-id
30323 description: Heat stack id corresponding to this instance, managed by MSO
30326 - name: contrail-network-fqdn
30328 description: Contrail FQDN for the network
30331 - name: model-invariant-id
30333 description: the ASDC model id for this resource or service model.
30336 - name: model-version-id
30338 description: the ASDC model version for this resource or service model.
30341 - name: widget-model-id
30343 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
30346 - name: widget-model-version
30348 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
30351 /network/l3-networks/l3-network/{network-id}/relationship-list/relationship:
30355 summary: see node definition for valid relationships
30356 operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship
30365 description: Response codes found in [response codes](https://wiki.onap.org/).
30369 description: Network ID, should be uuid. Unique across A&AI.
30372 example: __NETWORK-ID__
30375 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3Network.json)
30378 $ref: "#/definitions/relationship"
30382 summary: delete an existing relationship
30383 description: delete an existing relationship
30384 operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship
30393 description: Response codes found in [response codes](https://wiki.onap.org/).
30397 description: Network ID, should be uuid. Unique across A&AI.
30400 example: __NETWORK-ID__
30401 /network/l3-networks/l3-network/{network-id}:
30405 summary: returns l3-network
30406 description: returns l3-network
30407 operationId: getNetworkL3NetworksL3Network
30413 description: successful operation
30415 $ref: "#/getDefinitions/l3-network"
30417 description: Response codes found in [response codes](https://wiki.onap.org/).
30421 description: Network ID, should be uuid. Unique across A&AI.
30424 example: __NETWORK-ID__
30425 - name: network-name
30427 description: Name of the network, governed by some naming convention..
30430 - name: network-role
30432 description: Role the network plans - who defines these values?
30437 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
30440 - name: heat-stack-id
30442 description: Heat stack id corresponding to this instance, managed by MSO
30445 - name: contrail-network-fqdn
30447 description: Contrail FQDN for the network
30450 - name: model-invariant-id
30452 description: the ASDC model id for this resource or service model.
30455 - name: model-version-id
30457 description: the ASDC model version for this resource or service model.
30460 - name: widget-model-id
30462 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
30465 - name: widget-model-version
30467 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
30473 summary: create or update an existing l3-network
30475 Create or update an existing l3-network.
30477 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30478 operationId: createOrUpdateNetworkL3NetworksL3Network
30487 description: Response codes found in [response codes](https://wiki.onap.org/).
30491 description: Network ID, should be uuid. Unique across A&AI.
30494 example: __NETWORK-ID__
30497 description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3Network.json)
30500 $ref: "#/definitions/l3-network"
30504 summary: update an existing l3-network
30506 Update an existing l3-network
30508 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30509 The PUT operation will entirely replace an existing object.
30510 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30512 Other differences between PUT and PATCH are:
30514 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30515 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30516 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30517 operationId: UpdateNetworkL3NetworksL3Network
30526 description: Response codes found in [response codes](https://wiki.onap.org/).
30530 description: Network ID, should be uuid. Unique across A&AI.
30533 example: __NETWORK-ID__
30536 description: l3-network object that needs to be created or updated.
30539 $ref: "#/patchDefinitions/l3-network"
30543 summary: delete an existing l3-network
30544 description: delete an existing l3-network
30545 operationId: deleteNetworkL3NetworksL3Network
30554 description: Response codes found in [response codes](https://wiki.onap.org/).
30558 description: Network ID, should be uuid. Unique across A&AI.
30561 example: __NETWORK-ID__
30562 - name: resource-version
30564 description: resource-version for concurrency
30567 /network/l3-networks:
30571 summary: returns l3-networks
30572 description: returns l3-networks
30573 operationId: getNetworkL3Networks
30579 description: successful operation
30581 $ref: "#/getDefinitions/l3-networks"
30583 description: Response codes found in [response codes](https://wiki.onap.org/).
30584 /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship:
30588 summary: see node definition for valid relationships
30589 operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
30598 description: Response codes found in [response codes](https://wiki.onap.org/).
30600 - name: network-policy-id
30602 description: UUID representing unique key to this instance
30605 example: __NETWORK-POLICY-ID__
30608 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNetworkPoliciesNetworkPolicy.json)
30611 $ref: "#/definitions/relationship"
30615 summary: delete an existing relationship
30616 description: delete an existing relationship
30617 operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
30626 description: Response codes found in [response codes](https://wiki.onap.org/).
30628 - name: network-policy-id
30630 description: UUID representing unique key to this instance
30633 example: __NETWORK-POLICY-ID__
30634 /network/network-policies/network-policy/{network-policy-id}:
30638 summary: returns network-policy
30639 description: returns network-policy
30640 operationId: getNetworkNetworkPoliciesNetworkPolicy
30646 description: successful operation
30648 $ref: "#/getDefinitions/network-policy"
30650 description: Response codes found in [response codes](https://wiki.onap.org/).
30652 - name: network-policy-id
30654 description: UUID representing unique key to this instance
30657 example: __NETWORK-POLICY-ID__
30658 - name: network-policy-fqdn
30660 description: Contrail FQDN for the policy
30666 summary: create or update an existing network-policy
30668 Create or update an existing network-policy.
30670 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30671 operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy
30680 description: Response codes found in [response codes](https://wiki.onap.org/).
30682 - name: network-policy-id
30684 description: UUID representing unique key to this instance
30687 example: __NETWORK-POLICY-ID__
30690 description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNetworkPoliciesNetworkPolicy.json)
30693 $ref: "#/definitions/network-policy"
30697 summary: update an existing network-policy
30699 Update an existing network-policy
30701 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30702 The PUT operation will entirely replace an existing object.
30703 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30705 Other differences between PUT and PATCH are:
30707 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30708 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30709 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30710 operationId: UpdateNetworkNetworkPoliciesNetworkPolicy
30719 description: Response codes found in [response codes](https://wiki.onap.org/).
30721 - name: network-policy-id
30723 description: UUID representing unique key to this instance
30726 example: __NETWORK-POLICY-ID__
30729 description: network-policy object that needs to be created or updated.
30732 $ref: "#/patchDefinitions/network-policy"
30736 summary: delete an existing network-policy
30737 description: delete an existing network-policy
30738 operationId: deleteNetworkNetworkPoliciesNetworkPolicy
30747 description: Response codes found in [response codes](https://wiki.onap.org/).
30749 - name: network-policy-id
30751 description: UUID representing unique key to this instance
30754 example: __NETWORK-POLICY-ID__
30755 - name: resource-version
30757 description: resource-version for concurrency
30760 /network/network-policies:
30764 summary: returns network-policies
30765 description: returns network-policies
30766 operationId: getNetworkNetworkPolicies
30772 description: successful operation
30774 $ref: "#/getDefinitions/network-policies"
30776 description: Response codes found in [response codes](https://wiki.onap.org/).
30777 /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship:
30781 summary: see node definition for valid relationships
30782 operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship
30791 description: Response codes found in [response codes](https://wiki.onap.org/).
30795 description: Unique id of VNF. This is unique across the graph.
30798 example: __VNF-ID__
30801 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnf.json)
30804 $ref: "#/definitions/relationship"
30808 summary: delete an existing relationship
30809 description: delete an existing relationship
30810 operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship
30819 description: Response codes found in [response codes](https://wiki.onap.org/).
30823 description: Unique id of VNF. This is unique across the graph.
30826 example: __VNF-ID__
30827 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
30831 summary: see node definition for valid relationships
30832 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
30841 description: Response codes found in [response codes](https://wiki.onap.org/).
30845 description: Unique id of VNF. This is unique across the graph.
30848 example: __VNF-ID__
30849 - name: interface-name
30851 description: Name given to the interface
30854 example: __INTERFACE-NAME__
30855 - name: vlan-interface
30857 description: String that identifies the interface
30860 example: __VLAN-INTERFACE__
30863 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
30866 $ref: "#/definitions/relationship"
30870 summary: delete an existing relationship
30871 description: delete an existing relationship
30872 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
30881 description: Response codes found in [response codes](https://wiki.onap.org/).
30885 description: Unique id of VNF. This is unique across the graph.
30888 example: __VNF-ID__
30889 - name: interface-name
30891 description: Name given to the interface
30894 example: __INTERFACE-NAME__
30895 - name: vlan-interface
30897 description: String that identifies the interface
30900 example: __VLAN-INTERFACE__
30901 /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:
30905 summary: see node definition for valid relationships
30906 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
30915 description: Response codes found in [response codes](https://wiki.onap.org/).
30919 description: Unique id of VNF. This is unique across the graph.
30922 example: __VNF-ID__
30923 - name: interface-name
30925 description: Name given to the interface
30928 example: __INTERFACE-NAME__
30929 - name: vlan-interface
30931 description: String that identifies the interface
30934 example: __VLAN-INTERFACE__
30935 - name: l3-interface-ipv4-address
30937 description: IP address
30940 example: __L3-INTERFACE-IPV4-ADDRESS__
30943 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
30946 $ref: "#/definitions/relationship"
30950 summary: delete an existing relationship
30951 description: delete an existing relationship
30952 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
30961 description: Response codes found in [response codes](https://wiki.onap.org/).
30965 description: Unique id of VNF. This is unique across the graph.
30968 example: __VNF-ID__
30969 - name: interface-name
30971 description: Name given to the interface
30974 example: __INTERFACE-NAME__
30975 - name: vlan-interface
30977 description: String that identifies the interface
30980 example: __VLAN-INTERFACE__
30981 - name: l3-interface-ipv4-address
30983 description: IP address
30986 example: __L3-INTERFACE-IPV4-ADDRESS__
30987 /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}:
30991 summary: returns l3-interface-ipv4-address-list
30992 description: returns l3-interface-ipv4-address-list
30993 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
30999 description: successful operation
31001 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
31003 description: Response codes found in [response codes](https://wiki.onap.org/).
31007 description: Unique id of VNF. This is unique across the graph.
31010 example: __VNF-ID__
31011 - name: interface-name
31013 description: Name given to the interface
31016 example: __INTERFACE-NAME__
31017 - name: vlan-interface
31019 description: String that identifies the interface
31022 example: __VLAN-INTERFACE__
31023 - name: l3-interface-ipv4-address
31025 description: IP address
31028 example: __L3-INTERFACE-IPV4-ADDRESS__
31031 description: Name of VNF.
31036 description: Alternate name of VNF.
31041 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.
31046 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
31049 - name: regional-resource-zone
31051 description: Regional way of organizing pservers, source of truth should define values
31054 - name: prov-status
31056 description: Trigger for operational monitoring of this resource by Service Assurance systems.
31059 - name: heat-stack-id
31061 description: Heat stack id corresponding to this instance, managed by MSO
31068 - name: is-closed-loop-disabled
31072 - name: model-invariant-id
31074 description: the ASDC model id for this resource or service model.
31077 - name: model-version-id
31079 description: the ASDC model version for this resource or service model.
31082 - name: widget-model-id
31084 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
31087 - name: widget-model-version
31089 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
31094 description: Generic description of the type of NF
31097 - name: nf-function
31099 description: English description of Network function that the specific VNF deployment is providing
31104 description: role in the network that this model will be providing
31107 - name: nf-naming-code
31109 description: string assigned to this model used for naming purposes
31112 - name: interface-id
31114 description: ID of interface
31119 description: MAC address for the interface
31122 - name: network-name
31124 description: Name of the network
31127 - name: vlan-id-inner
31129 description: Inner VLAN tag
31135 description: This indicates the customers VPN ID associated with this vlan
31138 - name: vlan-id-inner
31140 description: Inner VLAN tag
31144 - name: neutron-network-id
31146 description: Neutron network id of the interface that address belongs to
31149 - name: neutron-subnet-id
31151 description: Neutron id of subnet that address belongs to
31157 summary: create or update an existing l3-interface-ipv4-address-list
31159 Create or update an existing l3-interface-ipv4-address-list.
31161 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31162 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31171 description: Response codes found in [response codes](https://wiki.onap.org/).
31175 description: Unique id of VNF. This is unique across the graph.
31178 example: __VNF-ID__
31179 - name: interface-name
31181 description: Name given to the interface
31184 example: __INTERFACE-NAME__
31185 - name: vlan-interface
31187 description: String that identifies the interface
31190 example: __VLAN-INTERFACE__
31191 - name: l3-interface-ipv4-address
31193 description: IP address
31196 example: __L3-INTERFACE-IPV4-ADDRESS__
31199 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
31202 $ref: "#/definitions/l3-interface-ipv4-address-list"
31206 summary: update an existing l3-interface-ipv4-address-list
31208 Update an existing l3-interface-ipv4-address-list
31210 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31211 The PUT operation will entirely replace an existing object.
31212 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31214 Other differences between PUT and PATCH are:
31216 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31217 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31218 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31219 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31228 description: Response codes found in [response codes](https://wiki.onap.org/).
31232 description: Unique id of VNF. This is unique across the graph.
31235 example: __VNF-ID__
31236 - name: interface-name
31238 description: Name given to the interface
31241 example: __INTERFACE-NAME__
31242 - name: vlan-interface
31244 description: String that identifies the interface
31247 example: __VLAN-INTERFACE__
31248 - name: l3-interface-ipv4-address
31250 description: IP address
31253 example: __L3-INTERFACE-IPV4-ADDRESS__
31256 description: l3-interface-ipv4-address-list object that needs to be created or updated.
31259 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
31263 summary: delete an existing l3-interface-ipv4-address-list
31264 description: delete an existing l3-interface-ipv4-address-list
31265 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31274 description: Response codes found in [response codes](https://wiki.onap.org/).
31278 description: Unique id of VNF. This is unique across the graph.
31281 example: __VNF-ID__
31282 - name: interface-name
31284 description: Name given to the interface
31287 example: __INTERFACE-NAME__
31288 - name: vlan-interface
31290 description: String that identifies the interface
31293 example: __VLAN-INTERFACE__
31294 - name: l3-interface-ipv4-address
31296 description: IP address
31299 example: __L3-INTERFACE-IPV4-ADDRESS__
31300 - name: resource-version
31302 description: resource-version for concurrency
31305 /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:
31309 summary: see node definition for valid relationships
31310 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
31319 description: Response codes found in [response codes](https://wiki.onap.org/).
31323 description: Unique id of VNF. This is unique across the graph.
31326 example: __VNF-ID__
31327 - name: interface-name
31329 description: Name given to the interface
31332 example: __INTERFACE-NAME__
31333 - name: vlan-interface
31335 description: String that identifies the interface
31338 example: __VLAN-INTERFACE__
31339 - name: l3-interface-ipv6-address
31341 description: IP address
31344 example: __L3-INTERFACE-IPV6-ADDRESS__
31347 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
31350 $ref: "#/definitions/relationship"
31354 summary: delete an existing relationship
31355 description: delete an existing relationship
31356 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
31365 description: Response codes found in [response codes](https://wiki.onap.org/).
31369 description: Unique id of VNF. This is unique across the graph.
31372 example: __VNF-ID__
31373 - name: interface-name
31375 description: Name given to the interface
31378 example: __INTERFACE-NAME__
31379 - name: vlan-interface
31381 description: String that identifies the interface
31384 example: __VLAN-INTERFACE__
31385 - name: l3-interface-ipv6-address
31387 description: IP address
31390 example: __L3-INTERFACE-IPV6-ADDRESS__
31391 /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}:
31395 summary: returns l3-interface-ipv6-address-list
31396 description: returns l3-interface-ipv6-address-list
31397 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31403 description: successful operation
31405 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
31407 description: Response codes found in [response codes](https://wiki.onap.org/).
31411 description: Unique id of VNF. This is unique across the graph.
31414 example: __VNF-ID__
31415 - name: interface-name
31417 description: Name given to the interface
31420 example: __INTERFACE-NAME__
31421 - name: vlan-interface
31423 description: String that identifies the interface
31426 example: __VLAN-INTERFACE__
31427 - name: l3-interface-ipv6-address
31429 description: IP address
31432 example: __L3-INTERFACE-IPV6-ADDRESS__
31435 description: Name of VNF.
31440 description: Alternate name of VNF.
31445 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.
31450 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
31453 - name: regional-resource-zone
31455 description: Regional way of organizing pservers, source of truth should define values
31458 - name: prov-status
31460 description: Trigger for operational monitoring of this resource by Service Assurance systems.
31463 - name: heat-stack-id
31465 description: Heat stack id corresponding to this instance, managed by MSO
31472 - name: is-closed-loop-disabled
31476 - name: model-invariant-id
31478 description: the ASDC model id for this resource or service model.
31481 - name: model-version-id
31483 description: the ASDC model version for this resource or service model.
31486 - name: widget-model-id
31488 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
31491 - name: widget-model-version
31493 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
31498 description: Generic description of the type of NF
31501 - name: nf-function
31503 description: English description of Network function that the specific VNF deployment is providing
31508 description: role in the network that this model will be providing
31511 - name: nf-naming-code
31513 description: string assigned to this model used for naming purposes
31516 - name: interface-id
31518 description: ID of interface
31523 description: MAC address for the interface
31526 - name: network-name
31528 description: Name of the network
31531 - name: vlan-id-inner
31533 description: Inner VLAN tag
31539 description: This indicates the customers VPN ID associated with this vlan
31542 - name: vlan-id-inner
31544 description: Inner VLAN tag
31548 - name: neutron-network-id
31550 description: Neutron network id of the interface that address belongs to
31553 - name: neutron-subnet-id
31555 description: Neutron id of subnet that address belongs to
31561 summary: create or update an existing l3-interface-ipv6-address-list
31563 Create or update an existing l3-interface-ipv6-address-list.
31565 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31566 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31575 description: Response codes found in [response codes](https://wiki.onap.org/).
31579 description: Unique id of VNF. This is unique across the graph.
31582 example: __VNF-ID__
31583 - name: interface-name
31585 description: Name given to the interface
31588 example: __INTERFACE-NAME__
31589 - name: vlan-interface
31591 description: String that identifies the interface
31594 example: __VLAN-INTERFACE__
31595 - name: l3-interface-ipv6-address
31597 description: IP address
31600 example: __L3-INTERFACE-IPV6-ADDRESS__
31603 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
31606 $ref: "#/definitions/l3-interface-ipv6-address-list"
31610 summary: update an existing l3-interface-ipv6-address-list
31612 Update an existing l3-interface-ipv6-address-list
31614 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31615 The PUT operation will entirely replace an existing object.
31616 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31618 Other differences between PUT and PATCH are:
31620 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31621 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31622 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31623 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31632 description: Response codes found in [response codes](https://wiki.onap.org/).
31636 description: Unique id of VNF. This is unique across the graph.
31639 example: __VNF-ID__
31640 - name: interface-name
31642 description: Name given to the interface
31645 example: __INTERFACE-NAME__
31646 - name: vlan-interface
31648 description: String that identifies the interface
31651 example: __VLAN-INTERFACE__
31652 - name: l3-interface-ipv6-address
31654 description: IP address
31657 example: __L3-INTERFACE-IPV6-ADDRESS__
31660 description: l3-interface-ipv6-address-list object that needs to be created or updated.
31663 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
31667 summary: delete an existing l3-interface-ipv6-address-list
31668 description: delete an existing l3-interface-ipv6-address-list
31669 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31678 description: Response codes found in [response codes](https://wiki.onap.org/).
31682 description: Unique id of VNF. This is unique across the graph.
31685 example: __VNF-ID__
31686 - name: interface-name
31688 description: Name given to the interface
31691 example: __INTERFACE-NAME__
31692 - name: vlan-interface
31694 description: String that identifies the interface
31697 example: __VLAN-INTERFACE__
31698 - name: l3-interface-ipv6-address
31700 description: IP address
31703 example: __L3-INTERFACE-IPV6-ADDRESS__
31704 - name: resource-version
31706 description: resource-version for concurrency
31709 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
31713 summary: returns vlan
31714 description: returns vlan
31715 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
31721 description: successful operation
31723 $ref: "#/getDefinitions/vlan"
31725 description: Response codes found in [response codes](https://wiki.onap.org/).
31729 description: Unique id of VNF. This is unique across the graph.
31732 example: __VNF-ID__
31733 - name: interface-name
31735 description: Name given to the interface
31738 example: __INTERFACE-NAME__
31739 - name: vlan-interface
31741 description: String that identifies the interface
31744 example: __VLAN-INTERFACE__
31747 description: Name of VNF.
31752 description: Alternate name of VNF.
31757 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.
31762 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
31765 - name: regional-resource-zone
31767 description: Regional way of organizing pservers, source of truth should define values
31770 - name: prov-status
31772 description: Trigger for operational monitoring of this resource by Service Assurance systems.
31775 - name: heat-stack-id
31777 description: Heat stack id corresponding to this instance, managed by MSO
31784 - name: is-closed-loop-disabled
31788 - name: model-invariant-id
31790 description: the ASDC model id for this resource or service model.
31793 - name: model-version-id
31795 description: the ASDC model version for this resource or service model.
31798 - name: widget-model-id
31800 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
31803 - name: widget-model-version
31805 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
31810 description: Generic description of the type of NF
31813 - name: nf-function
31815 description: English description of Network function that the specific VNF deployment is providing
31820 description: role in the network that this model will be providing
31823 - name: nf-naming-code
31825 description: string assigned to this model used for naming purposes
31828 - name: interface-id
31830 description: ID of interface
31835 description: MAC address for the interface
31838 - name: network-name
31840 description: Name of the network
31843 - name: vlan-id-inner
31845 description: Inner VLAN tag
31851 description: This indicates the customers VPN ID associated with this vlan
31857 summary: create or update an existing vlan
31859 Create or update an existing vlan.
31861 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31862 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
31871 description: Response codes found in [response codes](https://wiki.onap.org/).
31875 description: Unique id of VNF. This is unique across the graph.
31878 example: __VNF-ID__
31879 - name: interface-name
31881 description: Name given to the interface
31884 example: __INTERFACE-NAME__
31885 - name: vlan-interface
31887 description: String that identifies the interface
31890 example: __VLAN-INTERFACE__
31893 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
31896 $ref: "#/definitions/vlan"
31900 summary: update an existing vlan
31902 Update an existing vlan
31904 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31905 The PUT operation will entirely replace an existing object.
31906 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31908 Other differences between PUT and PATCH are:
31910 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31911 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31912 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31913 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
31922 description: Response codes found in [response codes](https://wiki.onap.org/).
31926 description: Unique id of VNF. This is unique across the graph.
31929 example: __VNF-ID__
31930 - name: interface-name
31932 description: Name given to the interface
31935 example: __INTERFACE-NAME__
31936 - name: vlan-interface
31938 description: String that identifies the interface
31941 example: __VLAN-INTERFACE__
31944 description: vlan object that needs to be created or updated.
31947 $ref: "#/patchDefinitions/vlan"
31951 summary: delete an existing vlan
31952 description: delete an existing vlan
31953 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
31962 description: Response codes found in [response codes](https://wiki.onap.org/).
31966 description: Unique id of VNF. This is unique across the graph.
31969 example: __VNF-ID__
31970 - name: interface-name
31972 description: Name given to the interface
31975 example: __INTERFACE-NAME__
31976 - name: vlan-interface
31978 description: String that identifies the interface
31981 example: __VLAN-INTERFACE__
31982 - name: resource-version
31984 description: resource-version for concurrency
31987 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans:
31991 summary: returns vlans
31992 description: returns vlans
31993 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans
31999 description: successful operation
32001 $ref: "#/getDefinitions/vlans"
32003 description: Response codes found in [response codes](https://wiki.onap.org/).
32007 description: Unique id of VNF. This is unique across the graph.
32010 example: __VNF-ID__
32011 - name: interface-name
32013 description: Name given to the interface
32016 example: __INTERFACE-NAME__
32019 description: Name of VNF.
32024 description: Alternate name of VNF.
32029 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.
32034 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
32037 - name: regional-resource-zone
32039 description: Regional way of organizing pservers, source of truth should define values
32042 - name: prov-status
32044 description: Trigger for operational monitoring of this resource by Service Assurance systems.
32047 - name: heat-stack-id
32049 description: Heat stack id corresponding to this instance, managed by MSO
32056 - name: is-closed-loop-disabled
32060 - name: model-invariant-id
32062 description: the ASDC model id for this resource or service model.
32065 - name: model-version-id
32067 description: the ASDC model version for this resource or service model.
32070 - name: widget-model-id
32072 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32075 - name: widget-model-version
32077 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32082 description: Generic description of the type of NF
32085 - name: nf-function
32087 description: English description of Network function that the specific VNF deployment is providing
32092 description: role in the network that this model will be providing
32095 - name: nf-naming-code
32097 description: string assigned to this model used for naming purposes
32100 - name: interface-id
32102 description: ID of interface
32107 description: MAC address for the interface
32110 - name: network-name
32112 description: Name of the network
32115 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
32119 summary: see node definition for valid relationships
32120 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
32129 description: Response codes found in [response codes](https://wiki.onap.org/).
32133 description: Unique id of VNF. This is unique across the graph.
32136 example: __VNF-ID__
32137 - name: interface-name
32139 description: Name given to the interface
32142 example: __INTERFACE-NAME__
32145 description: PCI ID used to identify the sriov-vf
32148 example: __PCI-ID__
32151 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
32154 $ref: "#/definitions/relationship"
32158 summary: delete an existing relationship
32159 description: delete an existing relationship
32160 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
32169 description: Response codes found in [response codes](https://wiki.onap.org/).
32173 description: Unique id of VNF. This is unique across the graph.
32176 example: __VNF-ID__
32177 - name: interface-name
32179 description: Name given to the interface
32182 example: __INTERFACE-NAME__
32185 description: PCI ID used to identify the sriov-vf
32188 example: __PCI-ID__
32189 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
32193 summary: returns sriov-vf
32194 description: returns sriov-vf
32195 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
32201 description: successful operation
32203 $ref: "#/getDefinitions/sriov-vf"
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__
32213 - name: interface-name
32215 description: Name given to the interface
32218 example: __INTERFACE-NAME__
32221 description: PCI ID used to identify the sriov-vf
32224 example: __PCI-ID__
32227 description: Name of VNF.
32232 description: Alternate name of VNF.
32237 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.
32242 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
32245 - name: regional-resource-zone
32247 description: Regional way of organizing pservers, source of truth should define values
32250 - name: prov-status
32252 description: Trigger for operational monitoring of this resource by Service Assurance systems.
32255 - name: heat-stack-id
32257 description: Heat stack id corresponding to this instance, managed by MSO
32264 - name: is-closed-loop-disabled
32268 - name: model-invariant-id
32270 description: the ASDC model id for this resource or service model.
32273 - name: model-version-id
32275 description: the ASDC model version for this resource or service model.
32278 - name: widget-model-id
32280 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32283 - name: widget-model-version
32285 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32290 description: Generic description of the type of NF
32293 - name: nf-function
32295 description: English description of Network function that the specific VNF deployment is providing
32300 description: role in the network that this model will be providing
32303 - name: nf-naming-code
32305 description: string assigned to this model used for naming purposes
32308 - name: interface-id
32310 description: ID of interface
32315 description: MAC address for the interface
32318 - name: network-name
32320 description: Name of the network
32323 - name: vf-vlan-filter
32325 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
32328 - name: vf-mac-filter
32330 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
32333 - name: vf-vlan-strip
32335 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
32338 - name: neutron-network-id
32340 description: Neutron network id of the interface
32346 summary: create or update an existing sriov-vf
32348 Create or update an existing sriov-vf.
32350 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32351 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
32360 description: Response codes found in [response codes](https://wiki.onap.org/).
32364 description: Unique id of VNF. This is unique across the graph.
32367 example: __VNF-ID__
32368 - name: interface-name
32370 description: Name given to the interface
32373 example: __INTERFACE-NAME__
32376 description: PCI ID used to identify the sriov-vf
32379 example: __PCI-ID__
32382 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
32385 $ref: "#/definitions/sriov-vf"
32389 summary: update an existing sriov-vf
32391 Update an existing sriov-vf
32393 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32394 The PUT operation will entirely replace an existing object.
32395 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32397 Other differences between PUT and PATCH are:
32399 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32400 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32401 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32402 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
32411 description: Response codes found in [response codes](https://wiki.onap.org/).
32415 description: Unique id of VNF. This is unique across the graph.
32418 example: __VNF-ID__
32419 - name: interface-name
32421 description: Name given to the interface
32424 example: __INTERFACE-NAME__
32427 description: PCI ID used to identify the sriov-vf
32430 example: __PCI-ID__
32433 description: sriov-vf object that needs to be created or updated.
32436 $ref: "#/patchDefinitions/sriov-vf"
32440 summary: delete an existing sriov-vf
32441 description: delete an existing sriov-vf
32442 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
32451 description: Response codes found in [response codes](https://wiki.onap.org/).
32455 description: Unique id of VNF. This is unique across the graph.
32458 example: __VNF-ID__
32459 - name: interface-name
32461 description: Name given to the interface
32464 example: __INTERFACE-NAME__
32467 description: PCI ID used to identify the sriov-vf
32470 example: __PCI-ID__
32471 - name: resource-version
32473 description: resource-version for concurrency
32476 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
32480 summary: returns sriov-vfs
32481 description: returns sriov-vfs
32482 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs
32488 description: successful operation
32490 $ref: "#/getDefinitions/sriov-vfs"
32492 description: Response codes found in [response codes](https://wiki.onap.org/).
32496 description: Unique id of VNF. This is unique across the graph.
32499 example: __VNF-ID__
32500 - name: interface-name
32502 description: Name given to the interface
32505 example: __INTERFACE-NAME__
32508 description: Name of VNF.
32513 description: Alternate name of VNF.
32518 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.
32523 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
32526 - name: regional-resource-zone
32528 description: Regional way of organizing pservers, source of truth should define values
32531 - name: prov-status
32533 description: Trigger for operational monitoring of this resource by Service Assurance systems.
32536 - name: heat-stack-id
32538 description: Heat stack id corresponding to this instance, managed by MSO
32545 - name: is-closed-loop-disabled
32549 - name: model-invariant-id
32551 description: the ASDC model id for this resource or service model.
32554 - name: model-version-id
32556 description: the ASDC model version for this resource or service model.
32559 - name: widget-model-id
32561 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32564 - name: widget-model-version
32566 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32571 description: Generic description of the type of NF
32574 - name: nf-function
32576 description: English description of Network function that the specific VNF deployment is providing
32581 description: role in the network that this model will be providing
32584 - name: nf-naming-code
32586 description: string assigned to this model used for naming purposes
32589 - name: interface-id
32591 description: ID of interface
32596 description: MAC address for the interface
32599 - name: network-name
32601 description: Name of the network
32604 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
32608 summary: see node definition for valid relationships
32609 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
32618 description: Response codes found in [response codes](https://wiki.onap.org/).
32622 description: Unique id of VNF. This is unique across the graph.
32625 example: __VNF-ID__
32626 - name: interface-name
32628 description: Name given to the interface
32631 example: __INTERFACE-NAME__
32634 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
32637 $ref: "#/definitions/relationship"
32641 summary: delete an existing relationship
32642 description: delete an existing relationship
32643 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
32652 description: Response codes found in [response codes](https://wiki.onap.org/).
32656 description: Unique id of VNF. This is unique across the graph.
32659 example: __VNF-ID__
32660 - name: interface-name
32662 description: Name given to the interface
32665 example: __INTERFACE-NAME__
32666 /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:
32670 summary: see node definition for valid relationships
32671 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
32680 description: Response codes found in [response codes](https://wiki.onap.org/).
32684 description: Unique id of VNF. This is unique across the graph.
32687 example: __VNF-ID__
32688 - name: interface-name
32690 description: Name given to the interface
32693 example: __INTERFACE-NAME__
32694 - name: l3-interface-ipv4-address
32696 description: IP address
32699 example: __L3-INTERFACE-IPV4-ADDRESS__
32702 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
32705 $ref: "#/definitions/relationship"
32709 summary: delete an existing relationship
32710 description: delete an existing relationship
32711 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
32720 description: Response codes found in [response codes](https://wiki.onap.org/).
32724 description: Unique id of VNF. This is unique across the graph.
32727 example: __VNF-ID__
32728 - name: interface-name
32730 description: Name given to the interface
32733 example: __INTERFACE-NAME__
32734 - name: l3-interface-ipv4-address
32736 description: IP address
32739 example: __L3-INTERFACE-IPV4-ADDRESS__
32740 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
32744 summary: returns l3-interface-ipv4-address-list
32745 description: returns l3-interface-ipv4-address-list
32746 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32752 description: successful operation
32754 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
32756 description: Response codes found in [response codes](https://wiki.onap.org/).
32760 description: Unique id of VNF. This is unique across the graph.
32763 example: __VNF-ID__
32764 - name: interface-name
32766 description: Name given to the interface
32769 example: __INTERFACE-NAME__
32770 - name: l3-interface-ipv4-address
32772 description: IP address
32775 example: __L3-INTERFACE-IPV4-ADDRESS__
32778 description: Name of VNF.
32783 description: Alternate name of VNF.
32788 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.
32793 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
32796 - name: regional-resource-zone
32798 description: Regional way of organizing pservers, source of truth should define values
32801 - name: prov-status
32803 description: Trigger for operational monitoring of this resource by Service Assurance systems.
32806 - name: heat-stack-id
32808 description: Heat stack id corresponding to this instance, managed by MSO
32815 - name: is-closed-loop-disabled
32819 - name: model-invariant-id
32821 description: the ASDC model id for this resource or service model.
32824 - name: model-version-id
32826 description: the ASDC model version for this resource or service model.
32829 - name: widget-model-id
32831 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32834 - name: widget-model-version
32836 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32841 description: Generic description of the type of NF
32844 - name: nf-function
32846 description: English description of Network function that the specific VNF deployment is providing
32851 description: role in the network that this model will be providing
32854 - name: nf-naming-code
32856 description: string assigned to this model used for naming purposes
32859 - name: interface-id
32861 description: ID of interface
32866 description: MAC address for the interface
32869 - name: network-name
32871 description: Name of the network
32874 - name: vlan-id-inner
32876 description: Inner VLAN tag
32880 - name: neutron-network-id
32882 description: Neutron network id of the interface that address belongs to
32885 - name: neutron-subnet-id
32887 description: Neutron id of subnet that address belongs to
32893 summary: create or update an existing l3-interface-ipv4-address-list
32895 Create or update an existing l3-interface-ipv4-address-list.
32897 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32898 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32907 description: Response codes found in [response codes](https://wiki.onap.org/).
32911 description: Unique id of VNF. This is unique across the graph.
32914 example: __VNF-ID__
32915 - name: interface-name
32917 description: Name given to the interface
32920 example: __INTERFACE-NAME__
32921 - name: l3-interface-ipv4-address
32923 description: IP address
32926 example: __L3-INTERFACE-IPV4-ADDRESS__
32929 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
32932 $ref: "#/definitions/l3-interface-ipv4-address-list"
32936 summary: update an existing l3-interface-ipv4-address-list
32938 Update an existing l3-interface-ipv4-address-list
32940 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32941 The PUT operation will entirely replace an existing object.
32942 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32944 Other differences between PUT and PATCH are:
32946 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32947 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32948 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32949 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32958 description: Response codes found in [response codes](https://wiki.onap.org/).
32962 description: Unique id of VNF. This is unique across the graph.
32965 example: __VNF-ID__
32966 - name: interface-name
32968 description: Name given to the interface
32971 example: __INTERFACE-NAME__
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 created or 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: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32998 description: Response codes found in [response codes](https://wiki.onap.org/).
33002 description: Unique id of VNF. This is unique across the graph.
33005 example: __VNF-ID__
33006 - name: interface-name
33008 description: Name given to the interface
33011 example: __INTERFACE-NAME__
33012 - name: l3-interface-ipv4-address
33014 description: IP address
33017 example: __L3-INTERFACE-IPV4-ADDRESS__
33018 - name: resource-version
33020 description: resource-version for concurrency
33023 /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:
33027 summary: see node definition for valid relationships
33028 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
33037 description: Response codes found in [response codes](https://wiki.onap.org/).
33041 description: Unique id of VNF. This is unique across the graph.
33044 example: __VNF-ID__
33045 - name: interface-name
33047 description: Name given to the interface
33050 example: __INTERFACE-NAME__
33051 - name: l3-interface-ipv6-address
33053 description: IP address
33056 example: __L3-INTERFACE-IPV6-ADDRESS__
33059 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
33062 $ref: "#/definitions/relationship"
33066 summary: delete an existing relationship
33067 description: delete an existing relationship
33068 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
33077 description: Response codes found in [response codes](https://wiki.onap.org/).
33081 description: Unique id of VNF. This is unique across the graph.
33084 example: __VNF-ID__
33085 - name: interface-name
33087 description: Name given to the interface
33090 example: __INTERFACE-NAME__
33091 - name: l3-interface-ipv6-address
33093 description: IP address
33096 example: __L3-INTERFACE-IPV6-ADDRESS__
33097 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
33101 summary: returns l3-interface-ipv6-address-list
33102 description: returns l3-interface-ipv6-address-list
33103 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
33109 description: successful operation
33111 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
33113 description: Response codes found in [response codes](https://wiki.onap.org/).
33117 description: Unique id of VNF. This is unique across the graph.
33120 example: __VNF-ID__
33121 - name: interface-name
33123 description: Name given to the interface
33126 example: __INTERFACE-NAME__
33127 - name: l3-interface-ipv6-address
33129 description: IP address
33132 example: __L3-INTERFACE-IPV6-ADDRESS__
33135 description: Name of VNF.
33140 description: Alternate name of VNF.
33145 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.
33150 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
33153 - name: regional-resource-zone
33155 description: Regional way of organizing pservers, source of truth should define values
33158 - name: prov-status
33160 description: Trigger for operational monitoring of this resource by Service Assurance systems.
33163 - name: heat-stack-id
33165 description: Heat stack id corresponding to this instance, managed by MSO
33172 - name: is-closed-loop-disabled
33176 - name: model-invariant-id
33178 description: the ASDC model id for this resource or service model.
33181 - name: model-version-id
33183 description: the ASDC model version for this resource or service model.
33186 - name: widget-model-id
33188 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33191 - name: widget-model-version
33193 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33198 description: Generic description of the type of NF
33201 - name: nf-function
33203 description: English description of Network function that the specific VNF deployment is providing
33208 description: role in the network that this model will be providing
33211 - name: nf-naming-code
33213 description: string assigned to this model used for naming purposes
33216 - name: interface-id
33218 description: ID of interface
33223 description: MAC address for the interface
33226 - name: network-name
33228 description: Name of the network
33231 - name: vlan-id-inner
33233 description: Inner VLAN tag
33237 - name: neutron-network-id
33239 description: Neutron network id of the interface that address belongs to
33242 - name: neutron-subnet-id
33244 description: Neutron id of subnet that address belongs to
33250 summary: create or update an existing l3-interface-ipv6-address-list
33252 Create or update an existing l3-interface-ipv6-address-list.
33254 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33255 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
33264 description: Response codes found in [response codes](https://wiki.onap.org/).
33268 description: Unique id of VNF. This is unique across the graph.
33271 example: __VNF-ID__
33272 - name: interface-name
33274 description: Name given to the interface
33277 example: __INTERFACE-NAME__
33278 - name: l3-interface-ipv6-address
33280 description: IP address
33283 example: __L3-INTERFACE-IPV6-ADDRESS__
33286 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
33289 $ref: "#/definitions/l3-interface-ipv6-address-list"
33293 summary: update an existing l3-interface-ipv6-address-list
33295 Update an existing l3-interface-ipv6-address-list
33297 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33298 The PUT operation will entirely replace an existing object.
33299 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33301 Other differences between PUT and PATCH are:
33303 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33304 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33305 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33306 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
33315 description: Response codes found in [response codes](https://wiki.onap.org/).
33319 description: Unique id of VNF. This is unique across the graph.
33322 example: __VNF-ID__
33323 - name: interface-name
33325 description: Name given to the interface
33328 example: __INTERFACE-NAME__
33329 - name: l3-interface-ipv6-address
33331 description: IP address
33334 example: __L3-INTERFACE-IPV6-ADDRESS__
33337 description: l3-interface-ipv6-address-list object that needs to be created or updated.
33340 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
33344 summary: delete an existing l3-interface-ipv6-address-list
33345 description: delete an existing l3-interface-ipv6-address-list
33346 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
33355 description: Response codes found in [response codes](https://wiki.onap.org/).
33359 description: Unique id of VNF. This is unique across the graph.
33362 example: __VNF-ID__
33363 - name: interface-name
33365 description: Name given to the interface
33368 example: __INTERFACE-NAME__
33369 - name: l3-interface-ipv6-address
33371 description: IP address
33374 example: __L3-INTERFACE-IPV6-ADDRESS__
33375 - name: resource-version
33377 description: resource-version for concurrency
33380 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}:
33384 summary: returns l-interface
33385 description: returns l-interface
33386 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface
33392 description: successful operation
33394 $ref: "#/getDefinitions/l-interface"
33396 description: Response codes found in [response codes](https://wiki.onap.org/).
33400 description: Unique id of VNF. This is unique across the graph.
33403 example: __VNF-ID__
33404 - name: interface-name
33406 description: Name given to the interface
33409 example: __INTERFACE-NAME__
33412 description: Name of VNF.
33417 description: Alternate name of VNF.
33422 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.
33427 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
33430 - name: regional-resource-zone
33432 description: Regional way of organizing pservers, source of truth should define values
33435 - name: prov-status
33437 description: Trigger for operational monitoring of this resource by Service Assurance systems.
33440 - name: heat-stack-id
33442 description: Heat stack id corresponding to this instance, managed by MSO
33449 - name: is-closed-loop-disabled
33453 - name: model-invariant-id
33455 description: the ASDC model id for this resource or service model.
33458 - name: model-version-id
33460 description: the ASDC model version for this resource or service model.
33463 - name: widget-model-id
33465 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33468 - name: widget-model-version
33470 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33475 description: Generic description of the type of NF
33478 - name: nf-function
33480 description: English description of Network function that the specific VNF deployment is providing
33485 description: role in the network that this model will be providing
33488 - name: nf-naming-code
33490 description: string assigned to this model used for naming purposes
33493 - name: interface-id
33495 description: ID of interface
33500 description: MAC address for the interface
33503 - name: network-name
33505 description: Name of the network
33511 summary: create or update an existing l-interface
33513 Create or update an existing l-interface.
33515 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33516 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
33525 description: Response codes found in [response codes](https://wiki.onap.org/).
33529 description: Unique id of VNF. This is unique across the graph.
33532 example: __VNF-ID__
33533 - name: interface-name
33535 description: Name given to the interface
33538 example: __INTERFACE-NAME__
33541 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
33544 $ref: "#/definitions/l-interface"
33548 summary: update an existing l-interface
33550 Update an existing l-interface
33552 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33553 The PUT operation will entirely replace an existing object.
33554 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33556 Other differences between PUT and PATCH are:
33558 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33559 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33560 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33561 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
33570 description: Response codes found in [response codes](https://wiki.onap.org/).
33574 description: Unique id of VNF. This is unique across the graph.
33577 example: __VNF-ID__
33578 - name: interface-name
33580 description: Name given to the interface
33583 example: __INTERFACE-NAME__
33586 description: l-interface object that needs to be created or updated.
33589 $ref: "#/patchDefinitions/l-interface"
33593 summary: delete an existing l-interface
33594 description: delete an existing l-interface
33595 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface
33604 description: Response codes found in [response codes](https://wiki.onap.org/).
33608 description: Unique id of VNF. This is unique across the graph.
33611 example: __VNF-ID__
33612 - name: interface-name
33614 description: Name given to the interface
33617 example: __INTERFACE-NAME__
33618 - name: resource-version
33620 description: resource-version for concurrency
33623 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces:
33627 summary: returns l-interfaces
33628 description: returns l-interfaces
33629 operationId: getNetworkGenericVnfsGenericVnfLInterfaces
33635 description: successful operation
33637 $ref: "#/getDefinitions/l-interfaces"
33639 description: Response codes found in [response codes](https://wiki.onap.org/).
33643 description: Unique id of VNF. This is unique across the graph.
33646 example: __VNF-ID__
33649 description: Name of VNF.
33654 description: Alternate name of VNF.
33659 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.
33664 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
33667 - name: regional-resource-zone
33669 description: Regional way of organizing pservers, source of truth should define values
33672 - name: prov-status
33674 description: Trigger for operational monitoring of this resource by Service Assurance systems.
33677 - name: heat-stack-id
33679 description: Heat stack id corresponding to this instance, managed by MSO
33686 - name: is-closed-loop-disabled
33690 - name: model-invariant-id
33692 description: the ASDC model id for this resource or service model.
33695 - name: model-version-id
33697 description: the ASDC model version for this resource or service model.
33700 - name: widget-model-id
33702 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33705 - name: widget-model-version
33707 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33712 description: Generic description of the type of NF
33715 - name: nf-function
33717 description: English description of Network function that the specific VNF deployment is providing
33722 description: role in the network that this model will be providing
33725 - name: nf-naming-code
33727 description: string assigned to this model used for naming purposes
33730 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
33734 summary: see node definition for valid relationships
33735 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
33744 description: Response codes found in [response codes](https://wiki.onap.org/).
33748 description: Unique id of VNF. This is unique across the graph.
33751 example: __VNF-ID__
33752 - name: interface-name
33754 description: Name that identifies the link aggregate interface
33757 example: __INTERFACE-NAME__
33760 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
33763 $ref: "#/definitions/relationship"
33767 summary: delete an existing relationship
33768 description: delete an existing relationship
33769 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
33778 description: Response codes found in [response codes](https://wiki.onap.org/).
33782 description: Unique id of VNF. This is unique across the graph.
33785 example: __VNF-ID__
33786 - name: interface-name
33788 description: Name that identifies the link aggregate interface
33791 example: __INTERFACE-NAME__
33792 /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:
33796 summary: see node definition for valid relationships
33797 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
33806 description: Response codes found in [response codes](https://wiki.onap.org/).
33810 description: Unique id of VNF. This is unique across the graph.
33813 example: __VNF-ID__
33814 - name: interface-name
33816 description: Name that identifies the link aggregate interface
33819 example: __INTERFACE-NAME__
33820 - name: interface-name
33822 description: Name given to the interface
33825 example: __INTERFACE-NAME__
33826 - name: vlan-interface
33828 description: String that identifies the interface
33831 example: __VLAN-INTERFACE__
33834 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
33837 $ref: "#/definitions/relationship"
33841 summary: delete an existing relationship
33842 description: delete an existing relationship
33843 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
33852 description: Response codes found in [response codes](https://wiki.onap.org/).
33856 description: Unique id of VNF. This is unique across the graph.
33859 example: __VNF-ID__
33860 - name: interface-name
33862 description: Name that identifies the link aggregate interface
33865 example: __INTERFACE-NAME__
33866 - name: interface-name
33868 description: Name given to the interface
33871 example: __INTERFACE-NAME__
33872 - name: vlan-interface
33874 description: String that identifies the interface
33877 example: __VLAN-INTERFACE__
33878 /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:
33882 summary: see node definition for valid relationships
33883 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
33892 description: Response codes found in [response codes](https://wiki.onap.org/).
33896 description: Unique id of VNF. This is unique across the graph.
33899 example: __VNF-ID__
33900 - name: interface-name
33902 description: Name that identifies the link aggregate interface
33905 example: __INTERFACE-NAME__
33906 - name: interface-name
33908 description: Name given to the interface
33911 example: __INTERFACE-NAME__
33912 - name: vlan-interface
33914 description: String that identifies the interface
33917 example: __VLAN-INTERFACE__
33918 - name: l3-interface-ipv4-address
33920 description: IP address
33923 example: __L3-INTERFACE-IPV4-ADDRESS__
33926 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
33929 $ref: "#/definitions/relationship"
33933 summary: delete an existing relationship
33934 description: delete an existing relationship
33935 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
33944 description: Response codes found in [response codes](https://wiki.onap.org/).
33948 description: Unique id of VNF. This is unique across the graph.
33951 example: __VNF-ID__
33952 - name: interface-name
33954 description: Name that identifies the link aggregate interface
33957 example: __INTERFACE-NAME__
33958 - name: interface-name
33960 description: Name given to the interface
33963 example: __INTERFACE-NAME__
33964 - name: vlan-interface
33966 description: String that identifies the interface
33969 example: __VLAN-INTERFACE__
33970 - name: l3-interface-ipv4-address
33972 description: IP address
33975 example: __L3-INTERFACE-IPV4-ADDRESS__
33976 /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}:
33980 summary: returns l3-interface-ipv4-address-list
33981 description: returns l3-interface-ipv4-address-list
33982 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33988 description: successful operation
33990 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
33992 description: Response codes found in [response codes](https://wiki.onap.org/).
33996 description: Unique id of VNF. This is unique across the graph.
33999 example: __VNF-ID__
34000 - name: interface-name
34002 description: Name that identifies the link aggregate interface
34005 example: __INTERFACE-NAME__
34006 - name: interface-name
34008 description: Name given to the interface
34011 example: __INTERFACE-NAME__
34012 - name: vlan-interface
34014 description: String that identifies the interface
34017 example: __VLAN-INTERFACE__
34018 - name: l3-interface-ipv4-address
34020 description: IP address
34023 example: __L3-INTERFACE-IPV4-ADDRESS__
34026 description: Name of VNF.
34031 description: Alternate name of VNF.
34036 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.
34041 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
34044 - name: regional-resource-zone
34046 description: Regional way of organizing pservers, source of truth should define values
34049 - name: prov-status
34051 description: Trigger for operational monitoring of this resource by Service Assurance systems.
34054 - name: heat-stack-id
34056 description: Heat stack id corresponding to this instance, managed by MSO
34063 - name: is-closed-loop-disabled
34067 - name: model-invariant-id
34069 description: the ASDC model id for this resource or service model.
34072 - name: model-version-id
34074 description: the ASDC model version for this resource or service model.
34077 - name: widget-model-id
34079 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34082 - name: widget-model-version
34084 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34089 description: Generic description of the type of NF
34092 - name: nf-function
34094 description: English description of Network function that the specific VNF deployment is providing
34099 description: role in the network that this model will be providing
34102 - name: nf-naming-code
34104 description: string assigned to this model used for naming purposes
34107 - name: interface-id
34109 description: ID of interface
34112 - name: interface-role
34114 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
34117 - name: interface-id
34119 description: ID of interface
34124 description: MAC address for the interface
34127 - name: network-name
34129 description: Name of the network
34132 - name: vlan-id-inner
34134 description: Inner VLAN tag
34140 description: This indicates the customers VPN ID associated with this vlan
34143 - name: vlan-id-inner
34145 description: Inner VLAN tag
34149 - name: neutron-network-id
34151 description: Neutron network id of the interface that address belongs to
34154 - name: neutron-subnet-id
34156 description: Neutron id of subnet that address belongs to
34162 summary: create or update an existing l3-interface-ipv4-address-list
34164 Create or update an existing l3-interface-ipv4-address-list.
34166 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34167 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
34176 description: Response codes found in [response codes](https://wiki.onap.org/).
34180 description: Unique id of VNF. This is unique across the graph.
34183 example: __VNF-ID__
34184 - name: interface-name
34186 description: Name that identifies the link aggregate interface
34189 example: __INTERFACE-NAME__
34190 - name: interface-name
34192 description: Name given to the interface
34195 example: __INTERFACE-NAME__
34196 - name: vlan-interface
34198 description: String that identifies the interface
34201 example: __VLAN-INTERFACE__
34202 - name: l3-interface-ipv4-address
34204 description: IP address
34207 example: __L3-INTERFACE-IPV4-ADDRESS__
34210 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
34213 $ref: "#/definitions/l3-interface-ipv4-address-list"
34217 summary: update an existing l3-interface-ipv4-address-list
34219 Update an existing l3-interface-ipv4-address-list
34221 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34222 The PUT operation will entirely replace an existing object.
34223 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34225 Other differences between PUT and PATCH are:
34227 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34228 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34229 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34230 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
34239 description: Response codes found in [response codes](https://wiki.onap.org/).
34243 description: Unique id of VNF. This is unique across the graph.
34246 example: __VNF-ID__
34247 - name: interface-name
34249 description: Name that identifies the link aggregate interface
34252 example: __INTERFACE-NAME__
34253 - name: interface-name
34255 description: Name given to the interface
34258 example: __INTERFACE-NAME__
34259 - name: vlan-interface
34261 description: String that identifies the interface
34264 example: __VLAN-INTERFACE__
34265 - name: l3-interface-ipv4-address
34267 description: IP address
34270 example: __L3-INTERFACE-IPV4-ADDRESS__
34273 description: l3-interface-ipv4-address-list object that needs to be created or updated.
34276 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
34280 summary: delete an existing l3-interface-ipv4-address-list
34281 description: delete an existing l3-interface-ipv4-address-list
34282 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
34291 description: Response codes found in [response codes](https://wiki.onap.org/).
34295 description: Unique id of VNF. This is unique across the graph.
34298 example: __VNF-ID__
34299 - name: interface-name
34301 description: Name that identifies the link aggregate interface
34304 example: __INTERFACE-NAME__
34305 - name: interface-name
34307 description: Name given to the interface
34310 example: __INTERFACE-NAME__
34311 - name: vlan-interface
34313 description: String that identifies the interface
34316 example: __VLAN-INTERFACE__
34317 - name: l3-interface-ipv4-address
34319 description: IP address
34322 example: __L3-INTERFACE-IPV4-ADDRESS__
34323 - name: resource-version
34325 description: resource-version for concurrency
34328 /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:
34332 summary: see node definition for valid relationships
34333 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
34342 description: Response codes found in [response codes](https://wiki.onap.org/).
34346 description: Unique id of VNF. This is unique across the graph.
34349 example: __VNF-ID__
34350 - name: interface-name
34352 description: Name that identifies the link aggregate interface
34355 example: __INTERFACE-NAME__
34356 - name: interface-name
34358 description: Name given to the interface
34361 example: __INTERFACE-NAME__
34362 - name: vlan-interface
34364 description: String that identifies the interface
34367 example: __VLAN-INTERFACE__
34368 - name: l3-interface-ipv6-address
34370 description: IP address
34373 example: __L3-INTERFACE-IPV6-ADDRESS__
34376 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
34379 $ref: "#/definitions/relationship"
34383 summary: delete an existing relationship
34384 description: delete an existing relationship
34385 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
34394 description: Response codes found in [response codes](https://wiki.onap.org/).
34398 description: Unique id of VNF. This is unique across the graph.
34401 example: __VNF-ID__
34402 - name: interface-name
34404 description: Name that identifies the link aggregate interface
34407 example: __INTERFACE-NAME__
34408 - name: interface-name
34410 description: Name given to the interface
34413 example: __INTERFACE-NAME__
34414 - name: vlan-interface
34416 description: String that identifies the interface
34419 example: __VLAN-INTERFACE__
34420 - name: l3-interface-ipv6-address
34422 description: IP address
34425 example: __L3-INTERFACE-IPV6-ADDRESS__
34426 /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}:
34430 summary: returns l3-interface-ipv6-address-list
34431 description: returns l3-interface-ipv6-address-list
34432 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34438 description: successful operation
34440 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
34442 description: Response codes found in [response codes](https://wiki.onap.org/).
34446 description: Unique id of VNF. This is unique across the graph.
34449 example: __VNF-ID__
34450 - name: interface-name
34452 description: Name that identifies the link aggregate interface
34455 example: __INTERFACE-NAME__
34456 - name: interface-name
34458 description: Name given to the interface
34461 example: __INTERFACE-NAME__
34462 - name: vlan-interface
34464 description: String that identifies the interface
34467 example: __VLAN-INTERFACE__
34468 - name: l3-interface-ipv6-address
34470 description: IP address
34473 example: __L3-INTERFACE-IPV6-ADDRESS__
34476 description: Name of VNF.
34481 description: Alternate name of VNF.
34486 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.
34491 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
34494 - name: regional-resource-zone
34496 description: Regional way of organizing pservers, source of truth should define values
34499 - name: prov-status
34501 description: Trigger for operational monitoring of this resource by Service Assurance systems.
34504 - name: heat-stack-id
34506 description: Heat stack id corresponding to this instance, managed by MSO
34513 - name: is-closed-loop-disabled
34517 - name: model-invariant-id
34519 description: the ASDC model id for this resource or service model.
34522 - name: model-version-id
34524 description: the ASDC model version for this resource or service model.
34527 - name: widget-model-id
34529 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34532 - name: widget-model-version
34534 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34539 description: Generic description of the type of NF
34542 - name: nf-function
34544 description: English description of Network function that the specific VNF deployment is providing
34549 description: role in the network that this model will be providing
34552 - name: nf-naming-code
34554 description: string assigned to this model used for naming purposes
34557 - name: interface-id
34559 description: ID of interface
34562 - name: interface-role
34564 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
34567 - name: interface-id
34569 description: ID of interface
34574 description: MAC address for the interface
34577 - name: network-name
34579 description: Name of the network
34582 - name: vlan-id-inner
34584 description: Inner VLAN tag
34590 description: This indicates the customers VPN ID associated with this vlan
34593 - name: vlan-id-inner
34595 description: Inner VLAN tag
34599 - name: neutron-network-id
34601 description: Neutron network id of the interface that address belongs to
34604 - name: neutron-subnet-id
34606 description: Neutron id of subnet that address belongs to
34612 summary: create or update an existing l3-interface-ipv6-address-list
34614 Create or update an existing l3-interface-ipv6-address-list.
34616 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34617 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34626 description: Response codes found in [response codes](https://wiki.onap.org/).
34630 description: Unique id of VNF. This is unique across the graph.
34633 example: __VNF-ID__
34634 - name: interface-name
34636 description: Name that identifies the link aggregate interface
34639 example: __INTERFACE-NAME__
34640 - name: interface-name
34642 description: Name given to the interface
34645 example: __INTERFACE-NAME__
34646 - name: vlan-interface
34648 description: String that identifies the interface
34651 example: __VLAN-INTERFACE__
34652 - name: l3-interface-ipv6-address
34654 description: IP address
34657 example: __L3-INTERFACE-IPV6-ADDRESS__
34660 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
34663 $ref: "#/definitions/l3-interface-ipv6-address-list"
34667 summary: update an existing l3-interface-ipv6-address-list
34669 Update an existing l3-interface-ipv6-address-list
34671 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34672 The PUT operation will entirely replace an existing object.
34673 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34675 Other differences between PUT and PATCH are:
34677 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34678 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34679 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34680 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34689 description: Response codes found in [response codes](https://wiki.onap.org/).
34693 description: Unique id of VNF. This is unique across the graph.
34696 example: __VNF-ID__
34697 - name: interface-name
34699 description: Name that identifies the link aggregate interface
34702 example: __INTERFACE-NAME__
34703 - name: interface-name
34705 description: Name given to the interface
34708 example: __INTERFACE-NAME__
34709 - name: vlan-interface
34711 description: String that identifies the interface
34714 example: __VLAN-INTERFACE__
34715 - name: l3-interface-ipv6-address
34717 description: IP address
34720 example: __L3-INTERFACE-IPV6-ADDRESS__
34723 description: l3-interface-ipv6-address-list object that needs to be created or updated.
34726 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
34730 summary: delete an existing l3-interface-ipv6-address-list
34731 description: delete an existing l3-interface-ipv6-address-list
34732 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34741 description: Response codes found in [response codes](https://wiki.onap.org/).
34745 description: Unique id of VNF. This is unique across the graph.
34748 example: __VNF-ID__
34749 - name: interface-name
34751 description: Name that identifies the link aggregate interface
34754 example: __INTERFACE-NAME__
34755 - name: interface-name
34757 description: Name given to the interface
34760 example: __INTERFACE-NAME__
34761 - name: vlan-interface
34763 description: String that identifies the interface
34766 example: __VLAN-INTERFACE__
34767 - name: l3-interface-ipv6-address
34769 description: IP address
34772 example: __L3-INTERFACE-IPV6-ADDRESS__
34773 - name: resource-version
34775 description: resource-version for concurrency
34778 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
34782 summary: returns vlan
34783 description: returns vlan
34784 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
34790 description: successful operation
34792 $ref: "#/getDefinitions/vlan"
34794 description: Response codes found in [response codes](https://wiki.onap.org/).
34798 description: Unique id of VNF. This is unique across the graph.
34801 example: __VNF-ID__
34802 - name: interface-name
34804 description: Name that identifies the link aggregate interface
34807 example: __INTERFACE-NAME__
34808 - name: interface-name
34810 description: Name given to the interface
34813 example: __INTERFACE-NAME__
34814 - name: vlan-interface
34816 description: String that identifies the interface
34819 example: __VLAN-INTERFACE__
34822 description: Name of VNF.
34827 description: Alternate name of VNF.
34832 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.
34837 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
34840 - name: regional-resource-zone
34842 description: Regional way of organizing pservers, source of truth should define values
34845 - name: prov-status
34847 description: Trigger for operational monitoring of this resource by Service Assurance systems.
34850 - name: heat-stack-id
34852 description: Heat stack id corresponding to this instance, managed by MSO
34859 - name: is-closed-loop-disabled
34863 - name: model-invariant-id
34865 description: the ASDC model id for this resource or service model.
34868 - name: model-version-id
34870 description: the ASDC model version for this resource or service model.
34873 - name: widget-model-id
34875 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34878 - name: widget-model-version
34880 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34885 description: Generic description of the type of NF
34888 - name: nf-function
34890 description: English description of Network function that the specific VNF deployment is providing
34895 description: role in the network that this model will be providing
34898 - name: nf-naming-code
34900 description: string assigned to this model used for naming purposes
34903 - name: interface-id
34905 description: ID of interface
34908 - name: interface-role
34910 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
34913 - name: interface-id
34915 description: ID of interface
34920 description: MAC address for the interface
34923 - name: network-name
34925 description: Name of the network
34928 - name: vlan-id-inner
34930 description: Inner VLAN tag
34936 description: This indicates the customers VPN ID associated with this vlan
34942 summary: create or update an existing vlan
34944 Create or update an existing vlan.
34946 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34947 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
34956 description: Response codes found in [response codes](https://wiki.onap.org/).
34960 description: Unique id of VNF. This is unique across the graph.
34963 example: __VNF-ID__
34964 - name: interface-name
34966 description: Name that identifies the link aggregate interface
34969 example: __INTERFACE-NAME__
34970 - name: interface-name
34972 description: Name given to the interface
34975 example: __INTERFACE-NAME__
34976 - name: vlan-interface
34978 description: String that identifies the interface
34981 example: __VLAN-INTERFACE__
34984 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
34987 $ref: "#/definitions/vlan"
34991 summary: update an existing vlan
34993 Update an existing vlan
34995 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34996 The PUT operation will entirely replace an existing object.
34997 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34999 Other differences between PUT and PATCH are:
35001 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35002 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35003 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35004 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
35013 description: Response codes found in [response codes](https://wiki.onap.org/).
35017 description: Unique id of VNF. This is unique across the graph.
35020 example: __VNF-ID__
35021 - name: interface-name
35023 description: Name that identifies the link aggregate interface
35026 example: __INTERFACE-NAME__
35027 - name: interface-name
35029 description: Name given to the interface
35032 example: __INTERFACE-NAME__
35033 - name: vlan-interface
35035 description: String that identifies the interface
35038 example: __VLAN-INTERFACE__
35041 description: vlan object that needs to be created or updated.
35044 $ref: "#/patchDefinitions/vlan"
35048 summary: delete an existing vlan
35049 description: delete an existing vlan
35050 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
35059 description: Response codes found in [response codes](https://wiki.onap.org/).
35063 description: Unique id of VNF. This is unique across the graph.
35066 example: __VNF-ID__
35067 - name: interface-name
35069 description: Name that identifies the link aggregate interface
35072 example: __INTERFACE-NAME__
35073 - name: interface-name
35075 description: Name given to the interface
35078 example: __INTERFACE-NAME__
35079 - name: vlan-interface
35081 description: String that identifies the interface
35084 example: __VLAN-INTERFACE__
35085 - name: resource-version
35087 description: resource-version for concurrency
35090 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
35094 summary: returns vlans
35095 description: returns vlans
35096 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
35102 description: successful operation
35104 $ref: "#/getDefinitions/vlans"
35106 description: Response codes found in [response codes](https://wiki.onap.org/).
35110 description: Unique id of VNF. This is unique across the graph.
35113 example: __VNF-ID__
35114 - name: interface-name
35116 description: Name that identifies the link aggregate interface
35119 example: __INTERFACE-NAME__
35120 - name: interface-name
35122 description: Name given to the interface
35125 example: __INTERFACE-NAME__
35128 description: Name of VNF.
35133 description: Alternate name of VNF.
35138 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.
35143 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
35146 - name: regional-resource-zone
35148 description: Regional way of organizing pservers, source of truth should define values
35151 - name: prov-status
35153 description: Trigger for operational monitoring of this resource by Service Assurance systems.
35156 - name: heat-stack-id
35158 description: Heat stack id corresponding to this instance, managed by MSO
35165 - name: is-closed-loop-disabled
35169 - name: model-invariant-id
35171 description: the ASDC model id for this resource or service model.
35174 - name: model-version-id
35176 description: the ASDC model version for this resource or service model.
35179 - name: widget-model-id
35181 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35184 - name: widget-model-version
35186 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35191 description: Generic description of the type of NF
35194 - name: nf-function
35196 description: English description of Network function that the specific VNF deployment is providing
35201 description: role in the network that this model will be providing
35204 - name: nf-naming-code
35206 description: string assigned to this model used for naming purposes
35209 - name: interface-id
35211 description: ID of interface
35214 - name: interface-role
35216 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
35219 - name: interface-id
35221 description: ID of interface
35226 description: MAC address for the interface
35229 - name: network-name
35231 description: Name of the network
35234 /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:
35238 summary: see node definition for valid relationships
35239 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
35248 description: Response codes found in [response codes](https://wiki.onap.org/).
35252 description: Unique id of VNF. This is unique across the graph.
35255 example: __VNF-ID__
35256 - name: interface-name
35258 description: Name that identifies the link aggregate interface
35261 example: __INTERFACE-NAME__
35262 - name: interface-name
35264 description: Name given to the interface
35267 example: __INTERFACE-NAME__
35270 description: PCI ID used to identify the sriov-vf
35273 example: __PCI-ID__
35276 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
35279 $ref: "#/definitions/relationship"
35283 summary: delete an existing relationship
35284 description: delete an existing relationship
35285 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
35294 description: Response codes found in [response codes](https://wiki.onap.org/).
35298 description: Unique id of VNF. This is unique across the graph.
35301 example: __VNF-ID__
35302 - name: interface-name
35304 description: Name that identifies the link aggregate interface
35307 example: __INTERFACE-NAME__
35308 - name: interface-name
35310 description: Name given to the interface
35313 example: __INTERFACE-NAME__
35316 description: PCI ID used to identify the sriov-vf
35319 example: __PCI-ID__
35320 /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}:
35324 summary: returns sriov-vf
35325 description: returns sriov-vf
35326 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
35332 description: successful operation
35334 $ref: "#/getDefinitions/sriov-vf"
35336 description: Response codes found in [response codes](https://wiki.onap.org/).
35340 description: Unique id of VNF. This is unique across the graph.
35343 example: __VNF-ID__
35344 - name: interface-name
35346 description: Name that identifies the link aggregate interface
35349 example: __INTERFACE-NAME__
35350 - name: interface-name
35352 description: Name given to the interface
35355 example: __INTERFACE-NAME__
35358 description: PCI ID used to identify the sriov-vf
35361 example: __PCI-ID__
35364 description: Name of VNF.
35369 description: Alternate name of VNF.
35374 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.
35379 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
35382 - name: regional-resource-zone
35384 description: Regional way of organizing pservers, source of truth should define values
35387 - name: prov-status
35389 description: Trigger for operational monitoring of this resource by Service Assurance systems.
35392 - name: heat-stack-id
35394 description: Heat stack id corresponding to this instance, managed by MSO
35401 - name: is-closed-loop-disabled
35405 - name: model-invariant-id
35407 description: the ASDC model id for this resource or service model.
35410 - name: model-version-id
35412 description: the ASDC model version for this resource or service model.
35415 - name: widget-model-id
35417 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35420 - name: widget-model-version
35422 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35427 description: Generic description of the type of NF
35430 - name: nf-function
35432 description: English description of Network function that the specific VNF deployment is providing
35437 description: role in the network that this model will be providing
35440 - name: nf-naming-code
35442 description: string assigned to this model used for naming purposes
35445 - name: interface-id
35447 description: ID of interface
35450 - name: interface-role
35452 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
35455 - name: interface-id
35457 description: ID of interface
35462 description: MAC address for the interface
35465 - name: network-name
35467 description: Name of the network
35470 - name: vf-vlan-filter
35472 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
35475 - name: vf-mac-filter
35477 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
35480 - name: vf-vlan-strip
35482 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
35485 - name: neutron-network-id
35487 description: Neutron network id of the interface
35493 summary: create or update an existing sriov-vf
35495 Create or update an existing sriov-vf.
35497 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35498 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
35507 description: Response codes found in [response codes](https://wiki.onap.org/).
35511 description: Unique id of VNF. This is unique across the graph.
35514 example: __VNF-ID__
35515 - name: interface-name
35517 description: Name that identifies the link aggregate interface
35520 example: __INTERFACE-NAME__
35521 - name: interface-name
35523 description: Name given to the interface
35526 example: __INTERFACE-NAME__
35529 description: PCI ID used to identify the sriov-vf
35532 example: __PCI-ID__
35535 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
35538 $ref: "#/definitions/sriov-vf"
35542 summary: update an existing sriov-vf
35544 Update an existing sriov-vf
35546 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35547 The PUT operation will entirely replace an existing object.
35548 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35550 Other differences between PUT and PATCH are:
35552 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35553 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35554 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35555 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
35564 description: Response codes found in [response codes](https://wiki.onap.org/).
35568 description: Unique id of VNF. This is unique across the graph.
35571 example: __VNF-ID__
35572 - name: interface-name
35574 description: Name that identifies the link aggregate interface
35577 example: __INTERFACE-NAME__
35578 - name: interface-name
35580 description: Name given to the interface
35583 example: __INTERFACE-NAME__
35586 description: PCI ID used to identify the sriov-vf
35589 example: __PCI-ID__
35592 description: sriov-vf object that needs to be created or updated.
35595 $ref: "#/patchDefinitions/sriov-vf"
35599 summary: delete an existing sriov-vf
35600 description: delete an existing sriov-vf
35601 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
35610 description: Response codes found in [response codes](https://wiki.onap.org/).
35614 description: Unique id of VNF. This is unique across the graph.
35617 example: __VNF-ID__
35618 - name: interface-name
35620 description: Name that identifies the link aggregate interface
35623 example: __INTERFACE-NAME__
35624 - name: interface-name
35626 description: Name given to the interface
35629 example: __INTERFACE-NAME__
35632 description: PCI ID used to identify the sriov-vf
35635 example: __PCI-ID__
35636 - name: resource-version
35638 description: resource-version for concurrency
35641 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
35645 summary: returns sriov-vfs
35646 description: returns sriov-vfs
35647 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
35653 description: successful operation
35655 $ref: "#/getDefinitions/sriov-vfs"
35657 description: Response codes found in [response codes](https://wiki.onap.org/).
35661 description: Unique id of VNF. This is unique across the graph.
35664 example: __VNF-ID__
35665 - name: interface-name
35667 description: Name that identifies the link aggregate interface
35670 example: __INTERFACE-NAME__
35671 - name: interface-name
35673 description: Name given to the interface
35676 example: __INTERFACE-NAME__
35679 description: Name of VNF.
35684 description: Alternate name of VNF.
35689 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.
35694 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
35697 - name: regional-resource-zone
35699 description: Regional way of organizing pservers, source of truth should define values
35702 - name: prov-status
35704 description: Trigger for operational monitoring of this resource by Service Assurance systems.
35707 - name: heat-stack-id
35709 description: Heat stack id corresponding to this instance, managed by MSO
35716 - name: is-closed-loop-disabled
35720 - name: model-invariant-id
35722 description: the ASDC model id for this resource or service model.
35725 - name: model-version-id
35727 description: the ASDC model version for this resource or service model.
35730 - name: widget-model-id
35732 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35735 - name: widget-model-version
35737 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35742 description: Generic description of the type of NF
35745 - name: nf-function
35747 description: English description of Network function that the specific VNF deployment is providing
35752 description: role in the network that this model will be providing
35755 - name: nf-naming-code
35757 description: string assigned to this model used for naming purposes
35760 - name: interface-id
35762 description: ID of interface
35765 - name: interface-role
35767 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
35770 - name: interface-id
35772 description: ID of interface
35777 description: MAC address for the interface
35780 - name: network-name
35782 description: Name of the network
35785 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
35789 summary: see node definition for valid relationships
35790 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
35799 description: Response codes found in [response codes](https://wiki.onap.org/).
35803 description: Unique id of VNF. This is unique across the graph.
35806 example: __VNF-ID__
35807 - name: interface-name
35809 description: Name that identifies the link aggregate interface
35812 example: __INTERFACE-NAME__
35813 - name: interface-name
35815 description: Name given to the interface
35818 example: __INTERFACE-NAME__
35821 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
35824 $ref: "#/definitions/relationship"
35828 summary: delete an existing relationship
35829 description: delete an existing relationship
35830 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
35839 description: Response codes found in [response codes](https://wiki.onap.org/).
35843 description: Unique id of VNF. This is unique across the graph.
35846 example: __VNF-ID__
35847 - name: interface-name
35849 description: Name that identifies the link aggregate interface
35852 example: __INTERFACE-NAME__
35853 - name: interface-name
35855 description: Name given to the interface
35858 example: __INTERFACE-NAME__
35859 /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:
35863 summary: see node definition for valid relationships
35864 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
35873 description: Response codes found in [response codes](https://wiki.onap.org/).
35877 description: Unique id of VNF. This is unique across the graph.
35880 example: __VNF-ID__
35881 - name: interface-name
35883 description: Name that identifies the link aggregate interface
35886 example: __INTERFACE-NAME__
35887 - name: interface-name
35889 description: Name given to the interface
35892 example: __INTERFACE-NAME__
35893 - name: l3-interface-ipv4-address
35895 description: IP address
35898 example: __L3-INTERFACE-IPV4-ADDRESS__
35901 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
35904 $ref: "#/definitions/relationship"
35908 summary: delete an existing relationship
35909 description: delete an existing relationship
35910 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
35919 description: Response codes found in [response codes](https://wiki.onap.org/).
35923 description: Unique id of VNF. This is unique across the graph.
35926 example: __VNF-ID__
35927 - name: interface-name
35929 description: Name that identifies the link aggregate interface
35932 example: __INTERFACE-NAME__
35933 - name: interface-name
35935 description: Name given to the interface
35938 example: __INTERFACE-NAME__
35939 - name: l3-interface-ipv4-address
35941 description: IP address
35944 example: __L3-INTERFACE-IPV4-ADDRESS__
35945 /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}:
35949 summary: returns l3-interface-ipv4-address-list
35950 description: returns l3-interface-ipv4-address-list
35951 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
35957 description: successful operation
35959 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
35961 description: Response codes found in [response codes](https://wiki.onap.org/).
35965 description: Unique id of VNF. This is unique across the graph.
35968 example: __VNF-ID__
35969 - name: interface-name
35971 description: Name that identifies the link aggregate interface
35974 example: __INTERFACE-NAME__
35975 - name: interface-name
35977 description: Name given to the interface
35980 example: __INTERFACE-NAME__
35981 - name: l3-interface-ipv4-address
35983 description: IP address
35986 example: __L3-INTERFACE-IPV4-ADDRESS__
35989 description: Name of VNF.
35994 description: Alternate name of VNF.
35999 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.
36004 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
36007 - name: regional-resource-zone
36009 description: Regional way of organizing pservers, source of truth should define values
36012 - name: prov-status
36014 description: Trigger for operational monitoring of this resource by Service Assurance systems.
36017 - name: heat-stack-id
36019 description: Heat stack id corresponding to this instance, managed by MSO
36026 - name: is-closed-loop-disabled
36030 - name: model-invariant-id
36032 description: the ASDC model id for this resource or service model.
36035 - name: model-version-id
36037 description: the ASDC model version for this resource or service model.
36040 - name: widget-model-id
36042 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36045 - name: widget-model-version
36047 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36052 description: Generic description of the type of NF
36055 - name: nf-function
36057 description: English description of Network function that the specific VNF deployment is providing
36062 description: role in the network that this model will be providing
36065 - name: nf-naming-code
36067 description: string assigned to this model used for naming purposes
36070 - name: interface-id
36072 description: ID of interface
36075 - name: interface-role
36077 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
36080 - name: interface-id
36082 description: ID of interface
36087 description: MAC address for the interface
36090 - name: network-name
36092 description: Name of the network
36095 - name: vlan-id-inner
36097 description: Inner VLAN tag
36101 - name: neutron-network-id
36103 description: Neutron network id of the interface that address belongs to
36106 - name: neutron-subnet-id
36108 description: Neutron id of subnet that address belongs to
36114 summary: create or update an existing l3-interface-ipv4-address-list
36116 Create or update an existing l3-interface-ipv4-address-list.
36118 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36119 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36128 description: Response codes found in [response codes](https://wiki.onap.org/).
36132 description: Unique id of VNF. This is unique across the graph.
36135 example: __VNF-ID__
36136 - name: interface-name
36138 description: Name that identifies the link aggregate interface
36141 example: __INTERFACE-NAME__
36142 - name: interface-name
36144 description: Name given to the interface
36147 example: __INTERFACE-NAME__
36148 - name: l3-interface-ipv4-address
36150 description: IP address
36153 example: __L3-INTERFACE-IPV4-ADDRESS__
36156 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
36159 $ref: "#/definitions/l3-interface-ipv4-address-list"
36163 summary: update an existing l3-interface-ipv4-address-list
36165 Update an existing l3-interface-ipv4-address-list
36167 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36168 The PUT operation will entirely replace an existing object.
36169 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36171 Other differences between PUT and PATCH are:
36173 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36174 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36175 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36176 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36185 description: Response codes found in [response codes](https://wiki.onap.org/).
36189 description: Unique id of VNF. This is unique across the graph.
36192 example: __VNF-ID__
36193 - name: interface-name
36195 description: Name that identifies the link aggregate interface
36198 example: __INTERFACE-NAME__
36199 - name: interface-name
36201 description: Name given to the interface
36204 example: __INTERFACE-NAME__
36205 - name: l3-interface-ipv4-address
36207 description: IP address
36210 example: __L3-INTERFACE-IPV4-ADDRESS__
36213 description: l3-interface-ipv4-address-list object that needs to be created or updated.
36216 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
36220 summary: delete an existing l3-interface-ipv4-address-list
36221 description: delete an existing l3-interface-ipv4-address-list
36222 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36231 description: Response codes found in [response codes](https://wiki.onap.org/).
36235 description: Unique id of VNF. This is unique across the graph.
36238 example: __VNF-ID__
36239 - name: interface-name
36241 description: Name that identifies the link aggregate interface
36244 example: __INTERFACE-NAME__
36245 - name: interface-name
36247 description: Name given to the interface
36250 example: __INTERFACE-NAME__
36251 - name: l3-interface-ipv4-address
36253 description: IP address
36256 example: __L3-INTERFACE-IPV4-ADDRESS__
36257 - name: resource-version
36259 description: resource-version for concurrency
36262 /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:
36266 summary: see node definition for valid relationships
36267 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
36276 description: Response codes found in [response codes](https://wiki.onap.org/).
36280 description: Unique id of VNF. This is unique across the graph.
36283 example: __VNF-ID__
36284 - name: interface-name
36286 description: Name that identifies the link aggregate interface
36289 example: __INTERFACE-NAME__
36290 - name: interface-name
36292 description: Name given to the interface
36295 example: __INTERFACE-NAME__
36296 - name: l3-interface-ipv6-address
36298 description: IP address
36301 example: __L3-INTERFACE-IPV6-ADDRESS__
36304 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
36307 $ref: "#/definitions/relationship"
36311 summary: delete an existing relationship
36312 description: delete an existing relationship
36313 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
36322 description: Response codes found in [response codes](https://wiki.onap.org/).
36326 description: Unique id of VNF. This is unique across the graph.
36329 example: __VNF-ID__
36330 - name: interface-name
36332 description: Name that identifies the link aggregate interface
36335 example: __INTERFACE-NAME__
36336 - name: interface-name
36338 description: Name given to the interface
36341 example: __INTERFACE-NAME__
36342 - name: l3-interface-ipv6-address
36344 description: IP address
36347 example: __L3-INTERFACE-IPV6-ADDRESS__
36348 /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}:
36352 summary: returns l3-interface-ipv6-address-list
36353 description: returns l3-interface-ipv6-address-list
36354 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36360 description: successful operation
36362 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
36364 description: Response codes found in [response codes](https://wiki.onap.org/).
36368 description: Unique id of VNF. This is unique across the graph.
36371 example: __VNF-ID__
36372 - name: interface-name
36374 description: Name that identifies the link aggregate interface
36377 example: __INTERFACE-NAME__
36378 - name: interface-name
36380 description: Name given to the interface
36383 example: __INTERFACE-NAME__
36384 - name: l3-interface-ipv6-address
36386 description: IP address
36389 example: __L3-INTERFACE-IPV6-ADDRESS__
36392 description: Name of VNF.
36397 description: Alternate name of VNF.
36402 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.
36407 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
36410 - name: regional-resource-zone
36412 description: Regional way of organizing pservers, source of truth should define values
36415 - name: prov-status
36417 description: Trigger for operational monitoring of this resource by Service Assurance systems.
36420 - name: heat-stack-id
36422 description: Heat stack id corresponding to this instance, managed by MSO
36429 - name: is-closed-loop-disabled
36433 - name: model-invariant-id
36435 description: the ASDC model id for this resource or service model.
36438 - name: model-version-id
36440 description: the ASDC model version for this resource or service model.
36443 - name: widget-model-id
36445 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36448 - name: widget-model-version
36450 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36455 description: Generic description of the type of NF
36458 - name: nf-function
36460 description: English description of Network function that the specific VNF deployment is providing
36465 description: role in the network that this model will be providing
36468 - name: nf-naming-code
36470 description: string assigned to this model used for naming purposes
36473 - name: interface-id
36475 description: ID of interface
36478 - name: interface-role
36480 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
36483 - name: interface-id
36485 description: ID of interface
36490 description: MAC address for the interface
36493 - name: network-name
36495 description: Name of the network
36498 - name: vlan-id-inner
36500 description: Inner VLAN tag
36504 - name: neutron-network-id
36506 description: Neutron network id of the interface that address belongs to
36509 - name: neutron-subnet-id
36511 description: Neutron id of subnet that address belongs to
36517 summary: create or update an existing l3-interface-ipv6-address-list
36519 Create or update an existing l3-interface-ipv6-address-list.
36521 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36522 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36531 description: Response codes found in [response codes](https://wiki.onap.org/).
36535 description: Unique id of VNF. This is unique across the graph.
36538 example: __VNF-ID__
36539 - name: interface-name
36541 description: Name that identifies the link aggregate interface
36544 example: __INTERFACE-NAME__
36545 - name: interface-name
36547 description: Name given to the interface
36550 example: __INTERFACE-NAME__
36551 - name: l3-interface-ipv6-address
36553 description: IP address
36556 example: __L3-INTERFACE-IPV6-ADDRESS__
36559 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
36562 $ref: "#/definitions/l3-interface-ipv6-address-list"
36566 summary: update an existing l3-interface-ipv6-address-list
36568 Update an existing l3-interface-ipv6-address-list
36570 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36571 The PUT operation will entirely replace an existing object.
36572 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36574 Other differences between PUT and PATCH are:
36576 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36577 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36578 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36579 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36588 description: Response codes found in [response codes](https://wiki.onap.org/).
36592 description: Unique id of VNF. This is unique across the graph.
36595 example: __VNF-ID__
36596 - name: interface-name
36598 description: Name that identifies the link aggregate interface
36601 example: __INTERFACE-NAME__
36602 - name: interface-name
36604 description: Name given to the interface
36607 example: __INTERFACE-NAME__
36608 - name: l3-interface-ipv6-address
36610 description: IP address
36613 example: __L3-INTERFACE-IPV6-ADDRESS__
36616 description: l3-interface-ipv6-address-list object that needs to be created or updated.
36619 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
36623 summary: delete an existing l3-interface-ipv6-address-list
36624 description: delete an existing l3-interface-ipv6-address-list
36625 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36634 description: Response codes found in [response codes](https://wiki.onap.org/).
36638 description: Unique id of VNF. This is unique across the graph.
36641 example: __VNF-ID__
36642 - name: interface-name
36644 description: Name that identifies the link aggregate interface
36647 example: __INTERFACE-NAME__
36648 - name: interface-name
36650 description: Name given to the interface
36653 example: __INTERFACE-NAME__
36654 - name: l3-interface-ipv6-address
36656 description: IP address
36659 example: __L3-INTERFACE-IPV6-ADDRESS__
36660 - name: resource-version
36662 description: resource-version for concurrency
36665 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
36669 summary: returns l-interface
36670 description: returns l-interface
36671 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
36677 description: successful operation
36679 $ref: "#/getDefinitions/l-interface"
36681 description: Response codes found in [response codes](https://wiki.onap.org/).
36685 description: Unique id of VNF. This is unique across the graph.
36688 example: __VNF-ID__
36689 - name: interface-name
36691 description: Name that identifies the link aggregate interface
36694 example: __INTERFACE-NAME__
36695 - name: interface-name
36697 description: Name given to the interface
36700 example: __INTERFACE-NAME__
36703 description: Name of VNF.
36708 description: Alternate name of VNF.
36713 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.
36718 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
36721 - name: regional-resource-zone
36723 description: Regional way of organizing pservers, source of truth should define values
36726 - name: prov-status
36728 description: Trigger for operational monitoring of this resource by Service Assurance systems.
36731 - name: heat-stack-id
36733 description: Heat stack id corresponding to this instance, managed by MSO
36740 - name: is-closed-loop-disabled
36744 - name: model-invariant-id
36746 description: the ASDC model id for this resource or service model.
36749 - name: model-version-id
36751 description: the ASDC model version for this resource or service model.
36754 - name: widget-model-id
36756 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36759 - name: widget-model-version
36761 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36766 description: Generic description of the type of NF
36769 - name: nf-function
36771 description: English description of Network function that the specific VNF deployment is providing
36776 description: role in the network that this model will be providing
36779 - name: nf-naming-code
36781 description: string assigned to this model used for naming purposes
36784 - name: interface-id
36786 description: ID of interface
36789 - name: interface-role
36791 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
36794 - name: interface-id
36796 description: ID of interface
36801 description: MAC address for the interface
36804 - name: network-name
36806 description: Name of the network
36812 summary: create or update an existing l-interface
36814 Create or update an existing l-interface.
36816 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36817 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
36826 description: Response codes found in [response codes](https://wiki.onap.org/).
36830 description: Unique id of VNF. This is unique across the graph.
36833 example: __VNF-ID__
36834 - name: interface-name
36836 description: Name that identifies the link aggregate interface
36839 example: __INTERFACE-NAME__
36840 - name: interface-name
36842 description: Name given to the interface
36845 example: __INTERFACE-NAME__
36848 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
36851 $ref: "#/definitions/l-interface"
36855 summary: update an existing l-interface
36857 Update an existing l-interface
36859 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36860 The PUT operation will entirely replace an existing object.
36861 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36863 Other differences between PUT and PATCH are:
36865 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36866 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36867 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36868 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
36877 description: Response codes found in [response codes](https://wiki.onap.org/).
36881 description: Unique id of VNF. This is unique across the graph.
36884 example: __VNF-ID__
36885 - name: interface-name
36887 description: Name that identifies the link aggregate interface
36890 example: __INTERFACE-NAME__
36891 - name: interface-name
36893 description: Name given to the interface
36896 example: __INTERFACE-NAME__
36899 description: l-interface object that needs to be created or updated.
36902 $ref: "#/patchDefinitions/l-interface"
36906 summary: delete an existing l-interface
36907 description: delete an existing l-interface
36908 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
36917 description: Response codes found in [response codes](https://wiki.onap.org/).
36921 description: Unique id of VNF. This is unique across the graph.
36924 example: __VNF-ID__
36925 - name: interface-name
36927 description: Name that identifies the link aggregate interface
36930 example: __INTERFACE-NAME__
36931 - name: interface-name
36933 description: Name given to the interface
36936 example: __INTERFACE-NAME__
36937 - name: resource-version
36939 description: resource-version for concurrency
36942 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
36946 summary: returns l-interfaces
36947 description: returns l-interfaces
36948 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces
36954 description: successful operation
36956 $ref: "#/getDefinitions/l-interfaces"
36958 description: Response codes found in [response codes](https://wiki.onap.org/).
36962 description: Unique id of VNF. This is unique across the graph.
36965 example: __VNF-ID__
36966 - name: interface-name
36968 description: Name that identifies the link aggregate interface
36971 example: __INTERFACE-NAME__
36974 description: Name of VNF.
36979 description: Alternate name of VNF.
36984 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.
36989 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
36992 - name: regional-resource-zone
36994 description: Regional way of organizing pservers, source of truth should define values
36997 - name: prov-status
36999 description: Trigger for operational monitoring of this resource by Service Assurance systems.
37002 - name: heat-stack-id
37004 description: Heat stack id corresponding to this instance, managed by MSO
37011 - name: is-closed-loop-disabled
37015 - name: model-invariant-id
37017 description: the ASDC model id for this resource or service model.
37020 - name: model-version-id
37022 description: the ASDC model version for this resource or service model.
37025 - name: widget-model-id
37027 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37030 - name: widget-model-version
37032 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37037 description: Generic description of the type of NF
37040 - name: nf-function
37042 description: English description of Network function that the specific VNF deployment is providing
37047 description: role in the network that this model will be providing
37050 - name: nf-naming-code
37052 description: string assigned to this model used for naming purposes
37055 - name: interface-id
37057 description: ID of interface
37060 - name: interface-role
37062 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
37065 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}:
37069 summary: returns lag-interface
37070 description: returns lag-interface
37071 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
37077 description: successful operation
37079 $ref: "#/getDefinitions/lag-interface"
37081 description: Response codes found in [response codes](https://wiki.onap.org/).
37085 description: Unique id of VNF. This is unique across the graph.
37088 example: __VNF-ID__
37089 - name: interface-name
37091 description: Name that identifies the link aggregate interface
37094 example: __INTERFACE-NAME__
37097 description: Name of VNF.
37102 description: Alternate name of VNF.
37107 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.
37112 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
37115 - name: regional-resource-zone
37117 description: Regional way of organizing pservers, source of truth should define values
37120 - name: prov-status
37122 description: Trigger for operational monitoring of this resource by Service Assurance systems.
37125 - name: heat-stack-id
37127 description: Heat stack id corresponding to this instance, managed by MSO
37134 - name: is-closed-loop-disabled
37138 - name: model-invariant-id
37140 description: the ASDC model id for this resource or service model.
37143 - name: model-version-id
37145 description: the ASDC model version for this resource or service model.
37148 - name: widget-model-id
37150 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37153 - name: widget-model-version
37155 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37160 description: Generic description of the type of NF
37163 - name: nf-function
37165 description: English description of Network function that the specific VNF deployment is providing
37170 description: role in the network that this model will be providing
37173 - name: nf-naming-code
37175 description: string assigned to this model used for naming purposes
37178 - name: interface-id
37180 description: ID of interface
37183 - name: interface-role
37185 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
37191 summary: create or update an existing lag-interface
37193 Create or update an existing lag-interface.
37195 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37196 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
37205 description: Response codes found in [response codes](https://wiki.onap.org/).
37209 description: Unique id of VNF. This is unique across the graph.
37212 example: __VNF-ID__
37213 - name: interface-name
37215 description: Name that identifies the link aggregate interface
37218 example: __INTERFACE-NAME__
37221 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
37224 $ref: "#/definitions/lag-interface"
37228 summary: update an existing lag-interface
37230 Update an existing lag-interface
37232 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37233 The PUT operation will entirely replace an existing object.
37234 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37236 Other differences between PUT and PATCH are:
37238 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37239 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37240 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37241 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
37250 description: Response codes found in [response codes](https://wiki.onap.org/).
37254 description: Unique id of VNF. This is unique across the graph.
37257 example: __VNF-ID__
37258 - name: interface-name
37260 description: Name that identifies the link aggregate interface
37263 example: __INTERFACE-NAME__
37266 description: lag-interface object that needs to be created or updated.
37269 $ref: "#/patchDefinitions/lag-interface"
37273 summary: delete an existing lag-interface
37274 description: delete an existing lag-interface
37275 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
37284 description: Response codes found in [response codes](https://wiki.onap.org/).
37288 description: Unique id of VNF. This is unique across the graph.
37291 example: __VNF-ID__
37292 - name: interface-name
37294 description: Name that identifies the link aggregate interface
37297 example: __INTERFACE-NAME__
37298 - name: resource-version
37300 description: resource-version for concurrency
37303 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces:
37307 summary: returns lag-interfaces
37308 description: returns lag-interfaces
37309 operationId: getNetworkGenericVnfsGenericVnfLagInterfaces
37315 description: successful operation
37317 $ref: "#/getDefinitions/lag-interfaces"
37319 description: Response codes found in [response codes](https://wiki.onap.org/).
37323 description: Unique id of VNF. This is unique across the graph.
37326 example: __VNF-ID__
37329 description: Name of VNF.
37334 description: Alternate name of VNF.
37339 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.
37344 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
37347 - name: regional-resource-zone
37349 description: Regional way of organizing pservers, source of truth should define values
37352 - name: prov-status
37354 description: Trigger for operational monitoring of this resource by Service Assurance systems.
37357 - name: heat-stack-id
37359 description: Heat stack id corresponding to this instance, managed by MSO
37366 - name: is-closed-loop-disabled
37370 - name: model-invariant-id
37372 description: the ASDC model id for this resource or service model.
37375 - name: model-version-id
37377 description: the ASDC model version for this resource or service model.
37380 - name: widget-model-id
37382 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37385 - name: widget-model-version
37387 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37392 description: Generic description of the type of NF
37395 - name: nf-function
37397 description: English description of Network function that the specific VNF deployment is providing
37402 description: role in the network that this model will be providing
37405 - name: nf-naming-code
37407 description: string assigned to this model used for naming purposes
37410 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship:
37414 summary: see node definition for valid relationships
37415 operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
37424 description: Response codes found in [response codes](https://wiki.onap.org/).
37428 description: Unique id of VNF. This is unique across the graph.
37431 example: __VNF-ID__
37432 - name: vf-module-id
37434 description: Unique ID of vf-module.
37437 example: __VF-MODULE-ID__
37440 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
37443 $ref: "#/definitions/relationship"
37447 summary: delete an existing relationship
37448 description: delete an existing relationship
37449 operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
37458 description: Response codes found in [response codes](https://wiki.onap.org/).
37462 description: Unique id of VNF. This is unique across the graph.
37465 example: __VNF-ID__
37466 - name: vf-module-id
37468 description: Unique ID of vf-module.
37471 example: __VF-MODULE-ID__
37472 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}:
37476 summary: returns vf-module
37477 description: returns vf-module
37478 operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule
37484 description: successful operation
37486 $ref: "#/getDefinitions/vf-module"
37488 description: Response codes found in [response codes](https://wiki.onap.org/).
37492 description: Unique id of VNF. This is unique across the graph.
37495 example: __VNF-ID__
37496 - name: vf-module-id
37498 description: Unique ID of vf-module.
37501 example: __VF-MODULE-ID__
37504 description: Name of VNF.
37509 description: Alternate name of VNF.
37514 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.
37519 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
37522 - name: regional-resource-zone
37524 description: Regional way of organizing pservers, source of truth should define values
37527 - name: prov-status
37529 description: Trigger for operational monitoring of this resource by Service Assurance systems.
37532 - name: heat-stack-id
37534 description: Heat stack id corresponding to this instance, managed by MSO
37541 - name: is-closed-loop-disabled
37545 - name: model-invariant-id
37547 description: the ASDC model id for this resource or service model.
37550 - name: model-version-id
37552 description: the ASDC model version for this resource or service model.
37555 - name: widget-model-id
37557 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37560 - name: widget-model-version
37562 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37567 description: Generic description of the type of NF
37570 - name: nf-function
37572 description: English description of Network function that the specific VNF deployment is providing
37577 description: role in the network that this model will be providing
37580 - name: nf-naming-code
37582 description: string assigned to this model used for naming purposes
37585 - name: vf-module-name
37587 description: Name of vf-module
37590 - name: heat-stack-id
37592 description: Heat stack id corresponding to this instance.
37595 - name: model-invariant-id
37597 description: the ASDC model id for this resource or service model.
37600 - name: model-version-id
37602 description: the ASDC model version for this resource or service model.
37605 - name: widget-model-id
37607 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37610 - name: widget-model-version
37612 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37615 - name: contrail-service-instance-fqdn
37617 description: the Contrail unique ID for a service-instance
37623 summary: create or update an existing vf-module
37625 Create or update an existing vf-module.
37627 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37628 operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
37637 description: Response codes found in [response codes](https://wiki.onap.org/).
37641 description: Unique id of VNF. This is unique across the graph.
37644 example: __VNF-ID__
37645 - name: vf-module-id
37647 description: Unique ID of vf-module.
37650 example: __VF-MODULE-ID__
37653 description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
37656 $ref: "#/definitions/vf-module"
37660 summary: update an existing vf-module
37662 Update an existing vf-module
37664 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37665 The PUT operation will entirely replace an existing object.
37666 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37668 Other differences between PUT and PATCH are:
37670 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37671 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37672 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37673 operationId: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
37682 description: Response codes found in [response codes](https://wiki.onap.org/).
37686 description: Unique id of VNF. This is unique across the graph.
37689 example: __VNF-ID__
37690 - name: vf-module-id
37692 description: Unique ID of vf-module.
37695 example: __VF-MODULE-ID__
37698 description: vf-module object that needs to be created or updated.
37701 $ref: "#/patchDefinitions/vf-module"
37705 summary: delete an existing vf-module
37706 description: delete an existing vf-module
37707 operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule
37716 description: Response codes found in [response codes](https://wiki.onap.org/).
37720 description: Unique id of VNF. This is unique across the graph.
37723 example: __VNF-ID__
37724 - name: vf-module-id
37726 description: Unique ID of vf-module.
37729 example: __VF-MODULE-ID__
37730 - name: resource-version
37732 description: resource-version for concurrency
37735 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules:
37739 summary: returns vf-modules
37740 description: returns vf-modules
37741 operationId: getNetworkGenericVnfsGenericVnfVfModules
37747 description: successful operation
37749 $ref: "#/getDefinitions/vf-modules"
37751 description: Response codes found in [response codes](https://wiki.onap.org/).
37755 description: Unique id of VNF. This is unique across the graph.
37758 example: __VNF-ID__
37761 description: Name of VNF.
37766 description: Alternate name of VNF.
37771 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.
37776 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
37779 - name: regional-resource-zone
37781 description: Regional way of organizing pservers, source of truth should define values
37784 - name: prov-status
37786 description: Trigger for operational monitoring of this resource by Service Assurance systems.
37789 - name: heat-stack-id
37791 description: Heat stack id corresponding to this instance, managed by MSO
37798 - name: is-closed-loop-disabled
37802 - name: model-invariant-id
37804 description: the ASDC model id for this resource or service model.
37807 - name: model-version-id
37809 description: the ASDC model version for this resource or service model.
37812 - name: widget-model-id
37814 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37817 - name: widget-model-version
37819 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37824 description: Generic description of the type of NF
37827 - name: nf-function
37829 description: English description of Network function that the specific VNF deployment is providing
37834 description: role in the network that this model will be providing
37837 - name: nf-naming-code
37839 description: string assigned to this model used for naming purposes
37842 /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
37846 summary: see node definition for valid relationships
37847 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
37856 description: Response codes found in [response codes](https://wiki.onap.org/).
37860 description: Unique id of VNF. This is unique across the graph.
37863 example: __VNF-ID__
37866 description: Unique ID for the license group the resource belongs to, should be uuid.
37869 example: __GROUP-UUID__
37870 - name: resource-uuid
37872 description: Unique ID of a license resource.
37875 example: __RESOURCE-UUID__
37878 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLicensesLicense.json)
37881 $ref: "#/definitions/relationship"
37885 summary: delete an existing relationship
37886 description: delete an existing relationship
37887 operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
37896 description: Response codes found in [response codes](https://wiki.onap.org/).
37900 description: Unique id of VNF. This is unique across the graph.
37903 example: __VNF-ID__
37906 description: Unique ID for the license group the resource belongs to, should be uuid.
37909 example: __GROUP-UUID__
37910 - name: resource-uuid
37912 description: Unique ID of a license resource.
37915 example: __RESOURCE-UUID__
37916 /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
37920 summary: returns license
37921 description: returns license
37922 operationId: getNetworkGenericVnfsGenericVnfLicensesLicense
37928 description: successful operation
37930 $ref: "#/getDefinitions/license"
37932 description: Response codes found in [response codes](https://wiki.onap.org/).
37936 description: Unique id of VNF. This is unique across the graph.
37939 example: __VNF-ID__
37942 description: Unique ID for the license group the resource belongs to, should be uuid.
37945 example: __GROUP-UUID__
37946 - name: resource-uuid
37948 description: Unique ID of a license resource.
37951 example: __RESOURCE-UUID__
37954 description: Name of VNF.
37959 description: Alternate name of VNF.
37964 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.
37969 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
37972 - name: regional-resource-zone
37974 description: Regional way of organizing pservers, source of truth should define values
37977 - name: prov-status
37979 description: Trigger for operational monitoring of this resource by Service Assurance systems.
37982 - name: heat-stack-id
37984 description: Heat stack id corresponding to this instance, managed by MSO
37991 - name: is-closed-loop-disabled
37995 - name: model-invariant-id
37997 description: the ASDC model id for this resource or service model.
38000 - name: model-version-id
38002 description: the ASDC model version for this resource or service model.
38005 - name: widget-model-id
38007 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
38010 - name: widget-model-version
38012 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
38017 description: Generic description of the type of NF
38020 - name: nf-function
38022 description: English description of Network function that the specific VNF deployment is providing
38027 description: role in the network that this model will be providing
38030 - name: nf-naming-code
38032 description: string assigned to this model used for naming purposes
38038 summary: create or update an existing license
38040 Create or update an existing license.
38042 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38043 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense
38052 description: Response codes found in [response codes](https://wiki.onap.org/).
38056 description: Unique id of VNF. This is unique across the graph.
38059 example: __VNF-ID__
38062 description: Unique ID for the license group the resource belongs to, should be uuid.
38065 example: __GROUP-UUID__
38066 - name: resource-uuid
38068 description: Unique ID of a license resource.
38071 example: __RESOURCE-UUID__
38074 description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLicensesLicense.json)
38077 $ref: "#/definitions/license"
38081 summary: update an existing license
38083 Update an existing license
38085 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38086 The PUT operation will entirely replace an existing object.
38087 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38089 Other differences between PUT and PATCH are:
38091 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38092 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38093 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38094 operationId: UpdateNetworkGenericVnfsGenericVnfLicensesLicense
38103 description: Response codes found in [response codes](https://wiki.onap.org/).
38107 description: Unique id of VNF. This is unique across the graph.
38110 example: __VNF-ID__
38113 description: Unique ID for the license group the resource belongs to, should be uuid.
38116 example: __GROUP-UUID__
38117 - name: resource-uuid
38119 description: Unique ID of a license resource.
38122 example: __RESOURCE-UUID__
38125 description: license object that needs to be created or updated.
38128 $ref: "#/patchDefinitions/license"
38132 summary: delete an existing license
38133 description: delete an existing license
38134 operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicense
38143 description: Response codes found in [response codes](https://wiki.onap.org/).
38147 description: Unique id of VNF. This is unique across the graph.
38150 example: __VNF-ID__
38153 description: Unique ID for the license group the resource belongs to, should be uuid.
38156 example: __GROUP-UUID__
38157 - name: resource-uuid
38159 description: Unique ID of a license resource.
38162 example: __RESOURCE-UUID__
38163 - name: resource-version
38165 description: resource-version for concurrency
38168 /network/generic-vnfs/generic-vnf/{vnf-id}/licenses:
38172 summary: returns licenses
38173 description: returns licenses
38174 operationId: getNetworkGenericVnfsGenericVnfLicenses
38180 description: successful operation
38182 $ref: "#/getDefinitions/licenses"
38184 description: Response codes found in [response codes](https://wiki.onap.org/).
38188 description: Unique id of VNF. This is unique across the graph.
38191 example: __VNF-ID__
38194 description: Name of VNF.
38199 description: Alternate name of VNF.
38204 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.
38209 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
38212 - name: regional-resource-zone
38214 description: Regional way of organizing pservers, source of truth should define values
38217 - name: prov-status
38219 description: Trigger for operational monitoring of this resource by Service Assurance systems.
38222 - name: heat-stack-id
38224 description: Heat stack id corresponding to this instance, managed by MSO
38231 - name: is-closed-loop-disabled
38235 - name: model-invariant-id
38237 description: the ASDC model id for this resource or service model.
38240 - name: model-version-id
38242 description: the ASDC model version for this resource or service model.
38245 - name: widget-model-id
38247 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
38250 - name: widget-model-version
38252 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
38257 description: Generic description of the type of NF
38260 - name: nf-function
38262 description: English description of Network function that the specific VNF deployment is providing
38267 description: role in the network that this model will be providing
38270 - name: nf-naming-code
38272 description: string assigned to this model used for naming purposes
38275 /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
38279 summary: see node definition for valid relationships
38280 operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
38289 description: Response codes found in [response codes](https://wiki.onap.org/).
38293 description: Unique id of VNF. This is unique across the graph.
38296 example: __VNF-ID__
38299 description: Unique ID for the entitlement group the resource comes from, should be uuid.
38302 example: __GROUP-UUID__
38303 - name: resource-uuid
38305 description: Unique ID of an entitlement resource.
38308 example: __RESOURCE-UUID__
38311 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
38314 $ref: "#/definitions/relationship"
38318 summary: delete an existing relationship
38319 description: delete an existing relationship
38320 operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
38329 description: Response codes found in [response codes](https://wiki.onap.org/).
38333 description: Unique id of VNF. This is unique across the graph.
38336 example: __VNF-ID__
38339 description: Unique ID for the entitlement group the resource comes from, should be uuid.
38342 example: __GROUP-UUID__
38343 - name: resource-uuid
38345 description: Unique ID of an entitlement resource.
38348 example: __RESOURCE-UUID__
38349 /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
38353 summary: returns entitlement
38354 description: returns entitlement
38355 operationId: getNetworkGenericVnfsGenericVnfEntitlementsEntitlement
38361 description: successful operation
38363 $ref: "#/getDefinitions/entitlement"
38365 description: Response codes found in [response codes](https://wiki.onap.org/).
38369 description: Unique id of VNF. This is unique across the graph.
38372 example: __VNF-ID__
38375 description: Unique ID for the entitlement group the resource comes from, should be uuid.
38378 example: __GROUP-UUID__
38379 - name: resource-uuid
38381 description: Unique ID of an entitlement resource.
38384 example: __RESOURCE-UUID__
38387 description: Name of VNF.
38392 description: Alternate name of VNF.
38397 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.
38402 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
38405 - name: regional-resource-zone
38407 description: Regional way of organizing pservers, source of truth should define values
38410 - name: prov-status
38412 description: Trigger for operational monitoring of this resource by Service Assurance systems.
38415 - name: heat-stack-id
38417 description: Heat stack id corresponding to this instance, managed by MSO
38424 - name: is-closed-loop-disabled
38428 - name: model-invariant-id
38430 description: the ASDC model id for this resource or service model.
38433 - name: model-version-id
38435 description: the ASDC model version for this resource or service model.
38438 - name: widget-model-id
38440 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
38443 - name: widget-model-version
38445 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
38450 description: Generic description of the type of NF
38453 - name: nf-function
38455 description: English description of Network function that the specific VNF deployment is providing
38460 description: role in the network that this model will be providing
38463 - name: nf-naming-code
38465 description: string assigned to this model used for naming purposes
38471 summary: create or update an existing entitlement
38473 Create or update an existing entitlement.
38475 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38476 operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
38485 description: Response codes found in [response codes](https://wiki.onap.org/).
38489 description: Unique id of VNF. This is unique across the graph.
38492 example: __VNF-ID__
38495 description: Unique ID for the entitlement group the resource comes from, should be uuid.
38498 example: __GROUP-UUID__
38499 - name: resource-uuid
38501 description: Unique ID of an entitlement resource.
38504 example: __RESOURCE-UUID__
38507 description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
38510 $ref: "#/definitions/entitlement"
38514 summary: update an existing entitlement
38516 Update an existing entitlement
38518 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38519 The PUT operation will entirely replace an existing object.
38520 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38522 Other differences between PUT and PATCH are:
38524 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38525 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38526 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38527 operationId: UpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
38536 description: Response codes found in [response codes](https://wiki.onap.org/).
38540 description: Unique id of VNF. This is unique across the graph.
38543 example: __VNF-ID__
38546 description: Unique ID for the entitlement group the resource comes from, should be uuid.
38549 example: __GROUP-UUID__
38550 - name: resource-uuid
38552 description: Unique ID of an entitlement resource.
38555 example: __RESOURCE-UUID__
38558 description: entitlement object that needs to be created or updated.
38561 $ref: "#/patchDefinitions/entitlement"
38565 summary: delete an existing entitlement
38566 description: delete an existing entitlement
38567 operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlement
38576 description: Response codes found in [response codes](https://wiki.onap.org/).
38580 description: Unique id of VNF. This is unique across the graph.
38583 example: __VNF-ID__
38586 description: Unique ID for the entitlement group the resource comes from, should be uuid.
38589 example: __GROUP-UUID__
38590 - name: resource-uuid
38592 description: Unique ID of an entitlement resource.
38595 example: __RESOURCE-UUID__
38596 - name: resource-version
38598 description: resource-version for concurrency
38601 /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements:
38605 summary: returns entitlements
38606 description: returns entitlements
38607 operationId: getNetworkGenericVnfsGenericVnfEntitlements
38613 description: successful operation
38615 $ref: "#/getDefinitions/entitlements"
38617 description: Response codes found in [response codes](https://wiki.onap.org/).
38621 description: Unique id of VNF. This is unique across the graph.
38624 example: __VNF-ID__
38627 description: Name of VNF.
38632 description: Alternate name of VNF.
38637 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.
38642 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
38645 - name: regional-resource-zone
38647 description: Regional way of organizing pservers, source of truth should define values
38650 - name: prov-status
38652 description: Trigger for operational monitoring of this resource by Service Assurance systems.
38655 - name: heat-stack-id
38657 description: Heat stack id corresponding to this instance, managed by MSO
38664 - name: is-closed-loop-disabled
38668 - name: model-invariant-id
38670 description: the ASDC model id for this resource or service model.
38673 - name: model-version-id
38675 description: the ASDC model version for this resource or service model.
38678 - name: widget-model-id
38680 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
38683 - name: widget-model-version
38685 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
38690 description: Generic description of the type of NF
38693 - name: nf-function
38695 description: English description of Network function that the specific VNF deployment is providing
38700 description: role in the network that this model will be providing
38703 - name: nf-naming-code
38705 description: string assigned to this model used for naming purposes
38708 /network/generic-vnfs/generic-vnf/{vnf-id}:
38712 summary: returns generic-vnf
38713 description: returns generic-vnf
38714 operationId: getNetworkGenericVnfsGenericVnf
38720 description: successful operation
38722 $ref: "#/getDefinitions/generic-vnf"
38724 description: Response codes found in [response codes](https://wiki.onap.org/).
38728 description: Unique id of VNF. This is unique across the graph.
38731 example: __VNF-ID__
38734 description: Name of VNF.
38739 description: Alternate name of VNF.
38744 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.
38749 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
38752 - name: regional-resource-zone
38754 description: Regional way of organizing pservers, source of truth should define values
38757 - name: prov-status
38759 description: Trigger for operational monitoring of this resource by Service Assurance systems.
38762 - name: heat-stack-id
38764 description: Heat stack id corresponding to this instance, managed by MSO
38771 - name: is-closed-loop-disabled
38775 - name: model-invariant-id
38777 description: the ASDC model id for this resource or service model.
38780 - name: model-version-id
38782 description: the ASDC model version for this resource or service model.
38785 - name: widget-model-id
38787 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
38790 - name: widget-model-version
38792 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
38797 description: Generic description of the type of NF
38800 - name: nf-function
38802 description: English description of Network function that the specific VNF deployment is providing
38807 description: role in the network that this model will be providing
38810 - name: nf-naming-code
38812 description: string assigned to this model used for naming purposes
38818 summary: create or update an existing generic-vnf
38820 Create or update an existing generic-vnf.
38822 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38823 operationId: createOrUpdateNetworkGenericVnfsGenericVnf
38832 description: Response codes found in [response codes](https://wiki.onap.org/).
38836 description: Unique id of VNF. This is unique across the graph.
38839 example: __VNF-ID__
38842 description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnf.json)
38845 $ref: "#/definitions/generic-vnf"
38849 summary: update an existing generic-vnf
38851 Update an existing generic-vnf
38853 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38854 The PUT operation will entirely replace an existing object.
38855 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38857 Other differences between PUT and PATCH are:
38859 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38860 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38861 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38862 operationId: UpdateNetworkGenericVnfsGenericVnf
38871 description: Response codes found in [response codes](https://wiki.onap.org/).
38875 description: Unique id of VNF. This is unique across the graph.
38878 example: __VNF-ID__
38881 description: generic-vnf object that needs to be created or updated.
38884 $ref: "#/patchDefinitions/generic-vnf"
38888 summary: delete an existing generic-vnf
38889 description: delete an existing generic-vnf
38890 operationId: deleteNetworkGenericVnfsGenericVnf
38899 description: Response codes found in [response codes](https://wiki.onap.org/).
38903 description: Unique id of VNF. This is unique across the graph.
38906 example: __VNF-ID__
38907 - name: resource-version
38909 description: resource-version for concurrency
38912 /network/generic-vnfs:
38916 summary: returns generic-vnfs
38917 description: returns generic-vnfs
38918 operationId: getNetworkGenericVnfs
38924 description: successful operation
38926 $ref: "#/getDefinitions/generic-vnfs"
38928 description: Response codes found in [response codes](https://wiki.onap.org/).
38929 /network/lag-links/lag-link/{link-name}/relationship-list/relationship:
38933 summary: see node definition for valid relationships
38934 operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship
38943 description: Response codes found in [response codes](https://wiki.onap.org/).
38947 description: Alphabetical concatenation of lag-interface names
38950 example: __LINK-NAME__
38953 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkLagLinksLagLink.json)
38956 $ref: "#/definitions/relationship"
38960 summary: delete an existing relationship
38961 description: delete an existing relationship
38962 operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship
38971 description: Response codes found in [response codes](https://wiki.onap.org/).
38975 description: Alphabetical concatenation of lag-interface names
38978 example: __LINK-NAME__
38979 /network/lag-links/lag-link/{link-name}:
38983 summary: returns lag-link
38984 description: returns lag-link
38985 operationId: getNetworkLagLinksLagLink
38991 description: successful operation
38993 $ref: "#/getDefinitions/lag-link"
38995 description: Response codes found in [response codes](https://wiki.onap.org/).
38999 description: Alphabetical concatenation of lag-interface names
39002 example: __LINK-NAME__
39006 summary: create or update an existing lag-link
39008 Create or update an existing lag-link.
39010 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39011 operationId: createOrUpdateNetworkLagLinksLagLink
39020 description: Response codes found in [response codes](https://wiki.onap.org/).
39024 description: Alphabetical concatenation of lag-interface names
39027 example: __LINK-NAME__
39030 description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkLagLinksLagLink.json)
39033 $ref: "#/definitions/lag-link"
39037 summary: update an existing lag-link
39039 Update an existing lag-link
39041 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39042 The PUT operation will entirely replace an existing object.
39043 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39045 Other differences between PUT and PATCH are:
39047 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39048 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39049 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39050 operationId: UpdateNetworkLagLinksLagLink
39059 description: Response codes found in [response codes](https://wiki.onap.org/).
39063 description: Alphabetical concatenation of lag-interface names
39066 example: __LINK-NAME__
39069 description: lag-link object that needs to be created or updated.
39072 $ref: "#/patchDefinitions/lag-link"
39076 summary: delete an existing lag-link
39077 description: delete an existing lag-link
39078 operationId: deleteNetworkLagLinksLagLink
39087 description: Response codes found in [response codes](https://wiki.onap.org/).
39091 description: Alphabetical concatenation of lag-interface names
39094 example: __LINK-NAME__
39095 - name: resource-version
39097 description: resource-version for concurrency
39100 /network/lag-links:
39104 summary: returns lag-links
39105 description: returns lag-links
39106 operationId: getNetworkLagLinks
39112 description: successful operation
39114 $ref: "#/getDefinitions/lag-links"
39116 description: Response codes found in [response codes](https://wiki.onap.org/).
39117 /network/newvces/newvce/{vnf-id2}/relationship-list/relationship:
39121 summary: see node definition for valid relationships
39122 operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship
39131 description: Response codes found in [response codes](https://wiki.onap.org/).
39135 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39138 example: __VNF-ID2__
39141 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvce.json)
39144 $ref: "#/definitions/relationship"
39148 summary: delete an existing relationship
39149 description: delete an existing relationship
39150 operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship
39159 description: Response codes found in [response codes](https://wiki.onap.org/).
39163 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39166 example: __VNF-ID2__
39167 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
39171 summary: see node definition for valid relationships
39172 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
39181 description: Response codes found in [response codes](https://wiki.onap.org/).
39185 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39188 example: __VNF-ID2__
39189 - name: interface-name
39191 description: Name given to the interface
39194 example: __INTERFACE-NAME__
39195 - name: vlan-interface
39197 description: String that identifies the interface
39200 example: __VLAN-INTERFACE__
39203 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
39206 $ref: "#/definitions/relationship"
39210 summary: delete an existing relationship
39211 description: delete an existing relationship
39212 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
39221 description: Response codes found in [response codes](https://wiki.onap.org/).
39225 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39228 example: __VNF-ID2__
39229 - name: interface-name
39231 description: Name given to the interface
39234 example: __INTERFACE-NAME__
39235 - name: vlan-interface
39237 description: String that identifies the interface
39240 example: __VLAN-INTERFACE__
39241 /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:
39245 summary: see node definition for valid relationships
39246 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
39255 description: Response codes found in [response codes](https://wiki.onap.org/).
39259 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39262 example: __VNF-ID2__
39263 - name: interface-name
39265 description: Name given to the interface
39268 example: __INTERFACE-NAME__
39269 - name: vlan-interface
39271 description: String that identifies the interface
39274 example: __VLAN-INTERFACE__
39275 - name: l3-interface-ipv4-address
39277 description: IP address
39280 example: __L3-INTERFACE-IPV4-ADDRESS__
39283 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
39286 $ref: "#/definitions/relationship"
39290 summary: delete an existing relationship
39291 description: delete an existing relationship
39292 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
39301 description: Response codes found in [response codes](https://wiki.onap.org/).
39305 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39308 example: __VNF-ID2__
39309 - name: interface-name
39311 description: Name given to the interface
39314 example: __INTERFACE-NAME__
39315 - name: vlan-interface
39317 description: String that identifies the interface
39320 example: __VLAN-INTERFACE__
39321 - name: l3-interface-ipv4-address
39323 description: IP address
39326 example: __L3-INTERFACE-IPV4-ADDRESS__
39327 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
39331 summary: returns l3-interface-ipv4-address-list
39332 description: returns l3-interface-ipv4-address-list
39333 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
39339 description: successful operation
39341 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
39343 description: Response codes found in [response codes](https://wiki.onap.org/).
39347 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39350 example: __VNF-ID2__
39351 - name: interface-name
39353 description: Name given to the interface
39356 example: __INTERFACE-NAME__
39357 - name: vlan-interface
39359 description: String that identifies the interface
39362 example: __VLAN-INTERFACE__
39363 - name: l3-interface-ipv4-address
39365 description: IP address
39368 example: __L3-INTERFACE-IPV4-ADDRESS__
39371 description: Name of VNF.
39376 description: Alternate name of VNF.
39381 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.
39384 - name: prov-status
39386 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
39389 - name: heat-stack-id
39391 description: Heat stack id corresponding to this instance, managed by MSO
39394 - name: interface-id
39396 description: ID of interface
39401 description: MAC address for the interface
39404 - name: network-name
39406 description: Name of the network
39409 - name: vlan-id-inner
39411 description: Inner VLAN tag
39417 description: This indicates the customers VPN ID associated with this vlan
39420 - name: vlan-id-inner
39422 description: Inner VLAN tag
39426 - name: neutron-network-id
39428 description: Neutron network id of the interface that address belongs to
39431 - name: neutron-subnet-id
39433 description: Neutron id of subnet that address belongs to
39439 summary: create or update an existing l3-interface-ipv4-address-list
39441 Create or update an existing l3-interface-ipv4-address-list.
39443 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39444 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
39453 description: Response codes found in [response codes](https://wiki.onap.org/).
39457 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39460 example: __VNF-ID2__
39461 - name: interface-name
39463 description: Name given to the interface
39466 example: __INTERFACE-NAME__
39467 - name: vlan-interface
39469 description: String that identifies the interface
39472 example: __VLAN-INTERFACE__
39473 - name: l3-interface-ipv4-address
39475 description: IP address
39478 example: __L3-INTERFACE-IPV4-ADDRESS__
39481 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
39484 $ref: "#/definitions/l3-interface-ipv4-address-list"
39488 summary: update an existing l3-interface-ipv4-address-list
39490 Update an existing l3-interface-ipv4-address-list
39492 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39493 The PUT operation will entirely replace an existing object.
39494 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39496 Other differences between PUT and PATCH are:
39498 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39499 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39500 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39501 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
39510 description: Response codes found in [response codes](https://wiki.onap.org/).
39514 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39517 example: __VNF-ID2__
39518 - name: interface-name
39520 description: Name given to the interface
39523 example: __INTERFACE-NAME__
39524 - name: vlan-interface
39526 description: String that identifies the interface
39529 example: __VLAN-INTERFACE__
39530 - name: l3-interface-ipv4-address
39532 description: IP address
39535 example: __L3-INTERFACE-IPV4-ADDRESS__
39538 description: l3-interface-ipv4-address-list object that needs to be created or updated.
39541 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
39545 summary: delete an existing l3-interface-ipv4-address-list
39546 description: delete an existing l3-interface-ipv4-address-list
39547 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
39556 description: Response codes found in [response codes](https://wiki.onap.org/).
39560 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39563 example: __VNF-ID2__
39564 - name: interface-name
39566 description: Name given to the interface
39569 example: __INTERFACE-NAME__
39570 - name: vlan-interface
39572 description: String that identifies the interface
39575 example: __VLAN-INTERFACE__
39576 - name: l3-interface-ipv4-address
39578 description: IP address
39581 example: __L3-INTERFACE-IPV4-ADDRESS__
39582 - name: resource-version
39584 description: resource-version for concurrency
39587 /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:
39591 summary: see node definition for valid relationships
39592 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
39601 description: Response codes found in [response codes](https://wiki.onap.org/).
39605 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39608 example: __VNF-ID2__
39609 - name: interface-name
39611 description: Name given to the interface
39614 example: __INTERFACE-NAME__
39615 - name: vlan-interface
39617 description: String that identifies the interface
39620 example: __VLAN-INTERFACE__
39621 - name: l3-interface-ipv6-address
39623 description: IP address
39626 example: __L3-INTERFACE-IPV6-ADDRESS__
39629 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
39632 $ref: "#/definitions/relationship"
39636 summary: delete an existing relationship
39637 description: delete an existing relationship
39638 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
39647 description: Response codes found in [response codes](https://wiki.onap.org/).
39651 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39654 example: __VNF-ID2__
39655 - name: interface-name
39657 description: Name given to the interface
39660 example: __INTERFACE-NAME__
39661 - name: vlan-interface
39663 description: String that identifies the interface
39666 example: __VLAN-INTERFACE__
39667 - name: l3-interface-ipv6-address
39669 description: IP address
39672 example: __L3-INTERFACE-IPV6-ADDRESS__
39673 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
39677 summary: returns l3-interface-ipv6-address-list
39678 description: returns l3-interface-ipv6-address-list
39679 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
39685 description: successful operation
39687 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
39689 description: Response codes found in [response codes](https://wiki.onap.org/).
39693 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39696 example: __VNF-ID2__
39697 - name: interface-name
39699 description: Name given to the interface
39702 example: __INTERFACE-NAME__
39703 - name: vlan-interface
39705 description: String that identifies the interface
39708 example: __VLAN-INTERFACE__
39709 - name: l3-interface-ipv6-address
39711 description: IP address
39714 example: __L3-INTERFACE-IPV6-ADDRESS__
39717 description: Name of VNF.
39722 description: Alternate name of VNF.
39727 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.
39730 - name: prov-status
39732 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
39735 - name: heat-stack-id
39737 description: Heat stack id corresponding to this instance, managed by MSO
39740 - name: interface-id
39742 description: ID of interface
39747 description: MAC address for the interface
39750 - name: network-name
39752 description: Name of the network
39755 - name: vlan-id-inner
39757 description: Inner VLAN tag
39763 description: This indicates the customers VPN ID associated with this vlan
39766 - name: vlan-id-inner
39768 description: Inner VLAN tag
39772 - name: neutron-network-id
39774 description: Neutron network id of the interface that address belongs to
39777 - name: neutron-subnet-id
39779 description: Neutron id of subnet that address belongs to
39785 summary: create or update an existing l3-interface-ipv6-address-list
39787 Create or update an existing l3-interface-ipv6-address-list.
39789 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39790 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
39799 description: Response codes found in [response codes](https://wiki.onap.org/).
39803 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39806 example: __VNF-ID2__
39807 - name: interface-name
39809 description: Name given to the interface
39812 example: __INTERFACE-NAME__
39813 - name: vlan-interface
39815 description: String that identifies the interface
39818 example: __VLAN-INTERFACE__
39819 - name: l3-interface-ipv6-address
39821 description: IP address
39824 example: __L3-INTERFACE-IPV6-ADDRESS__
39827 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
39830 $ref: "#/definitions/l3-interface-ipv6-address-list"
39834 summary: update an existing l3-interface-ipv6-address-list
39836 Update an existing l3-interface-ipv6-address-list
39838 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39839 The PUT operation will entirely replace an existing object.
39840 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39842 Other differences between PUT and PATCH are:
39844 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39845 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39846 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39847 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
39856 description: Response codes found in [response codes](https://wiki.onap.org/).
39860 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39863 example: __VNF-ID2__
39864 - name: interface-name
39866 description: Name given to the interface
39869 example: __INTERFACE-NAME__
39870 - name: vlan-interface
39872 description: String that identifies the interface
39875 example: __VLAN-INTERFACE__
39876 - name: l3-interface-ipv6-address
39878 description: IP address
39881 example: __L3-INTERFACE-IPV6-ADDRESS__
39884 description: l3-interface-ipv6-address-list object that needs to be created or updated.
39887 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
39891 summary: delete an existing l3-interface-ipv6-address-list
39892 description: delete an existing l3-interface-ipv6-address-list
39893 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
39902 description: Response codes found in [response codes](https://wiki.onap.org/).
39906 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39909 example: __VNF-ID2__
39910 - name: interface-name
39912 description: Name given to the interface
39915 example: __INTERFACE-NAME__
39916 - name: vlan-interface
39918 description: String that identifies the interface
39921 example: __VLAN-INTERFACE__
39922 - name: l3-interface-ipv6-address
39924 description: IP address
39927 example: __L3-INTERFACE-IPV6-ADDRESS__
39928 - name: resource-version
39930 description: resource-version for concurrency
39933 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
39937 summary: returns vlan
39938 description: returns vlan
39939 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
39945 description: successful operation
39947 $ref: "#/getDefinitions/vlan"
39949 description: Response codes found in [response codes](https://wiki.onap.org/).
39953 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39956 example: __VNF-ID2__
39957 - name: interface-name
39959 description: Name given to the interface
39962 example: __INTERFACE-NAME__
39963 - name: vlan-interface
39965 description: String that identifies the interface
39968 example: __VLAN-INTERFACE__
39971 description: Name of VNF.
39976 description: Alternate name of VNF.
39981 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.
39984 - name: prov-status
39986 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
39989 - name: heat-stack-id
39991 description: Heat stack id corresponding to this instance, managed by MSO
39994 - name: interface-id
39996 description: ID of interface
40001 description: MAC address for the interface
40004 - name: network-name
40006 description: Name of the network
40009 - name: vlan-id-inner
40011 description: Inner VLAN tag
40017 description: This indicates the customers VPN ID associated with this vlan
40023 summary: create or update an existing vlan
40025 Create or update an existing vlan.
40027 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40028 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
40037 description: Response codes found in [response codes](https://wiki.onap.org/).
40041 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40044 example: __VNF-ID2__
40045 - name: interface-name
40047 description: Name given to the interface
40050 example: __INTERFACE-NAME__
40051 - name: vlan-interface
40053 description: String that identifies the interface
40056 example: __VLAN-INTERFACE__
40059 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
40062 $ref: "#/definitions/vlan"
40066 summary: update an existing vlan
40068 Update an existing vlan
40070 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40071 The PUT operation will entirely replace an existing object.
40072 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40074 Other differences between PUT and PATCH are:
40076 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40077 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40078 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40079 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
40088 description: Response codes found in [response codes](https://wiki.onap.org/).
40092 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40095 example: __VNF-ID2__
40096 - name: interface-name
40098 description: Name given to the interface
40101 example: __INTERFACE-NAME__
40102 - name: vlan-interface
40104 description: String that identifies the interface
40107 example: __VLAN-INTERFACE__
40110 description: vlan object that needs to be created or updated.
40113 $ref: "#/patchDefinitions/vlan"
40117 summary: delete an existing vlan
40118 description: delete an existing vlan
40119 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
40128 description: Response codes found in [response codes](https://wiki.onap.org/).
40132 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40135 example: __VNF-ID2__
40136 - name: interface-name
40138 description: Name given to the interface
40141 example: __INTERFACE-NAME__
40142 - name: vlan-interface
40144 description: String that identifies the interface
40147 example: __VLAN-INTERFACE__
40148 - name: resource-version
40150 description: resource-version for concurrency
40153 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans:
40157 summary: returns vlans
40158 description: returns vlans
40159 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans
40165 description: successful operation
40167 $ref: "#/getDefinitions/vlans"
40169 description: Response codes found in [response codes](https://wiki.onap.org/).
40173 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40176 example: __VNF-ID2__
40177 - name: interface-name
40179 description: Name given to the interface
40182 example: __INTERFACE-NAME__
40185 description: Name of VNF.
40190 description: Alternate name of VNF.
40195 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.
40198 - name: prov-status
40200 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
40203 - name: heat-stack-id
40205 description: Heat stack id corresponding to this instance, managed by MSO
40208 - name: interface-id
40210 description: ID of interface
40215 description: MAC address for the interface
40218 - name: network-name
40220 description: Name of the network
40223 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
40227 summary: see node definition for valid relationships
40228 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
40237 description: Response codes found in [response codes](https://wiki.onap.org/).
40241 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40244 example: __VNF-ID2__
40245 - name: interface-name
40247 description: Name given to the interface
40250 example: __INTERFACE-NAME__
40253 description: PCI ID used to identify the sriov-vf
40256 example: __PCI-ID__
40259 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
40262 $ref: "#/definitions/relationship"
40266 summary: delete an existing relationship
40267 description: delete an existing relationship
40268 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
40277 description: Response codes found in [response codes](https://wiki.onap.org/).
40281 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40284 example: __VNF-ID2__
40285 - name: interface-name
40287 description: Name given to the interface
40290 example: __INTERFACE-NAME__
40293 description: PCI ID used to identify the sriov-vf
40296 example: __PCI-ID__
40297 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
40301 summary: returns sriov-vf
40302 description: returns sriov-vf
40303 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
40309 description: successful operation
40311 $ref: "#/getDefinitions/sriov-vf"
40313 description: Response codes found in [response codes](https://wiki.onap.org/).
40317 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40320 example: __VNF-ID2__
40321 - name: interface-name
40323 description: Name given to the interface
40326 example: __INTERFACE-NAME__
40329 description: PCI ID used to identify the sriov-vf
40332 example: __PCI-ID__
40335 description: Name of VNF.
40340 description: Alternate name of VNF.
40345 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.
40348 - name: prov-status
40350 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
40353 - name: heat-stack-id
40355 description: Heat stack id corresponding to this instance, managed by MSO
40358 - name: interface-id
40360 description: ID of interface
40365 description: MAC address for the interface
40368 - name: network-name
40370 description: Name of the network
40373 - name: vf-vlan-filter
40375 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
40378 - name: vf-mac-filter
40380 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
40383 - name: vf-vlan-strip
40385 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
40388 - name: neutron-network-id
40390 description: Neutron network id of the interface
40396 summary: create or update an existing sriov-vf
40398 Create or update an existing sriov-vf.
40400 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40401 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
40410 description: Response codes found in [response codes](https://wiki.onap.org/).
40414 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40417 example: __VNF-ID2__
40418 - name: interface-name
40420 description: Name given to the interface
40423 example: __INTERFACE-NAME__
40426 description: PCI ID used to identify the sriov-vf
40429 example: __PCI-ID__
40432 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
40435 $ref: "#/definitions/sriov-vf"
40439 summary: update an existing sriov-vf
40441 Update an existing sriov-vf
40443 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40444 The PUT operation will entirely replace an existing object.
40445 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40447 Other differences between PUT and PATCH are:
40449 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40450 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40451 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40452 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
40461 description: Response codes found in [response codes](https://wiki.onap.org/).
40465 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40468 example: __VNF-ID2__
40469 - name: interface-name
40471 description: Name given to the interface
40474 example: __INTERFACE-NAME__
40477 description: PCI ID used to identify the sriov-vf
40480 example: __PCI-ID__
40483 description: sriov-vf object that needs to be created or updated.
40486 $ref: "#/patchDefinitions/sriov-vf"
40490 summary: delete an existing sriov-vf
40491 description: delete an existing sriov-vf
40492 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
40501 description: Response codes found in [response codes](https://wiki.onap.org/).
40505 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40508 example: __VNF-ID2__
40509 - name: interface-name
40511 description: Name given to the interface
40514 example: __INTERFACE-NAME__
40517 description: PCI ID used to identify the sriov-vf
40520 example: __PCI-ID__
40521 - name: resource-version
40523 description: resource-version for concurrency
40526 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
40530 summary: returns sriov-vfs
40531 description: returns sriov-vfs
40532 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs
40538 description: successful operation
40540 $ref: "#/getDefinitions/sriov-vfs"
40542 description: Response codes found in [response codes](https://wiki.onap.org/).
40546 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40549 example: __VNF-ID2__
40550 - name: interface-name
40552 description: Name given to the interface
40555 example: __INTERFACE-NAME__
40558 description: Name of VNF.
40563 description: Alternate name of VNF.
40568 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.
40571 - name: prov-status
40573 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
40576 - name: heat-stack-id
40578 description: Heat stack id corresponding to this instance, managed by MSO
40581 - name: interface-id
40583 description: ID of interface
40588 description: MAC address for the interface
40591 - name: network-name
40593 description: Name of the network
40596 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
40600 summary: see node definition for valid relationships
40601 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
40610 description: Response codes found in [response codes](https://wiki.onap.org/).
40614 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40617 example: __VNF-ID2__
40618 - name: interface-name
40620 description: Name given to the interface
40623 example: __INTERFACE-NAME__
40626 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterface.json)
40629 $ref: "#/definitions/relationship"
40633 summary: delete an existing relationship
40634 description: delete an existing relationship
40635 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
40644 description: Response codes found in [response codes](https://wiki.onap.org/).
40648 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40651 example: __VNF-ID2__
40652 - name: interface-name
40654 description: Name given to the interface
40657 example: __INTERFACE-NAME__
40658 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
40662 summary: see node definition for valid relationships
40663 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
40672 description: Response codes found in [response codes](https://wiki.onap.org/).
40676 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40679 example: __VNF-ID2__
40680 - name: interface-name
40682 description: Name given to the interface
40685 example: __INTERFACE-NAME__
40686 - name: l3-interface-ipv4-address
40688 description: IP address
40691 example: __L3-INTERFACE-IPV4-ADDRESS__
40694 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
40697 $ref: "#/definitions/relationship"
40701 summary: delete an existing relationship
40702 description: delete an existing relationship
40703 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
40712 description: Response codes found in [response codes](https://wiki.onap.org/).
40716 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40719 example: __VNF-ID2__
40720 - name: interface-name
40722 description: Name given to the interface
40725 example: __INTERFACE-NAME__
40726 - name: l3-interface-ipv4-address
40728 description: IP address
40731 example: __L3-INTERFACE-IPV4-ADDRESS__
40732 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
40736 summary: returns l3-interface-ipv4-address-list
40737 description: returns l3-interface-ipv4-address-list
40738 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
40744 description: successful operation
40746 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
40748 description: Response codes found in [response codes](https://wiki.onap.org/).
40752 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40755 example: __VNF-ID2__
40756 - name: interface-name
40758 description: Name given to the interface
40761 example: __INTERFACE-NAME__
40762 - name: l3-interface-ipv4-address
40764 description: IP address
40767 example: __L3-INTERFACE-IPV4-ADDRESS__
40770 description: Name of VNF.
40775 description: Alternate name of VNF.
40780 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.
40783 - name: prov-status
40785 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
40788 - name: heat-stack-id
40790 description: Heat stack id corresponding to this instance, managed by MSO
40793 - name: interface-id
40795 description: ID of interface
40800 description: MAC address for the interface
40803 - name: network-name
40805 description: Name of the network
40808 - name: vlan-id-inner
40810 description: Inner VLAN tag
40814 - name: neutron-network-id
40816 description: Neutron network id of the interface that address belongs to
40819 - name: neutron-subnet-id
40821 description: Neutron id of subnet that address belongs to
40827 summary: create or update an existing l3-interface-ipv4-address-list
40829 Create or update an existing l3-interface-ipv4-address-list.
40831 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40832 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
40841 description: Response codes found in [response codes](https://wiki.onap.org/).
40845 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40848 example: __VNF-ID2__
40849 - name: interface-name
40851 description: Name given to the interface
40854 example: __INTERFACE-NAME__
40855 - name: l3-interface-ipv4-address
40857 description: IP address
40860 example: __L3-INTERFACE-IPV4-ADDRESS__
40863 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
40866 $ref: "#/definitions/l3-interface-ipv4-address-list"
40870 summary: update an existing l3-interface-ipv4-address-list
40872 Update an existing l3-interface-ipv4-address-list
40874 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40875 The PUT operation will entirely replace an existing object.
40876 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40878 Other differences between PUT and PATCH are:
40880 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40881 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40882 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40883 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
40892 description: Response codes found in [response codes](https://wiki.onap.org/).
40896 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40899 example: __VNF-ID2__
40900 - name: interface-name
40902 description: Name given to the interface
40905 example: __INTERFACE-NAME__
40906 - name: l3-interface-ipv4-address
40908 description: IP address
40911 example: __L3-INTERFACE-IPV4-ADDRESS__
40914 description: l3-interface-ipv4-address-list object that needs to be created or updated.
40917 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
40921 summary: delete an existing l3-interface-ipv4-address-list
40922 description: delete an existing l3-interface-ipv4-address-list
40923 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
40932 description: Response codes found in [response codes](https://wiki.onap.org/).
40936 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40939 example: __VNF-ID2__
40940 - name: interface-name
40942 description: Name given to the interface
40945 example: __INTERFACE-NAME__
40946 - name: l3-interface-ipv4-address
40948 description: IP address
40951 example: __L3-INTERFACE-IPV4-ADDRESS__
40952 - name: resource-version
40954 description: resource-version for concurrency
40957 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
40961 summary: see node definition for valid relationships
40962 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
40971 description: Response codes found in [response codes](https://wiki.onap.org/).
40975 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40978 example: __VNF-ID2__
40979 - name: interface-name
40981 description: Name given to the interface
40984 example: __INTERFACE-NAME__
40985 - name: l3-interface-ipv6-address
40987 description: IP address
40990 example: __L3-INTERFACE-IPV6-ADDRESS__
40993 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
40996 $ref: "#/definitions/relationship"
41000 summary: delete an existing relationship
41001 description: delete an existing relationship
41002 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
41011 description: Response codes found in [response codes](https://wiki.onap.org/).
41015 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41018 example: __VNF-ID2__
41019 - name: interface-name
41021 description: Name given to the interface
41024 example: __INTERFACE-NAME__
41025 - name: l3-interface-ipv6-address
41027 description: IP address
41030 example: __L3-INTERFACE-IPV6-ADDRESS__
41031 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
41035 summary: returns l3-interface-ipv6-address-list
41036 description: returns l3-interface-ipv6-address-list
41037 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
41043 description: successful operation
41045 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
41047 description: Response codes found in [response codes](https://wiki.onap.org/).
41051 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41054 example: __VNF-ID2__
41055 - name: interface-name
41057 description: Name given to the interface
41060 example: __INTERFACE-NAME__
41061 - name: l3-interface-ipv6-address
41063 description: IP address
41066 example: __L3-INTERFACE-IPV6-ADDRESS__
41069 description: Name of VNF.
41074 description: Alternate name of VNF.
41079 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.
41082 - name: prov-status
41084 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
41087 - name: heat-stack-id
41089 description: Heat stack id corresponding to this instance, managed by MSO
41092 - name: interface-id
41094 description: ID of interface
41099 description: MAC address for the interface
41102 - name: network-name
41104 description: Name of the network
41107 - name: vlan-id-inner
41109 description: Inner VLAN tag
41113 - name: neutron-network-id
41115 description: Neutron network id of the interface that address belongs to
41118 - name: neutron-subnet-id
41120 description: Neutron id of subnet that address belongs to
41126 summary: create or update an existing l3-interface-ipv6-address-list
41128 Create or update an existing l3-interface-ipv6-address-list.
41130 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
41131 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
41140 description: Response codes found in [response codes](https://wiki.onap.org/).
41144 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41147 example: __VNF-ID2__
41148 - name: interface-name
41150 description: Name given to the interface
41153 example: __INTERFACE-NAME__
41154 - name: l3-interface-ipv6-address
41156 description: IP address
41159 example: __L3-INTERFACE-IPV6-ADDRESS__
41162 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
41165 $ref: "#/definitions/l3-interface-ipv6-address-list"
41169 summary: update an existing l3-interface-ipv6-address-list
41171 Update an existing l3-interface-ipv6-address-list
41173 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41174 The PUT operation will entirely replace an existing object.
41175 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
41177 Other differences between PUT and PATCH are:
41179 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
41180 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41181 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41182 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
41191 description: Response codes found in [response codes](https://wiki.onap.org/).
41195 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41198 example: __VNF-ID2__
41199 - name: interface-name
41201 description: Name given to the interface
41204 example: __INTERFACE-NAME__
41205 - name: l3-interface-ipv6-address
41207 description: IP address
41210 example: __L3-INTERFACE-IPV6-ADDRESS__
41213 description: l3-interface-ipv6-address-list object that needs to be created or updated.
41216 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
41220 summary: delete an existing l3-interface-ipv6-address-list
41221 description: delete an existing l3-interface-ipv6-address-list
41222 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
41231 description: Response codes found in [response codes](https://wiki.onap.org/).
41235 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41238 example: __VNF-ID2__
41239 - name: interface-name
41241 description: Name given to the interface
41244 example: __INTERFACE-NAME__
41245 - name: l3-interface-ipv6-address
41247 description: IP address
41250 example: __L3-INTERFACE-IPV6-ADDRESS__
41251 - name: resource-version
41253 description: resource-version for concurrency
41256 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}:
41260 summary: returns l-interface
41261 description: returns l-interface
41262 operationId: getNetworkNewvcesNewvceLInterfacesLInterface
41268 description: successful operation
41270 $ref: "#/getDefinitions/l-interface"
41272 description: Response codes found in [response codes](https://wiki.onap.org/).
41276 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41279 example: __VNF-ID2__
41280 - name: interface-name
41282 description: Name given to the interface
41285 example: __INTERFACE-NAME__
41288 description: Name of VNF.
41293 description: Alternate name of VNF.
41298 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.
41301 - name: prov-status
41303 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
41306 - name: heat-stack-id
41308 description: Heat stack id corresponding to this instance, managed by MSO
41311 - name: interface-id
41313 description: ID of interface
41318 description: MAC address for the interface
41321 - name: network-name
41323 description: Name of the network
41329 summary: create or update an existing l-interface
41331 Create or update an existing l-interface.
41333 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
41334 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface
41343 description: Response codes found in [response codes](https://wiki.onap.org/).
41347 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41350 example: __VNF-ID2__
41351 - name: interface-name
41353 description: Name given to the interface
41356 example: __INTERFACE-NAME__
41359 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterface.json)
41362 $ref: "#/definitions/l-interface"
41366 summary: update an existing l-interface
41368 Update an existing l-interface
41370 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41371 The PUT operation will entirely replace an existing object.
41372 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
41374 Other differences between PUT and PATCH are:
41376 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
41377 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41378 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41379 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterface
41388 description: Response codes found in [response codes](https://wiki.onap.org/).
41392 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41395 example: __VNF-ID2__
41396 - name: interface-name
41398 description: Name given to the interface
41401 example: __INTERFACE-NAME__
41404 description: l-interface object that needs to be created or updated.
41407 $ref: "#/patchDefinitions/l-interface"
41411 summary: delete an existing l-interface
41412 description: delete an existing l-interface
41413 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface
41422 description: Response codes found in [response codes](https://wiki.onap.org/).
41426 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41429 example: __VNF-ID2__
41430 - name: interface-name
41432 description: Name given to the interface
41435 example: __INTERFACE-NAME__
41436 - name: resource-version
41438 description: resource-version for concurrency
41441 /network/newvces/newvce/{vnf-id2}/l-interfaces:
41445 summary: returns l-interfaces
41446 description: returns l-interfaces
41447 operationId: getNetworkNewvcesNewvceLInterfaces
41453 description: successful operation
41455 $ref: "#/getDefinitions/l-interfaces"
41457 description: Response codes found in [response codes](https://wiki.onap.org/).
41461 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41464 example: __VNF-ID2__
41467 description: Name of VNF.
41472 description: Alternate name of VNF.
41477 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.
41480 - name: prov-status
41482 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
41485 - name: heat-stack-id
41487 description: Heat stack id corresponding to this instance, managed by MSO
41490 /network/newvces/newvce/{vnf-id2}:
41494 summary: returns newvce
41495 description: returns newvce
41496 operationId: getNetworkNewvcesNewvce
41502 description: successful operation
41504 $ref: "#/getDefinitions/newvce"
41506 description: Response codes found in [response codes](https://wiki.onap.org/).
41510 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41513 example: __VNF-ID2__
41516 description: Name of VNF.
41521 description: Alternate name of VNF.
41526 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.
41529 - name: prov-status
41531 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
41534 - name: heat-stack-id
41536 description: Heat stack id corresponding to this instance, managed by MSO
41542 summary: create or update an existing newvce
41544 Create or update an existing newvce.
41546 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
41547 operationId: createOrUpdateNetworkNewvcesNewvce
41556 description: Response codes found in [response codes](https://wiki.onap.org/).
41560 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41563 example: __VNF-ID2__
41566 description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvce.json)
41569 $ref: "#/definitions/newvce"
41573 summary: update an existing newvce
41575 Update an existing newvce
41577 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41578 The PUT operation will entirely replace an existing object.
41579 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
41581 Other differences between PUT and PATCH are:
41583 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
41584 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41585 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41586 operationId: UpdateNetworkNewvcesNewvce
41595 description: Response codes found in [response codes](https://wiki.onap.org/).
41599 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41602 example: __VNF-ID2__
41605 description: newvce object that needs to be created or updated.
41608 $ref: "#/patchDefinitions/newvce"
41612 summary: delete an existing newvce
41613 description: delete an existing newvce
41614 operationId: deleteNetworkNewvcesNewvce
41623 description: Response codes found in [response codes](https://wiki.onap.org/).
41627 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41630 example: __VNF-ID2__
41631 - name: resource-version
41633 description: resource-version for concurrency
41640 summary: returns newvces
41641 description: returns newvces
41642 operationId: getNetworkNewvces
41648 description: successful operation
41650 $ref: "#/getDefinitions/newvces"
41652 description: Response codes found in [response codes](https://wiki.onap.org/).
41653 /network/pnfs/pnf/{pnf-name}/relationship-list/relationship:
41657 summary: see node definition for valid relationships
41658 operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship
41667 description: Response codes found in [response codes](https://wiki.onap.org/).
41671 description: unique name of Physical Network Function.
41674 example: __PNF-NAME__
41677 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnf.json)
41680 $ref: "#/definitions/relationship"
41684 summary: delete an existing relationship
41685 description: delete an existing relationship
41686 operationId: deleteNetworkPnfsPnfRelationshipListRelationship
41695 description: Response codes found in [response codes](https://wiki.onap.org/).
41699 description: unique name of Physical Network Function.
41702 example: __PNF-NAME__
41703 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
41707 summary: see node definition for valid relationships
41708 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
41717 description: Response codes found in [response codes](https://wiki.onap.org/).
41721 description: unique name of Physical Network Function.
41724 example: __PNF-NAME__
41725 - name: interface-name
41727 description: Name that identifies the physical interface
41730 example: __INTERFACE-NAME__
41733 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterface.json)
41736 $ref: "#/definitions/relationship"
41740 summary: delete an existing relationship
41741 description: delete an existing relationship
41742 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
41751 description: Response codes found in [response codes](https://wiki.onap.org/).
41755 description: unique name of Physical Network Function.
41758 example: __PNF-NAME__
41759 - name: interface-name
41761 description: Name that identifies the physical interface
41764 example: __INTERFACE-NAME__
41765 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
41769 summary: see node definition for valid relationships
41770 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
41779 description: Response codes found in [response codes](https://wiki.onap.org/).
41783 description: unique name of Physical Network Function.
41786 example: __PNF-NAME__
41787 - name: interface-name
41789 description: Name that identifies the physical interface
41792 example: __INTERFACE-NAME__
41793 - name: interface-name
41795 description: Name given to the interface
41798 example: __INTERFACE-NAME__
41799 - name: vlan-interface
41801 description: String that identifies the interface
41804 example: __VLAN-INTERFACE__
41807 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
41810 $ref: "#/definitions/relationship"
41814 summary: delete an existing relationship
41815 description: delete an existing relationship
41816 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
41825 description: Response codes found in [response codes](https://wiki.onap.org/).
41829 description: unique name of Physical Network Function.
41832 example: __PNF-NAME__
41833 - name: interface-name
41835 description: Name that identifies the physical interface
41838 example: __INTERFACE-NAME__
41839 - name: interface-name
41841 description: Name given to the interface
41844 example: __INTERFACE-NAME__
41845 - name: vlan-interface
41847 description: String that identifies the interface
41850 example: __VLAN-INTERFACE__
41851 /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:
41855 summary: see node definition for valid relationships
41856 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
41865 description: Response codes found in [response codes](https://wiki.onap.org/).
41869 description: unique name of Physical Network Function.
41872 example: __PNF-NAME__
41873 - name: interface-name
41875 description: Name that identifies the physical interface
41878 example: __INTERFACE-NAME__
41879 - name: interface-name
41881 description: Name given to the interface
41884 example: __INTERFACE-NAME__
41885 - name: vlan-interface
41887 description: String that identifies the interface
41890 example: __VLAN-INTERFACE__
41891 - name: l3-interface-ipv4-address
41893 description: IP address
41896 example: __L3-INTERFACE-IPV4-ADDRESS__
41899 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
41902 $ref: "#/definitions/relationship"
41906 summary: delete an existing relationship
41907 description: delete an existing relationship
41908 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
41917 description: Response codes found in [response codes](https://wiki.onap.org/).
41921 description: unique name of Physical Network Function.
41924 example: __PNF-NAME__
41925 - name: interface-name
41927 description: Name that identifies the physical interface
41930 example: __INTERFACE-NAME__
41931 - name: interface-name
41933 description: Name given to the interface
41936 example: __INTERFACE-NAME__
41937 - name: vlan-interface
41939 description: String that identifies the interface
41942 example: __VLAN-INTERFACE__
41943 - name: l3-interface-ipv4-address
41945 description: IP address
41948 example: __L3-INTERFACE-IPV4-ADDRESS__
41949 /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}:
41953 summary: returns l3-interface-ipv4-address-list
41954 description: returns l3-interface-ipv4-address-list
41955 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
41961 description: successful operation
41963 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
41965 description: Response codes found in [response codes](https://wiki.onap.org/).
41969 description: unique name of Physical Network Function.
41972 example: __PNF-NAME__
41973 - name: interface-name
41975 description: Name that identifies the physical interface
41978 example: __INTERFACE-NAME__
41979 - name: interface-name
41981 description: Name given to the interface
41984 example: __INTERFACE-NAME__
41985 - name: vlan-interface
41987 description: String that identifies the interface
41990 example: __VLAN-INTERFACE__
41991 - name: l3-interface-ipv4-address
41993 description: IP address
41996 example: __L3-INTERFACE-IPV4-ADDRESS__
41999 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
42002 - name: prov-status
42004 description: Trigger for operational monitoring of this resource by Service Assurance systems.
42007 - name: interface-id
42009 description: ID of interface
42014 description: MAC address for the interface
42017 - name: network-name
42019 description: Name of the network
42022 - name: vlan-id-inner
42024 description: Inner VLAN tag
42030 description: This indicates the customers VPN ID associated with this vlan
42033 - name: vlan-id-inner
42035 description: Inner VLAN tag
42039 - name: neutron-network-id
42041 description: Neutron network id of the interface that address belongs to
42044 - name: neutron-subnet-id
42046 description: Neutron id of subnet that address belongs to
42052 summary: create or update an existing l3-interface-ipv4-address-list
42054 Create or update an existing l3-interface-ipv4-address-list.
42056 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
42057 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42066 description: Response codes found in [response codes](https://wiki.onap.org/).
42070 description: unique name of Physical Network Function.
42073 example: __PNF-NAME__
42074 - name: interface-name
42076 description: Name that identifies the physical interface
42079 example: __INTERFACE-NAME__
42080 - name: interface-name
42082 description: Name given to the interface
42085 example: __INTERFACE-NAME__
42086 - name: vlan-interface
42088 description: String that identifies the interface
42091 example: __VLAN-INTERFACE__
42092 - name: l3-interface-ipv4-address
42094 description: IP address
42097 example: __L3-INTERFACE-IPV4-ADDRESS__
42100 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
42103 $ref: "#/definitions/l3-interface-ipv4-address-list"
42107 summary: update an existing l3-interface-ipv4-address-list
42109 Update an existing l3-interface-ipv4-address-list
42111 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42112 The PUT operation will entirely replace an existing object.
42113 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
42115 Other differences between PUT and PATCH are:
42117 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
42118 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42119 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42120 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42129 description: Response codes found in [response codes](https://wiki.onap.org/).
42133 description: unique name of Physical Network Function.
42136 example: __PNF-NAME__
42137 - name: interface-name
42139 description: Name that identifies the physical interface
42142 example: __INTERFACE-NAME__
42143 - name: interface-name
42145 description: Name given to the interface
42148 example: __INTERFACE-NAME__
42149 - name: vlan-interface
42151 description: String that identifies the interface
42154 example: __VLAN-INTERFACE__
42155 - name: l3-interface-ipv4-address
42157 description: IP address
42160 example: __L3-INTERFACE-IPV4-ADDRESS__
42163 description: l3-interface-ipv4-address-list object that needs to be created or updated.
42166 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
42170 summary: delete an existing l3-interface-ipv4-address-list
42171 description: delete an existing l3-interface-ipv4-address-list
42172 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42181 description: Response codes found in [response codes](https://wiki.onap.org/).
42185 description: unique name of Physical Network Function.
42188 example: __PNF-NAME__
42189 - name: interface-name
42191 description: Name that identifies the physical interface
42194 example: __INTERFACE-NAME__
42195 - name: interface-name
42197 description: Name given to the interface
42200 example: __INTERFACE-NAME__
42201 - name: vlan-interface
42203 description: String that identifies the interface
42206 example: __VLAN-INTERFACE__
42207 - name: l3-interface-ipv4-address
42209 description: IP address
42212 example: __L3-INTERFACE-IPV4-ADDRESS__
42213 - name: resource-version
42215 description: resource-version for concurrency
42218 /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:
42222 summary: see node definition for valid relationships
42223 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
42232 description: Response codes found in [response codes](https://wiki.onap.org/).
42236 description: unique name of Physical Network Function.
42239 example: __PNF-NAME__
42240 - name: interface-name
42242 description: Name that identifies the physical interface
42245 example: __INTERFACE-NAME__
42246 - name: interface-name
42248 description: Name given to the interface
42251 example: __INTERFACE-NAME__
42252 - name: vlan-interface
42254 description: String that identifies the interface
42257 example: __VLAN-INTERFACE__
42258 - name: l3-interface-ipv6-address
42260 description: IP address
42263 example: __L3-INTERFACE-IPV6-ADDRESS__
42266 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
42269 $ref: "#/definitions/relationship"
42273 summary: delete an existing relationship
42274 description: delete an existing relationship
42275 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
42284 description: Response codes found in [response codes](https://wiki.onap.org/).
42288 description: unique name of Physical Network Function.
42291 example: __PNF-NAME__
42292 - name: interface-name
42294 description: Name that identifies the physical interface
42297 example: __INTERFACE-NAME__
42298 - name: interface-name
42300 description: Name given to the interface
42303 example: __INTERFACE-NAME__
42304 - name: vlan-interface
42306 description: String that identifies the interface
42309 example: __VLAN-INTERFACE__
42310 - name: l3-interface-ipv6-address
42312 description: IP address
42315 example: __L3-INTERFACE-IPV6-ADDRESS__
42316 /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}:
42320 summary: returns l3-interface-ipv6-address-list
42321 description: returns l3-interface-ipv6-address-list
42322 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
42328 description: successful operation
42330 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
42332 description: Response codes found in [response codes](https://wiki.onap.org/).
42336 description: unique name of Physical Network Function.
42339 example: __PNF-NAME__
42340 - name: interface-name
42342 description: Name that identifies the physical interface
42345 example: __INTERFACE-NAME__
42346 - name: interface-name
42348 description: Name given to the interface
42351 example: __INTERFACE-NAME__
42352 - name: vlan-interface
42354 description: String that identifies the interface
42357 example: __VLAN-INTERFACE__
42358 - name: l3-interface-ipv6-address
42360 description: IP address
42363 example: __L3-INTERFACE-IPV6-ADDRESS__
42366 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
42369 - name: prov-status
42371 description: Trigger for operational monitoring of this resource by Service Assurance systems.
42374 - name: interface-id
42376 description: ID of interface
42381 description: MAC address for the interface
42384 - name: network-name
42386 description: Name of the network
42389 - name: vlan-id-inner
42391 description: Inner VLAN tag
42397 description: This indicates the customers VPN ID associated with this vlan
42400 - name: vlan-id-inner
42402 description: Inner VLAN tag
42406 - name: neutron-network-id
42408 description: Neutron network id of the interface that address belongs to
42411 - name: neutron-subnet-id
42413 description: Neutron id of subnet that address belongs to
42419 summary: create or update an existing l3-interface-ipv6-address-list
42421 Create or update an existing l3-interface-ipv6-address-list.
42423 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
42424 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
42433 description: Response codes found in [response codes](https://wiki.onap.org/).
42437 description: unique name of Physical Network Function.
42440 example: __PNF-NAME__
42441 - name: interface-name
42443 description: Name that identifies the physical interface
42446 example: __INTERFACE-NAME__
42447 - name: interface-name
42449 description: Name given to the interface
42452 example: __INTERFACE-NAME__
42453 - name: vlan-interface
42455 description: String that identifies the interface
42458 example: __VLAN-INTERFACE__
42459 - name: l3-interface-ipv6-address
42461 description: IP address
42464 example: __L3-INTERFACE-IPV6-ADDRESS__
42467 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
42470 $ref: "#/definitions/l3-interface-ipv6-address-list"
42474 summary: update an existing l3-interface-ipv6-address-list
42476 Update an existing l3-interface-ipv6-address-list
42478 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42479 The PUT operation will entirely replace an existing object.
42480 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
42482 Other differences between PUT and PATCH are:
42484 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
42485 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42486 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42487 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
42496 description: Response codes found in [response codes](https://wiki.onap.org/).
42500 description: unique name of Physical Network Function.
42503 example: __PNF-NAME__
42504 - name: interface-name
42506 description: Name that identifies the physical interface
42509 example: __INTERFACE-NAME__
42510 - name: interface-name
42512 description: Name given to the interface
42515 example: __INTERFACE-NAME__
42516 - name: vlan-interface
42518 description: String that identifies the interface
42521 example: __VLAN-INTERFACE__
42522 - name: l3-interface-ipv6-address
42524 description: IP address
42527 example: __L3-INTERFACE-IPV6-ADDRESS__
42530 description: l3-interface-ipv6-address-list object that needs to be created or updated.
42533 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
42537 summary: delete an existing l3-interface-ipv6-address-list
42538 description: delete an existing l3-interface-ipv6-address-list
42539 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
42548 description: Response codes found in [response codes](https://wiki.onap.org/).
42552 description: unique name of Physical Network Function.
42555 example: __PNF-NAME__
42556 - name: interface-name
42558 description: Name that identifies the physical interface
42561 example: __INTERFACE-NAME__
42562 - name: interface-name
42564 description: Name given to the interface
42567 example: __INTERFACE-NAME__
42568 - name: vlan-interface
42570 description: String that identifies the interface
42573 example: __VLAN-INTERFACE__
42574 - name: l3-interface-ipv6-address
42576 description: IP address
42579 example: __L3-INTERFACE-IPV6-ADDRESS__
42580 - name: resource-version
42582 description: resource-version for concurrency
42585 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
42589 summary: returns vlan
42590 description: returns vlan
42591 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
42597 description: successful operation
42599 $ref: "#/getDefinitions/vlan"
42601 description: Response codes found in [response codes](https://wiki.onap.org/).
42605 description: unique name of Physical Network Function.
42608 example: __PNF-NAME__
42609 - name: interface-name
42611 description: Name that identifies the physical interface
42614 example: __INTERFACE-NAME__
42615 - name: interface-name
42617 description: Name given to the interface
42620 example: __INTERFACE-NAME__
42621 - name: vlan-interface
42623 description: String that identifies the interface
42626 example: __VLAN-INTERFACE__
42629 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
42632 - name: prov-status
42634 description: Trigger for operational monitoring of this resource by Service Assurance systems.
42637 - name: interface-id
42639 description: ID of interface
42644 description: MAC address for the interface
42647 - name: network-name
42649 description: Name of the network
42652 - name: vlan-id-inner
42654 description: Inner VLAN tag
42660 description: This indicates the customers VPN ID associated with this vlan
42666 summary: create or update an existing vlan
42668 Create or update an existing vlan.
42670 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
42671 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
42680 description: Response codes found in [response codes](https://wiki.onap.org/).
42684 description: unique name of Physical Network Function.
42687 example: __PNF-NAME__
42688 - name: interface-name
42690 description: Name that identifies the physical interface
42693 example: __INTERFACE-NAME__
42694 - name: interface-name
42696 description: Name given to the interface
42699 example: __INTERFACE-NAME__
42700 - name: vlan-interface
42702 description: String that identifies the interface
42705 example: __VLAN-INTERFACE__
42708 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
42711 $ref: "#/definitions/vlan"
42715 summary: update an existing vlan
42717 Update an existing vlan
42719 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42720 The PUT operation will entirely replace an existing object.
42721 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
42723 Other differences between PUT and PATCH are:
42725 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
42726 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42727 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42728 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
42737 description: Response codes found in [response codes](https://wiki.onap.org/).
42741 description: unique name of Physical Network Function.
42744 example: __PNF-NAME__
42745 - name: interface-name
42747 description: Name that identifies the physical interface
42750 example: __INTERFACE-NAME__
42751 - name: interface-name
42753 description: Name given to the interface
42756 example: __INTERFACE-NAME__
42757 - name: vlan-interface
42759 description: String that identifies the interface
42762 example: __VLAN-INTERFACE__
42765 description: vlan object that needs to be created or updated.
42768 $ref: "#/patchDefinitions/vlan"
42772 summary: delete an existing vlan
42773 description: delete an existing vlan
42774 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
42783 description: Response codes found in [response codes](https://wiki.onap.org/).
42787 description: unique name of Physical Network Function.
42790 example: __PNF-NAME__
42791 - name: interface-name
42793 description: Name that identifies the physical interface
42796 example: __INTERFACE-NAME__
42797 - name: interface-name
42799 description: Name given to the interface
42802 example: __INTERFACE-NAME__
42803 - name: vlan-interface
42805 description: String that identifies the interface
42808 example: __VLAN-INTERFACE__
42809 - name: resource-version
42811 description: resource-version for concurrency
42814 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
42818 summary: returns vlans
42819 description: returns vlans
42820 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans
42826 description: successful operation
42828 $ref: "#/getDefinitions/vlans"
42830 description: Response codes found in [response codes](https://wiki.onap.org/).
42834 description: unique name of Physical Network Function.
42837 example: __PNF-NAME__
42838 - name: interface-name
42840 description: Name that identifies the physical interface
42843 example: __INTERFACE-NAME__
42844 - name: interface-name
42846 description: Name given to the interface
42849 example: __INTERFACE-NAME__
42852 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
42855 - name: prov-status
42857 description: Trigger for operational monitoring of this resource by Service Assurance systems.
42860 - name: interface-id
42862 description: ID of interface
42867 description: MAC address for the interface
42870 - name: network-name
42872 description: Name of the network
42875 /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:
42879 summary: see node definition for valid relationships
42880 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
42889 description: Response codes found in [response codes](https://wiki.onap.org/).
42893 description: unique name of Physical Network Function.
42896 example: __PNF-NAME__
42897 - name: interface-name
42899 description: Name that identifies the physical interface
42902 example: __INTERFACE-NAME__
42903 - name: interface-name
42905 description: Name given to the interface
42908 example: __INTERFACE-NAME__
42911 description: PCI ID used to identify the sriov-vf
42914 example: __PCI-ID__
42917 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
42920 $ref: "#/definitions/relationship"
42924 summary: delete an existing relationship
42925 description: delete an existing relationship
42926 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
42935 description: Response codes found in [response codes](https://wiki.onap.org/).
42939 description: unique name of Physical Network Function.
42942 example: __PNF-NAME__
42943 - name: interface-name
42945 description: Name that identifies the physical interface
42948 example: __INTERFACE-NAME__
42949 - name: interface-name
42951 description: Name given to the interface
42954 example: __INTERFACE-NAME__
42957 description: PCI ID used to identify the sriov-vf
42960 example: __PCI-ID__
42961 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
42965 summary: returns sriov-vf
42966 description: returns sriov-vf
42967 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
42973 description: successful operation
42975 $ref: "#/getDefinitions/sriov-vf"
42977 description: Response codes found in [response codes](https://wiki.onap.org/).
42981 description: unique name of Physical Network Function.
42984 example: __PNF-NAME__
42985 - name: interface-name
42987 description: Name that identifies the physical interface
42990 example: __INTERFACE-NAME__
42991 - name: interface-name
42993 description: Name given to the interface
42996 example: __INTERFACE-NAME__
42999 description: PCI ID used to identify the sriov-vf
43002 example: __PCI-ID__
43005 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
43008 - name: prov-status
43010 description: Trigger for operational monitoring of this resource by Service Assurance systems.
43013 - name: interface-id
43015 description: ID of interface
43020 description: MAC address for the interface
43023 - name: network-name
43025 description: Name of the network
43028 - name: vf-vlan-filter
43030 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
43033 - name: vf-mac-filter
43035 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
43038 - name: vf-vlan-strip
43040 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
43043 - name: neutron-network-id
43045 description: Neutron network id of the interface
43051 summary: create or update an existing sriov-vf
43053 Create or update an existing sriov-vf.
43055 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
43056 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
43065 description: Response codes found in [response codes](https://wiki.onap.org/).
43069 description: unique name of Physical Network Function.
43072 example: __PNF-NAME__
43073 - name: interface-name
43075 description: Name that identifies the physical interface
43078 example: __INTERFACE-NAME__
43079 - name: interface-name
43081 description: Name given to the interface
43084 example: __INTERFACE-NAME__
43087 description: PCI ID used to identify the sriov-vf
43090 example: __PCI-ID__
43093 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
43096 $ref: "#/definitions/sriov-vf"
43100 summary: update an existing sriov-vf
43102 Update an existing sriov-vf
43104 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43105 The PUT operation will entirely replace an existing object.
43106 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
43108 Other differences between PUT and PATCH are:
43110 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
43111 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43112 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43113 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
43122 description: Response codes found in [response codes](https://wiki.onap.org/).
43126 description: unique name of Physical Network Function.
43129 example: __PNF-NAME__
43130 - name: interface-name
43132 description: Name that identifies the physical interface
43135 example: __INTERFACE-NAME__
43136 - name: interface-name
43138 description: Name given to the interface
43141 example: __INTERFACE-NAME__
43144 description: PCI ID used to identify the sriov-vf
43147 example: __PCI-ID__
43150 description: sriov-vf object that needs to be created or updated.
43153 $ref: "#/patchDefinitions/sriov-vf"
43157 summary: delete an existing sriov-vf
43158 description: delete an existing sriov-vf
43159 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
43168 description: Response codes found in [response codes](https://wiki.onap.org/).
43172 description: unique name of Physical Network Function.
43175 example: __PNF-NAME__
43176 - name: interface-name
43178 description: Name that identifies the physical interface
43181 example: __INTERFACE-NAME__
43182 - name: interface-name
43184 description: Name given to the interface
43187 example: __INTERFACE-NAME__
43190 description: PCI ID used to identify the sriov-vf
43193 example: __PCI-ID__
43194 - name: resource-version
43196 description: resource-version for concurrency
43199 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
43203 summary: returns sriov-vfs
43204 description: returns sriov-vfs
43205 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
43211 description: successful operation
43213 $ref: "#/getDefinitions/sriov-vfs"
43215 description: Response codes found in [response codes](https://wiki.onap.org/).
43219 description: unique name of Physical Network Function.
43222 example: __PNF-NAME__
43223 - name: interface-name
43225 description: Name that identifies the physical interface
43228 example: __INTERFACE-NAME__
43229 - name: interface-name
43231 description: Name given to the interface
43234 example: __INTERFACE-NAME__
43237 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
43240 - name: prov-status
43242 description: Trigger for operational monitoring of this resource by Service Assurance systems.
43245 - name: interface-id
43247 description: ID of interface
43252 description: MAC address for the interface
43255 - name: network-name
43257 description: Name of the network
43260 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
43264 summary: see node definition for valid relationships
43265 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
43274 description: Response codes found in [response codes](https://wiki.onap.org/).
43278 description: unique name of Physical Network Function.
43281 example: __PNF-NAME__
43282 - name: interface-name
43284 description: Name that identifies the physical interface
43287 example: __INTERFACE-NAME__
43288 - name: interface-name
43290 description: Name given to the interface
43293 example: __INTERFACE-NAME__
43296 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
43299 $ref: "#/definitions/relationship"
43303 summary: delete an existing relationship
43304 description: delete an existing relationship
43305 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
43314 description: Response codes found in [response codes](https://wiki.onap.org/).
43318 description: unique name of Physical Network Function.
43321 example: __PNF-NAME__
43322 - name: interface-name
43324 description: Name that identifies the physical interface
43327 example: __INTERFACE-NAME__
43328 - name: interface-name
43330 description: Name given to the interface
43333 example: __INTERFACE-NAME__
43334 /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:
43338 summary: see node definition for valid relationships
43339 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
43348 description: Response codes found in [response codes](https://wiki.onap.org/).
43352 description: unique name of Physical Network Function.
43355 example: __PNF-NAME__
43356 - name: interface-name
43358 description: Name that identifies the physical interface
43361 example: __INTERFACE-NAME__
43362 - name: interface-name
43364 description: Name given to the interface
43367 example: __INTERFACE-NAME__
43368 - name: l3-interface-ipv4-address
43370 description: IP address
43373 example: __L3-INTERFACE-IPV4-ADDRESS__
43376 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
43379 $ref: "#/definitions/relationship"
43383 summary: delete an existing relationship
43384 description: delete an existing relationship
43385 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
43394 description: Response codes found in [response codes](https://wiki.onap.org/).
43398 description: unique name of Physical Network Function.
43401 example: __PNF-NAME__
43402 - name: interface-name
43404 description: Name that identifies the physical interface
43407 example: __INTERFACE-NAME__
43408 - name: interface-name
43410 description: Name given to the interface
43413 example: __INTERFACE-NAME__
43414 - name: l3-interface-ipv4-address
43416 description: IP address
43419 example: __L3-INTERFACE-IPV4-ADDRESS__
43420 /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}:
43424 summary: returns l3-interface-ipv4-address-list
43425 description: returns l3-interface-ipv4-address-list
43426 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
43432 description: successful operation
43434 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
43436 description: Response codes found in [response codes](https://wiki.onap.org/).
43440 description: unique name of Physical Network Function.
43443 example: __PNF-NAME__
43444 - name: interface-name
43446 description: Name that identifies the physical interface
43449 example: __INTERFACE-NAME__
43450 - name: interface-name
43452 description: Name given to the interface
43455 example: __INTERFACE-NAME__
43456 - name: l3-interface-ipv4-address
43458 description: IP address
43461 example: __L3-INTERFACE-IPV4-ADDRESS__
43464 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
43467 - name: prov-status
43469 description: Trigger for operational monitoring of this resource by Service Assurance systems.
43472 - name: interface-id
43474 description: ID of interface
43479 description: MAC address for the interface
43482 - name: network-name
43484 description: Name of the network
43487 - name: vlan-id-inner
43489 description: Inner VLAN tag
43493 - name: neutron-network-id
43495 description: Neutron network id of the interface that address belongs to
43498 - name: neutron-subnet-id
43500 description: Neutron id of subnet that address belongs to
43506 summary: create or update an existing l3-interface-ipv4-address-list
43508 Create or update an existing l3-interface-ipv4-address-list.
43510 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
43511 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
43520 description: Response codes found in [response codes](https://wiki.onap.org/).
43524 description: unique name of Physical Network Function.
43527 example: __PNF-NAME__
43528 - name: interface-name
43530 description: Name that identifies the physical interface
43533 example: __INTERFACE-NAME__
43534 - name: interface-name
43536 description: Name given to the interface
43539 example: __INTERFACE-NAME__
43540 - name: l3-interface-ipv4-address
43542 description: IP address
43545 example: __L3-INTERFACE-IPV4-ADDRESS__
43548 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
43551 $ref: "#/definitions/l3-interface-ipv4-address-list"
43555 summary: update an existing l3-interface-ipv4-address-list
43557 Update an existing l3-interface-ipv4-address-list
43559 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43560 The PUT operation will entirely replace an existing object.
43561 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
43563 Other differences between PUT and PATCH are:
43565 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
43566 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43567 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43568 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
43577 description: Response codes found in [response codes](https://wiki.onap.org/).
43581 description: unique name of Physical Network Function.
43584 example: __PNF-NAME__
43585 - name: interface-name
43587 description: Name that identifies the physical interface
43590 example: __INTERFACE-NAME__
43591 - name: interface-name
43593 description: Name given to the interface
43596 example: __INTERFACE-NAME__
43597 - name: l3-interface-ipv4-address
43599 description: IP address
43602 example: __L3-INTERFACE-IPV4-ADDRESS__
43605 description: l3-interface-ipv4-address-list object that needs to be created or updated.
43608 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
43612 summary: delete an existing l3-interface-ipv4-address-list
43613 description: delete an existing l3-interface-ipv4-address-list
43614 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
43623 description: Response codes found in [response codes](https://wiki.onap.org/).
43627 description: unique name of Physical Network Function.
43630 example: __PNF-NAME__
43631 - name: interface-name
43633 description: Name that identifies the physical interface
43636 example: __INTERFACE-NAME__
43637 - name: interface-name
43639 description: Name given to the interface
43642 example: __INTERFACE-NAME__
43643 - name: l3-interface-ipv4-address
43645 description: IP address
43648 example: __L3-INTERFACE-IPV4-ADDRESS__
43649 - name: resource-version
43651 description: resource-version for concurrency
43654 /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:
43658 summary: see node definition for valid relationships
43659 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
43668 description: Response codes found in [response codes](https://wiki.onap.org/).
43672 description: unique name of Physical Network Function.
43675 example: __PNF-NAME__
43676 - name: interface-name
43678 description: Name that identifies the physical interface
43681 example: __INTERFACE-NAME__
43682 - name: interface-name
43684 description: Name given to the interface
43687 example: __INTERFACE-NAME__
43688 - name: l3-interface-ipv6-address
43690 description: IP address
43693 example: __L3-INTERFACE-IPV6-ADDRESS__
43696 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
43699 $ref: "#/definitions/relationship"
43703 summary: delete an existing relationship
43704 description: delete an existing relationship
43705 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
43714 description: Response codes found in [response codes](https://wiki.onap.org/).
43718 description: unique name of Physical Network Function.
43721 example: __PNF-NAME__
43722 - name: interface-name
43724 description: Name that identifies the physical interface
43727 example: __INTERFACE-NAME__
43728 - name: interface-name
43730 description: Name given to the interface
43733 example: __INTERFACE-NAME__
43734 - name: l3-interface-ipv6-address
43736 description: IP address
43739 example: __L3-INTERFACE-IPV6-ADDRESS__
43740 /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}:
43744 summary: returns l3-interface-ipv6-address-list
43745 description: returns l3-interface-ipv6-address-list
43746 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
43752 description: successful operation
43754 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
43756 description: Response codes found in [response codes](https://wiki.onap.org/).
43760 description: unique name of Physical Network Function.
43763 example: __PNF-NAME__
43764 - name: interface-name
43766 description: Name that identifies the physical interface
43769 example: __INTERFACE-NAME__
43770 - name: interface-name
43772 description: Name given to the interface
43775 example: __INTERFACE-NAME__
43776 - name: l3-interface-ipv6-address
43778 description: IP address
43781 example: __L3-INTERFACE-IPV6-ADDRESS__
43784 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
43787 - name: prov-status
43789 description: Trigger for operational monitoring of this resource by Service Assurance systems.
43792 - name: interface-id
43794 description: ID of interface
43799 description: MAC address for the interface
43802 - name: network-name
43804 description: Name of the network
43807 - name: vlan-id-inner
43809 description: Inner VLAN tag
43813 - name: neutron-network-id
43815 description: Neutron network id of the interface that address belongs to
43818 - name: neutron-subnet-id
43820 description: Neutron id of subnet that address belongs to
43826 summary: create or update an existing l3-interface-ipv6-address-list
43828 Create or update an existing l3-interface-ipv6-address-list.
43830 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
43831 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
43840 description: Response codes found in [response codes](https://wiki.onap.org/).
43844 description: unique name of Physical Network Function.
43847 example: __PNF-NAME__
43848 - name: interface-name
43850 description: Name that identifies the physical interface
43853 example: __INTERFACE-NAME__
43854 - name: interface-name
43856 description: Name given to the interface
43859 example: __INTERFACE-NAME__
43860 - name: l3-interface-ipv6-address
43862 description: IP address
43865 example: __L3-INTERFACE-IPV6-ADDRESS__
43868 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
43871 $ref: "#/definitions/l3-interface-ipv6-address-list"
43875 summary: update an existing l3-interface-ipv6-address-list
43877 Update an existing l3-interface-ipv6-address-list
43879 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43880 The PUT operation will entirely replace an existing object.
43881 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
43883 Other differences between PUT and PATCH are:
43885 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
43886 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43887 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43888 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
43897 description: Response codes found in [response codes](https://wiki.onap.org/).
43901 description: unique name of Physical Network Function.
43904 example: __PNF-NAME__
43905 - name: interface-name
43907 description: Name that identifies the physical interface
43910 example: __INTERFACE-NAME__
43911 - name: interface-name
43913 description: Name given to the interface
43916 example: __INTERFACE-NAME__
43917 - name: l3-interface-ipv6-address
43919 description: IP address
43922 example: __L3-INTERFACE-IPV6-ADDRESS__
43925 description: l3-interface-ipv6-address-list object that needs to be created or updated.
43928 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
43932 summary: delete an existing l3-interface-ipv6-address-list
43933 description: delete an existing l3-interface-ipv6-address-list
43934 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
43943 description: Response codes found in [response codes](https://wiki.onap.org/).
43947 description: unique name of Physical Network Function.
43950 example: __PNF-NAME__
43951 - name: interface-name
43953 description: Name that identifies the physical interface
43956 example: __INTERFACE-NAME__
43957 - name: interface-name
43959 description: Name given to the interface
43962 example: __INTERFACE-NAME__
43963 - name: l3-interface-ipv6-address
43965 description: IP address
43968 example: __L3-INTERFACE-IPV6-ADDRESS__
43969 - name: resource-version
43971 description: resource-version for concurrency
43974 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
43978 summary: returns l-interface
43979 description: returns l-interface
43980 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
43986 description: successful operation
43988 $ref: "#/getDefinitions/l-interface"
43990 description: Response codes found in [response codes](https://wiki.onap.org/).
43994 description: unique name of Physical Network Function.
43997 example: __PNF-NAME__
43998 - name: interface-name
44000 description: Name that identifies the physical interface
44003 example: __INTERFACE-NAME__
44004 - name: interface-name
44006 description: Name given to the interface
44009 example: __INTERFACE-NAME__
44012 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
44015 - name: prov-status
44017 description: Trigger for operational monitoring of this resource by Service Assurance systems.
44020 - name: interface-id
44022 description: ID of interface
44027 description: MAC address for the interface
44030 - name: network-name
44032 description: Name of the network
44038 summary: create or update an existing l-interface
44040 Create or update an existing l-interface.
44042 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
44043 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
44052 description: Response codes found in [response codes](https://wiki.onap.org/).
44056 description: unique name of Physical Network Function.
44059 example: __PNF-NAME__
44060 - name: interface-name
44062 description: Name that identifies the physical interface
44065 example: __INTERFACE-NAME__
44066 - name: interface-name
44068 description: Name given to the interface
44071 example: __INTERFACE-NAME__
44074 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
44077 $ref: "#/definitions/l-interface"
44081 summary: update an existing l-interface
44083 Update an existing l-interface
44085 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44086 The PUT operation will entirely replace an existing object.
44087 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
44089 Other differences between PUT and PATCH are:
44091 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
44092 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44093 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44094 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
44103 description: Response codes found in [response codes](https://wiki.onap.org/).
44107 description: unique name of Physical Network Function.
44110 example: __PNF-NAME__
44111 - name: interface-name
44113 description: Name that identifies the physical interface
44116 example: __INTERFACE-NAME__
44117 - name: interface-name
44119 description: Name given to the interface
44122 example: __INTERFACE-NAME__
44125 description: l-interface object that needs to be created or updated.
44128 $ref: "#/patchDefinitions/l-interface"
44132 summary: delete an existing l-interface
44133 description: delete an existing l-interface
44134 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
44143 description: Response codes found in [response codes](https://wiki.onap.org/).
44147 description: unique name of Physical Network Function.
44150 example: __PNF-NAME__
44151 - name: interface-name
44153 description: Name that identifies the physical interface
44156 example: __INTERFACE-NAME__
44157 - name: interface-name
44159 description: Name given to the interface
44162 example: __INTERFACE-NAME__
44163 - name: resource-version
44165 description: resource-version for concurrency
44168 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
44172 summary: returns l-interfaces
44173 description: returns l-interfaces
44174 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces
44180 description: successful operation
44182 $ref: "#/getDefinitions/l-interfaces"
44184 description: Response codes found in [response codes](https://wiki.onap.org/).
44188 description: unique name of Physical Network Function.
44191 example: __PNF-NAME__
44192 - name: interface-name
44194 description: Name that identifies the physical interface
44197 example: __INTERFACE-NAME__
44200 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
44203 - name: prov-status
44205 description: Trigger for operational monitoring of this resource by Service Assurance systems.
44208 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}:
44212 summary: returns p-interface
44213 description: returns p-interface
44214 operationId: getNetworkPnfsPnfPInterfacesPInterface
44220 description: successful operation
44222 $ref: "#/getDefinitions/p-interface"
44224 description: Response codes found in [response codes](https://wiki.onap.org/).
44228 description: unique name of Physical Network Function.
44231 example: __PNF-NAME__
44232 - name: interface-name
44234 description: Name that identifies the physical interface
44237 example: __INTERFACE-NAME__
44240 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
44243 - name: prov-status
44245 description: Trigger for operational monitoring of this resource by Service Assurance systems.
44251 summary: create or update an existing p-interface
44253 Create or update an existing p-interface.
44255 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
44256 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterface
44265 description: Response codes found in [response codes](https://wiki.onap.org/).
44269 description: unique name of Physical Network Function.
44272 example: __PNF-NAME__
44273 - name: interface-name
44275 description: Name that identifies the physical interface
44278 example: __INTERFACE-NAME__
44281 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterface.json)
44284 $ref: "#/definitions/p-interface"
44288 summary: update an existing p-interface
44290 Update an existing p-interface
44292 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44293 The PUT operation will entirely replace an existing object.
44294 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
44296 Other differences between PUT and PATCH are:
44298 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
44299 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44300 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44301 operationId: UpdateNetworkPnfsPnfPInterfacesPInterface
44310 description: Response codes found in [response codes](https://wiki.onap.org/).
44314 description: unique name of Physical Network Function.
44317 example: __PNF-NAME__
44318 - name: interface-name
44320 description: Name that identifies the physical interface
44323 example: __INTERFACE-NAME__
44326 description: p-interface object that needs to be created or updated.
44329 $ref: "#/patchDefinitions/p-interface"
44333 summary: delete an existing p-interface
44334 description: delete an existing p-interface
44335 operationId: deleteNetworkPnfsPnfPInterfacesPInterface
44344 description: Response codes found in [response codes](https://wiki.onap.org/).
44348 description: unique name of Physical Network Function.
44351 example: __PNF-NAME__
44352 - name: interface-name
44354 description: Name that identifies the physical interface
44357 example: __INTERFACE-NAME__
44358 - name: resource-version
44360 description: resource-version for concurrency
44363 /network/pnfs/pnf/{pnf-name}/p-interfaces:
44367 summary: returns p-interfaces
44368 description: returns p-interfaces
44369 operationId: getNetworkPnfsPnfPInterfaces
44375 description: successful operation
44377 $ref: "#/getDefinitions/p-interfaces"
44379 description: Response codes found in [response codes](https://wiki.onap.org/).
44383 description: unique name of Physical Network Function.
44386 example: __PNF-NAME__
44389 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
44392 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
44396 summary: see node definition for valid relationships
44397 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
44406 description: Response codes found in [response codes](https://wiki.onap.org/).
44410 description: unique name of Physical Network Function.
44413 example: __PNF-NAME__
44414 - name: interface-name
44416 description: Name that identifies the link aggregate interface
44419 example: __INTERFACE-NAME__
44422 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterface.json)
44425 $ref: "#/definitions/relationship"
44429 summary: delete an existing relationship
44430 description: delete an existing relationship
44431 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
44440 description: Response codes found in [response codes](https://wiki.onap.org/).
44444 description: unique name of Physical Network Function.
44447 example: __PNF-NAME__
44448 - name: interface-name
44450 description: Name that identifies the link aggregate interface
44453 example: __INTERFACE-NAME__
44454 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
44458 summary: see node definition for valid relationships
44459 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
44468 description: Response codes found in [response codes](https://wiki.onap.org/).
44472 description: unique name of Physical Network Function.
44475 example: __PNF-NAME__
44476 - name: interface-name
44478 description: Name that identifies the link aggregate interface
44481 example: __INTERFACE-NAME__
44482 - name: interface-name
44484 description: Name given to the interface
44487 example: __INTERFACE-NAME__
44488 - name: vlan-interface
44490 description: String that identifies the interface
44493 example: __VLAN-INTERFACE__
44496 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
44499 $ref: "#/definitions/relationship"
44503 summary: delete an existing relationship
44504 description: delete an existing relationship
44505 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
44514 description: Response codes found in [response codes](https://wiki.onap.org/).
44518 description: unique name of Physical Network Function.
44521 example: __PNF-NAME__
44522 - name: interface-name
44524 description: Name that identifies the link aggregate interface
44527 example: __INTERFACE-NAME__
44528 - name: interface-name
44530 description: Name given to the interface
44533 example: __INTERFACE-NAME__
44534 - name: vlan-interface
44536 description: String that identifies the interface
44539 example: __VLAN-INTERFACE__
44540 /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:
44544 summary: see node definition for valid relationships
44545 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
44554 description: Response codes found in [response codes](https://wiki.onap.org/).
44558 description: unique name of Physical Network Function.
44561 example: __PNF-NAME__
44562 - name: interface-name
44564 description: Name that identifies the link aggregate interface
44567 example: __INTERFACE-NAME__
44568 - name: interface-name
44570 description: Name given to the interface
44573 example: __INTERFACE-NAME__
44574 - name: vlan-interface
44576 description: String that identifies the interface
44579 example: __VLAN-INTERFACE__
44580 - name: l3-interface-ipv4-address
44582 description: IP address
44585 example: __L3-INTERFACE-IPV4-ADDRESS__
44588 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
44591 $ref: "#/definitions/relationship"
44595 summary: delete an existing relationship
44596 description: delete an existing relationship
44597 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
44606 description: Response codes found in [response codes](https://wiki.onap.org/).
44610 description: unique name of Physical Network Function.
44613 example: __PNF-NAME__
44614 - name: interface-name
44616 description: Name that identifies the link aggregate interface
44619 example: __INTERFACE-NAME__
44620 - name: interface-name
44622 description: Name given to the interface
44625 example: __INTERFACE-NAME__
44626 - name: vlan-interface
44628 description: String that identifies the interface
44631 example: __VLAN-INTERFACE__
44632 - name: l3-interface-ipv4-address
44634 description: IP address
44637 example: __L3-INTERFACE-IPV4-ADDRESS__
44638 /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}:
44642 summary: returns l3-interface-ipv4-address-list
44643 description: returns l3-interface-ipv4-address-list
44644 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
44650 description: successful operation
44652 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
44654 description: Response codes found in [response codes](https://wiki.onap.org/).
44658 description: unique name of Physical Network Function.
44661 example: __PNF-NAME__
44662 - name: interface-name
44664 description: Name that identifies the link aggregate interface
44667 example: __INTERFACE-NAME__
44668 - name: interface-name
44670 description: Name given to the interface
44673 example: __INTERFACE-NAME__
44674 - name: vlan-interface
44676 description: String that identifies the interface
44679 example: __VLAN-INTERFACE__
44680 - name: l3-interface-ipv4-address
44682 description: IP address
44685 example: __L3-INTERFACE-IPV4-ADDRESS__
44688 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
44691 - name: interface-id
44693 description: ID of interface
44696 - name: interface-role
44698 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
44701 - name: interface-id
44703 description: ID of interface
44708 description: MAC address for the interface
44711 - name: network-name
44713 description: Name of the network
44716 - name: vlan-id-inner
44718 description: Inner VLAN tag
44724 description: This indicates the customers VPN ID associated with this vlan
44727 - name: vlan-id-inner
44729 description: Inner VLAN tag
44733 - name: neutron-network-id
44735 description: Neutron network id of the interface that address belongs to
44738 - name: neutron-subnet-id
44740 description: Neutron id of subnet that address belongs to
44746 summary: create or update an existing l3-interface-ipv4-address-list
44748 Create or update an existing l3-interface-ipv4-address-list.
44750 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
44751 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
44760 description: Response codes found in [response codes](https://wiki.onap.org/).
44764 description: unique name of Physical Network Function.
44767 example: __PNF-NAME__
44768 - name: interface-name
44770 description: Name that identifies the link aggregate interface
44773 example: __INTERFACE-NAME__
44774 - name: interface-name
44776 description: Name given to the interface
44779 example: __INTERFACE-NAME__
44780 - name: vlan-interface
44782 description: String that identifies the interface
44785 example: __VLAN-INTERFACE__
44786 - name: l3-interface-ipv4-address
44788 description: IP address
44791 example: __L3-INTERFACE-IPV4-ADDRESS__
44794 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
44797 $ref: "#/definitions/l3-interface-ipv4-address-list"
44801 summary: update an existing l3-interface-ipv4-address-list
44803 Update an existing l3-interface-ipv4-address-list
44805 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44806 The PUT operation will entirely replace an existing object.
44807 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
44809 Other differences between PUT and PATCH are:
44811 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
44812 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44813 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44814 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
44823 description: Response codes found in [response codes](https://wiki.onap.org/).
44827 description: unique name of Physical Network Function.
44830 example: __PNF-NAME__
44831 - name: interface-name
44833 description: Name that identifies the link aggregate interface
44836 example: __INTERFACE-NAME__
44837 - name: interface-name
44839 description: Name given to the interface
44842 example: __INTERFACE-NAME__
44843 - name: vlan-interface
44845 description: String that identifies the interface
44848 example: __VLAN-INTERFACE__
44849 - name: l3-interface-ipv4-address
44851 description: IP address
44854 example: __L3-INTERFACE-IPV4-ADDRESS__
44857 description: l3-interface-ipv4-address-list object that needs to be created or updated.
44860 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
44864 summary: delete an existing l3-interface-ipv4-address-list
44865 description: delete an existing l3-interface-ipv4-address-list
44866 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
44875 description: Response codes found in [response codes](https://wiki.onap.org/).
44879 description: unique name of Physical Network Function.
44882 example: __PNF-NAME__
44883 - name: interface-name
44885 description: Name that identifies the link aggregate interface
44888 example: __INTERFACE-NAME__
44889 - name: interface-name
44891 description: Name given to the interface
44894 example: __INTERFACE-NAME__
44895 - name: vlan-interface
44897 description: String that identifies the interface
44900 example: __VLAN-INTERFACE__
44901 - name: l3-interface-ipv4-address
44903 description: IP address
44906 example: __L3-INTERFACE-IPV4-ADDRESS__
44907 - name: resource-version
44909 description: resource-version for concurrency
44912 /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:
44916 summary: see node definition for valid relationships
44917 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
44926 description: Response codes found in [response codes](https://wiki.onap.org/).
44930 description: unique name of Physical Network Function.
44933 example: __PNF-NAME__
44934 - name: interface-name
44936 description: Name that identifies the link aggregate interface
44939 example: __INTERFACE-NAME__
44940 - name: interface-name
44942 description: Name given to the interface
44945 example: __INTERFACE-NAME__
44946 - name: vlan-interface
44948 description: String that identifies the interface
44951 example: __VLAN-INTERFACE__
44952 - name: l3-interface-ipv6-address
44954 description: IP address
44957 example: __L3-INTERFACE-IPV6-ADDRESS__
44960 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
44963 $ref: "#/definitions/relationship"
44967 summary: delete an existing relationship
44968 description: delete an existing relationship
44969 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
44978 description: Response codes found in [response codes](https://wiki.onap.org/).
44982 description: unique name of Physical Network Function.
44985 example: __PNF-NAME__
44986 - name: interface-name
44988 description: Name that identifies the link aggregate interface
44991 example: __INTERFACE-NAME__
44992 - name: interface-name
44994 description: Name given to the interface
44997 example: __INTERFACE-NAME__
44998 - name: vlan-interface
45000 description: String that identifies the interface
45003 example: __VLAN-INTERFACE__
45004 - name: l3-interface-ipv6-address
45006 description: IP address
45009 example: __L3-INTERFACE-IPV6-ADDRESS__
45010 /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}:
45014 summary: returns l3-interface-ipv6-address-list
45015 description: returns l3-interface-ipv6-address-list
45016 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
45022 description: successful operation
45024 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
45026 description: Response codes found in [response codes](https://wiki.onap.org/).
45030 description: unique name of Physical Network Function.
45033 example: __PNF-NAME__
45034 - name: interface-name
45036 description: Name that identifies the link aggregate interface
45039 example: __INTERFACE-NAME__
45040 - name: interface-name
45042 description: Name given to the interface
45045 example: __INTERFACE-NAME__
45046 - name: vlan-interface
45048 description: String that identifies the interface
45051 example: __VLAN-INTERFACE__
45052 - name: l3-interface-ipv6-address
45054 description: IP address
45057 example: __L3-INTERFACE-IPV6-ADDRESS__
45060 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
45063 - name: interface-id
45065 description: ID of interface
45068 - name: interface-role
45070 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
45073 - name: interface-id
45075 description: ID of interface
45080 description: MAC address for the interface
45083 - name: network-name
45085 description: Name of the network
45088 - name: vlan-id-inner
45090 description: Inner VLAN tag
45096 description: This indicates the customers VPN ID associated with this vlan
45099 - name: vlan-id-inner
45101 description: Inner VLAN tag
45105 - name: neutron-network-id
45107 description: Neutron network id of the interface that address belongs to
45110 - name: neutron-subnet-id
45112 description: Neutron id of subnet that address belongs to
45118 summary: create or update an existing l3-interface-ipv6-address-list
45120 Create or update an existing l3-interface-ipv6-address-list.
45122 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
45123 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
45132 description: Response codes found in [response codes](https://wiki.onap.org/).
45136 description: unique name of Physical Network Function.
45139 example: __PNF-NAME__
45140 - name: interface-name
45142 description: Name that identifies the link aggregate interface
45145 example: __INTERFACE-NAME__
45146 - name: interface-name
45148 description: Name given to the interface
45151 example: __INTERFACE-NAME__
45152 - name: vlan-interface
45154 description: String that identifies the interface
45157 example: __VLAN-INTERFACE__
45158 - name: l3-interface-ipv6-address
45160 description: IP address
45163 example: __L3-INTERFACE-IPV6-ADDRESS__
45166 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
45169 $ref: "#/definitions/l3-interface-ipv6-address-list"
45173 summary: update an existing l3-interface-ipv6-address-list
45175 Update an existing l3-interface-ipv6-address-list
45177 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45178 The PUT operation will entirely replace an existing object.
45179 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
45181 Other differences between PUT and PATCH are:
45183 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
45184 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45185 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45186 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
45195 description: Response codes found in [response codes](https://wiki.onap.org/).
45199 description: unique name of Physical Network Function.
45202 example: __PNF-NAME__
45203 - name: interface-name
45205 description: Name that identifies the link aggregate interface
45208 example: __INTERFACE-NAME__
45209 - name: interface-name
45211 description: Name given to the interface
45214 example: __INTERFACE-NAME__
45215 - name: vlan-interface
45217 description: String that identifies the interface
45220 example: __VLAN-INTERFACE__
45221 - name: l3-interface-ipv6-address
45223 description: IP address
45226 example: __L3-INTERFACE-IPV6-ADDRESS__
45229 description: l3-interface-ipv6-address-list object that needs to be created or updated.
45232 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
45236 summary: delete an existing l3-interface-ipv6-address-list
45237 description: delete an existing l3-interface-ipv6-address-list
45238 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
45247 description: Response codes found in [response codes](https://wiki.onap.org/).
45251 description: unique name of Physical Network Function.
45254 example: __PNF-NAME__
45255 - name: interface-name
45257 description: Name that identifies the link aggregate interface
45260 example: __INTERFACE-NAME__
45261 - name: interface-name
45263 description: Name given to the interface
45266 example: __INTERFACE-NAME__
45267 - name: vlan-interface
45269 description: String that identifies the interface
45272 example: __VLAN-INTERFACE__
45273 - name: l3-interface-ipv6-address
45275 description: IP address
45278 example: __L3-INTERFACE-IPV6-ADDRESS__
45279 - name: resource-version
45281 description: resource-version for concurrency
45284 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
45288 summary: returns vlan
45289 description: returns vlan
45290 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
45296 description: successful operation
45298 $ref: "#/getDefinitions/vlan"
45300 description: Response codes found in [response codes](https://wiki.onap.org/).
45304 description: unique name of Physical Network Function.
45307 example: __PNF-NAME__
45308 - name: interface-name
45310 description: Name that identifies the link aggregate interface
45313 example: __INTERFACE-NAME__
45314 - name: interface-name
45316 description: Name given to the interface
45319 example: __INTERFACE-NAME__
45320 - name: vlan-interface
45322 description: String that identifies the interface
45325 example: __VLAN-INTERFACE__
45328 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
45331 - name: interface-id
45333 description: ID of interface
45336 - name: interface-role
45338 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
45341 - name: interface-id
45343 description: ID of interface
45348 description: MAC address for the interface
45351 - name: network-name
45353 description: Name of the network
45356 - name: vlan-id-inner
45358 description: Inner VLAN tag
45364 description: This indicates the customers VPN ID associated with this vlan
45370 summary: create or update an existing vlan
45372 Create or update an existing vlan.
45374 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
45375 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
45384 description: Response codes found in [response codes](https://wiki.onap.org/).
45388 description: unique name of Physical Network Function.
45391 example: __PNF-NAME__
45392 - name: interface-name
45394 description: Name that identifies the link aggregate interface
45397 example: __INTERFACE-NAME__
45398 - name: interface-name
45400 description: Name given to the interface
45403 example: __INTERFACE-NAME__
45404 - name: vlan-interface
45406 description: String that identifies the interface
45409 example: __VLAN-INTERFACE__
45412 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
45415 $ref: "#/definitions/vlan"
45419 summary: update an existing vlan
45421 Update an existing vlan
45423 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45424 The PUT operation will entirely replace an existing object.
45425 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
45427 Other differences between PUT and PATCH are:
45429 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
45430 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45431 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45432 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
45441 description: Response codes found in [response codes](https://wiki.onap.org/).
45445 description: unique name of Physical Network Function.
45448 example: __PNF-NAME__
45449 - name: interface-name
45451 description: Name that identifies the link aggregate interface
45454 example: __INTERFACE-NAME__
45455 - name: interface-name
45457 description: Name given to the interface
45460 example: __INTERFACE-NAME__
45461 - name: vlan-interface
45463 description: String that identifies the interface
45466 example: __VLAN-INTERFACE__
45469 description: vlan object that needs to be created or updated.
45472 $ref: "#/patchDefinitions/vlan"
45476 summary: delete an existing vlan
45477 description: delete an existing vlan
45478 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
45487 description: Response codes found in [response codes](https://wiki.onap.org/).
45491 description: unique name of Physical Network Function.
45494 example: __PNF-NAME__
45495 - name: interface-name
45497 description: Name that identifies the link aggregate interface
45500 example: __INTERFACE-NAME__
45501 - name: interface-name
45503 description: Name given to the interface
45506 example: __INTERFACE-NAME__
45507 - name: vlan-interface
45509 description: String that identifies the interface
45512 example: __VLAN-INTERFACE__
45513 - name: resource-version
45515 description: resource-version for concurrency
45518 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
45522 summary: returns vlans
45523 description: returns vlans
45524 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
45530 description: successful operation
45532 $ref: "#/getDefinitions/vlans"
45534 description: Response codes found in [response codes](https://wiki.onap.org/).
45538 description: unique name of Physical Network Function.
45541 example: __PNF-NAME__
45542 - name: interface-name
45544 description: Name that identifies the link aggregate interface
45547 example: __INTERFACE-NAME__
45548 - name: interface-name
45550 description: Name given to the interface
45553 example: __INTERFACE-NAME__
45556 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
45559 - name: interface-id
45561 description: ID of interface
45564 - name: interface-role
45566 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
45569 - name: interface-id
45571 description: ID of interface
45576 description: MAC address for the interface
45579 - name: network-name
45581 description: Name of the network
45584 /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:
45588 summary: see node definition for valid relationships
45589 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
45598 description: Response codes found in [response codes](https://wiki.onap.org/).
45602 description: unique name of Physical Network Function.
45605 example: __PNF-NAME__
45606 - name: interface-name
45608 description: Name that identifies the link aggregate interface
45611 example: __INTERFACE-NAME__
45612 - name: interface-name
45614 description: Name given to the interface
45617 example: __INTERFACE-NAME__
45620 description: PCI ID used to identify the sriov-vf
45623 example: __PCI-ID__
45626 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
45629 $ref: "#/definitions/relationship"
45633 summary: delete an existing relationship
45634 description: delete an existing relationship
45635 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
45644 description: Response codes found in [response codes](https://wiki.onap.org/).
45648 description: unique name of Physical Network Function.
45651 example: __PNF-NAME__
45652 - name: interface-name
45654 description: Name that identifies the link aggregate interface
45657 example: __INTERFACE-NAME__
45658 - name: interface-name
45660 description: Name given to the interface
45663 example: __INTERFACE-NAME__
45666 description: PCI ID used to identify the sriov-vf
45669 example: __PCI-ID__
45670 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
45674 summary: returns sriov-vf
45675 description: returns sriov-vf
45676 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
45682 description: successful operation
45684 $ref: "#/getDefinitions/sriov-vf"
45686 description: Response codes found in [response codes](https://wiki.onap.org/).
45690 description: unique name of Physical Network Function.
45693 example: __PNF-NAME__
45694 - name: interface-name
45696 description: Name that identifies the link aggregate interface
45699 example: __INTERFACE-NAME__
45700 - name: interface-name
45702 description: Name given to the interface
45705 example: __INTERFACE-NAME__
45708 description: PCI ID used to identify the sriov-vf
45711 example: __PCI-ID__
45714 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
45717 - name: interface-id
45719 description: ID of interface
45722 - name: interface-role
45724 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
45727 - name: interface-id
45729 description: ID of interface
45734 description: MAC address for the interface
45737 - name: network-name
45739 description: Name of the network
45742 - name: vf-vlan-filter
45744 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
45747 - name: vf-mac-filter
45749 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
45752 - name: vf-vlan-strip
45754 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
45757 - name: neutron-network-id
45759 description: Neutron network id of the interface
45765 summary: create or update an existing sriov-vf
45767 Create or update an existing sriov-vf.
45769 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
45770 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
45779 description: Response codes found in [response codes](https://wiki.onap.org/).
45783 description: unique name of Physical Network Function.
45786 example: __PNF-NAME__
45787 - name: interface-name
45789 description: Name that identifies the link aggregate interface
45792 example: __INTERFACE-NAME__
45793 - name: interface-name
45795 description: Name given to the interface
45798 example: __INTERFACE-NAME__
45801 description: PCI ID used to identify the sriov-vf
45804 example: __PCI-ID__
45807 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
45810 $ref: "#/definitions/sriov-vf"
45814 summary: update an existing sriov-vf
45816 Update an existing sriov-vf
45818 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45819 The PUT operation will entirely replace an existing object.
45820 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
45822 Other differences between PUT and PATCH are:
45824 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
45825 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45826 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45827 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
45836 description: Response codes found in [response codes](https://wiki.onap.org/).
45840 description: unique name of Physical Network Function.
45843 example: __PNF-NAME__
45844 - name: interface-name
45846 description: Name that identifies the link aggregate interface
45849 example: __INTERFACE-NAME__
45850 - name: interface-name
45852 description: Name given to the interface
45855 example: __INTERFACE-NAME__
45858 description: PCI ID used to identify the sriov-vf
45861 example: __PCI-ID__
45864 description: sriov-vf object that needs to be created or updated.
45867 $ref: "#/patchDefinitions/sriov-vf"
45871 summary: delete an existing sriov-vf
45872 description: delete an existing sriov-vf
45873 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
45882 description: Response codes found in [response codes](https://wiki.onap.org/).
45886 description: unique name of Physical Network Function.
45889 example: __PNF-NAME__
45890 - name: interface-name
45892 description: Name that identifies the link aggregate interface
45895 example: __INTERFACE-NAME__
45896 - name: interface-name
45898 description: Name given to the interface
45901 example: __INTERFACE-NAME__
45904 description: PCI ID used to identify the sriov-vf
45907 example: __PCI-ID__
45908 - name: resource-version
45910 description: resource-version for concurrency
45913 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
45917 summary: returns sriov-vfs
45918 description: returns sriov-vfs
45919 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
45925 description: successful operation
45927 $ref: "#/getDefinitions/sriov-vfs"
45929 description: Response codes found in [response codes](https://wiki.onap.org/).
45933 description: unique name of Physical Network Function.
45936 example: __PNF-NAME__
45937 - name: interface-name
45939 description: Name that identifies the link aggregate interface
45942 example: __INTERFACE-NAME__
45943 - name: interface-name
45945 description: Name given to the interface
45948 example: __INTERFACE-NAME__
45951 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
45954 - name: interface-id
45956 description: ID of interface
45959 - name: interface-role
45961 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
45964 - name: interface-id
45966 description: ID of interface
45971 description: MAC address for the interface
45974 - name: network-name
45976 description: Name of the network
45979 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
45983 summary: see node definition for valid relationships
45984 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
45993 description: Response codes found in [response codes](https://wiki.onap.org/).
45997 description: unique name of Physical Network Function.
46000 example: __PNF-NAME__
46001 - name: interface-name
46003 description: Name that identifies the link aggregate interface
46006 example: __INTERFACE-NAME__
46007 - name: interface-name
46009 description: Name given to the interface
46012 example: __INTERFACE-NAME__
46015 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
46018 $ref: "#/definitions/relationship"
46022 summary: delete an existing relationship
46023 description: delete an existing relationship
46024 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
46033 description: Response codes found in [response codes](https://wiki.onap.org/).
46037 description: unique name of Physical Network Function.
46040 example: __PNF-NAME__
46041 - name: interface-name
46043 description: Name that identifies the link aggregate interface
46046 example: __INTERFACE-NAME__
46047 - name: interface-name
46049 description: Name given to the interface
46052 example: __INTERFACE-NAME__
46053 /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:
46057 summary: see node definition for valid relationships
46058 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
46067 description: Response codes found in [response codes](https://wiki.onap.org/).
46071 description: unique name of Physical Network Function.
46074 example: __PNF-NAME__
46075 - name: interface-name
46077 description: Name that identifies the link aggregate interface
46080 example: __INTERFACE-NAME__
46081 - name: interface-name
46083 description: Name given to the interface
46086 example: __INTERFACE-NAME__
46087 - name: l3-interface-ipv4-address
46089 description: IP address
46092 example: __L3-INTERFACE-IPV4-ADDRESS__
46095 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
46098 $ref: "#/definitions/relationship"
46102 summary: delete an existing relationship
46103 description: delete an existing relationship
46104 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
46113 description: Response codes found in [response codes](https://wiki.onap.org/).
46117 description: unique name of Physical Network Function.
46120 example: __PNF-NAME__
46121 - name: interface-name
46123 description: Name that identifies the link aggregate interface
46126 example: __INTERFACE-NAME__
46127 - name: interface-name
46129 description: Name given to the interface
46132 example: __INTERFACE-NAME__
46133 - name: l3-interface-ipv4-address
46135 description: IP address
46138 example: __L3-INTERFACE-IPV4-ADDRESS__
46139 /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}:
46143 summary: returns l3-interface-ipv4-address-list
46144 description: returns l3-interface-ipv4-address-list
46145 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
46151 description: successful operation
46153 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
46155 description: Response codes found in [response codes](https://wiki.onap.org/).
46159 description: unique name of Physical Network Function.
46162 example: __PNF-NAME__
46163 - name: interface-name
46165 description: Name that identifies the link aggregate interface
46168 example: __INTERFACE-NAME__
46169 - name: interface-name
46171 description: Name given to the interface
46174 example: __INTERFACE-NAME__
46175 - name: l3-interface-ipv4-address
46177 description: IP address
46180 example: __L3-INTERFACE-IPV4-ADDRESS__
46183 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
46186 - name: interface-id
46188 description: ID of interface
46191 - name: interface-role
46193 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
46196 - name: interface-id
46198 description: ID of interface
46203 description: MAC address for the interface
46206 - name: network-name
46208 description: Name of the network
46211 - name: vlan-id-inner
46213 description: Inner VLAN tag
46217 - name: neutron-network-id
46219 description: Neutron network id of the interface that address belongs to
46222 - name: neutron-subnet-id
46224 description: Neutron id of subnet that address belongs to
46230 summary: create or update an existing l3-interface-ipv4-address-list
46232 Create or update an existing l3-interface-ipv4-address-list.
46234 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
46235 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
46244 description: Response codes found in [response codes](https://wiki.onap.org/).
46248 description: unique name of Physical Network Function.
46251 example: __PNF-NAME__
46252 - name: interface-name
46254 description: Name that identifies the link aggregate interface
46257 example: __INTERFACE-NAME__
46258 - name: interface-name
46260 description: Name given to the interface
46263 example: __INTERFACE-NAME__
46264 - name: l3-interface-ipv4-address
46266 description: IP address
46269 example: __L3-INTERFACE-IPV4-ADDRESS__
46272 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
46275 $ref: "#/definitions/l3-interface-ipv4-address-list"
46279 summary: update an existing l3-interface-ipv4-address-list
46281 Update an existing l3-interface-ipv4-address-list
46283 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46284 The PUT operation will entirely replace an existing object.
46285 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
46287 Other differences between PUT and PATCH are:
46289 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
46290 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46291 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46292 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
46301 description: Response codes found in [response codes](https://wiki.onap.org/).
46305 description: unique name of Physical Network Function.
46308 example: __PNF-NAME__
46309 - name: interface-name
46311 description: Name that identifies the link aggregate interface
46314 example: __INTERFACE-NAME__
46315 - name: interface-name
46317 description: Name given to the interface
46320 example: __INTERFACE-NAME__
46321 - name: l3-interface-ipv4-address
46323 description: IP address
46326 example: __L3-INTERFACE-IPV4-ADDRESS__
46329 description: l3-interface-ipv4-address-list object that needs to be created or updated.
46332 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
46336 summary: delete an existing l3-interface-ipv4-address-list
46337 description: delete an existing l3-interface-ipv4-address-list
46338 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
46347 description: Response codes found in [response codes](https://wiki.onap.org/).
46351 description: unique name of Physical Network Function.
46354 example: __PNF-NAME__
46355 - name: interface-name
46357 description: Name that identifies the link aggregate interface
46360 example: __INTERFACE-NAME__
46361 - name: interface-name
46363 description: Name given to the interface
46366 example: __INTERFACE-NAME__
46367 - name: l3-interface-ipv4-address
46369 description: IP address
46372 example: __L3-INTERFACE-IPV4-ADDRESS__
46373 - name: resource-version
46375 description: resource-version for concurrency
46378 /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:
46382 summary: see node definition for valid relationships
46383 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
46392 description: Response codes found in [response codes](https://wiki.onap.org/).
46396 description: unique name of Physical Network Function.
46399 example: __PNF-NAME__
46400 - name: interface-name
46402 description: Name that identifies the link aggregate interface
46405 example: __INTERFACE-NAME__
46406 - name: interface-name
46408 description: Name given to the interface
46411 example: __INTERFACE-NAME__
46412 - name: l3-interface-ipv6-address
46414 description: IP address
46417 example: __L3-INTERFACE-IPV6-ADDRESS__
46420 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
46423 $ref: "#/definitions/relationship"
46427 summary: delete an existing relationship
46428 description: delete an existing relationship
46429 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
46438 description: Response codes found in [response codes](https://wiki.onap.org/).
46442 description: unique name of Physical Network Function.
46445 example: __PNF-NAME__
46446 - name: interface-name
46448 description: Name that identifies the link aggregate interface
46451 example: __INTERFACE-NAME__
46452 - name: interface-name
46454 description: Name given to the interface
46457 example: __INTERFACE-NAME__
46458 - name: l3-interface-ipv6-address
46460 description: IP address
46463 example: __L3-INTERFACE-IPV6-ADDRESS__
46464 /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}:
46468 summary: returns l3-interface-ipv6-address-list
46469 description: returns l3-interface-ipv6-address-list
46470 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
46476 description: successful operation
46478 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
46480 description: Response codes found in [response codes](https://wiki.onap.org/).
46484 description: unique name of Physical Network Function.
46487 example: __PNF-NAME__
46488 - name: interface-name
46490 description: Name that identifies the link aggregate interface
46493 example: __INTERFACE-NAME__
46494 - name: interface-name
46496 description: Name given to the interface
46499 example: __INTERFACE-NAME__
46500 - name: l3-interface-ipv6-address
46502 description: IP address
46505 example: __L3-INTERFACE-IPV6-ADDRESS__
46508 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
46511 - name: interface-id
46513 description: ID of interface
46516 - name: interface-role
46518 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
46521 - name: interface-id
46523 description: ID of interface
46528 description: MAC address for the interface
46531 - name: network-name
46533 description: Name of the network
46536 - name: vlan-id-inner
46538 description: Inner VLAN tag
46542 - name: neutron-network-id
46544 description: Neutron network id of the interface that address belongs to
46547 - name: neutron-subnet-id
46549 description: Neutron id of subnet that address belongs to
46555 summary: create or update an existing l3-interface-ipv6-address-list
46557 Create or update an existing l3-interface-ipv6-address-list.
46559 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
46560 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
46569 description: Response codes found in [response codes](https://wiki.onap.org/).
46573 description: unique name of Physical Network Function.
46576 example: __PNF-NAME__
46577 - name: interface-name
46579 description: Name that identifies the link aggregate interface
46582 example: __INTERFACE-NAME__
46583 - name: interface-name
46585 description: Name given to the interface
46588 example: __INTERFACE-NAME__
46589 - name: l3-interface-ipv6-address
46591 description: IP address
46594 example: __L3-INTERFACE-IPV6-ADDRESS__
46597 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
46600 $ref: "#/definitions/l3-interface-ipv6-address-list"
46604 summary: update an existing l3-interface-ipv6-address-list
46606 Update an existing l3-interface-ipv6-address-list
46608 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46609 The PUT operation will entirely replace an existing object.
46610 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
46612 Other differences between PUT and PATCH are:
46614 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
46615 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46616 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46617 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
46626 description: Response codes found in [response codes](https://wiki.onap.org/).
46630 description: unique name of Physical Network Function.
46633 example: __PNF-NAME__
46634 - name: interface-name
46636 description: Name that identifies the link aggregate interface
46639 example: __INTERFACE-NAME__
46640 - name: interface-name
46642 description: Name given to the interface
46645 example: __INTERFACE-NAME__
46646 - name: l3-interface-ipv6-address
46648 description: IP address
46651 example: __L3-INTERFACE-IPV6-ADDRESS__
46654 description: l3-interface-ipv6-address-list object that needs to be created or updated.
46657 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
46661 summary: delete an existing l3-interface-ipv6-address-list
46662 description: delete an existing l3-interface-ipv6-address-list
46663 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
46672 description: Response codes found in [response codes](https://wiki.onap.org/).
46676 description: unique name of Physical Network Function.
46679 example: __PNF-NAME__
46680 - name: interface-name
46682 description: Name that identifies the link aggregate interface
46685 example: __INTERFACE-NAME__
46686 - name: interface-name
46688 description: Name given to the interface
46691 example: __INTERFACE-NAME__
46692 - name: l3-interface-ipv6-address
46694 description: IP address
46697 example: __L3-INTERFACE-IPV6-ADDRESS__
46698 - name: resource-version
46700 description: resource-version for concurrency
46703 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
46707 summary: returns l-interface
46708 description: returns l-interface
46709 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
46715 description: successful operation
46717 $ref: "#/getDefinitions/l-interface"
46719 description: Response codes found in [response codes](https://wiki.onap.org/).
46723 description: unique name of Physical Network Function.
46726 example: __PNF-NAME__
46727 - name: interface-name
46729 description: Name that identifies the link aggregate interface
46732 example: __INTERFACE-NAME__
46733 - name: interface-name
46735 description: Name given to the interface
46738 example: __INTERFACE-NAME__
46741 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
46744 - name: interface-id
46746 description: ID of interface
46749 - name: interface-role
46751 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
46754 - name: interface-id
46756 description: ID of interface
46761 description: MAC address for the interface
46764 - name: network-name
46766 description: Name of the network
46772 summary: create or update an existing l-interface
46774 Create or update an existing l-interface.
46776 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
46777 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
46786 description: Response codes found in [response codes](https://wiki.onap.org/).
46790 description: unique name of Physical Network Function.
46793 example: __PNF-NAME__
46794 - name: interface-name
46796 description: Name that identifies the link aggregate interface
46799 example: __INTERFACE-NAME__
46800 - name: interface-name
46802 description: Name given to the interface
46805 example: __INTERFACE-NAME__
46808 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
46811 $ref: "#/definitions/l-interface"
46815 summary: update an existing l-interface
46817 Update an existing l-interface
46819 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46820 The PUT operation will entirely replace an existing object.
46821 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
46823 Other differences between PUT and PATCH are:
46825 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
46826 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46827 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46828 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
46837 description: Response codes found in [response codes](https://wiki.onap.org/).
46841 description: unique name of Physical Network Function.
46844 example: __PNF-NAME__
46845 - name: interface-name
46847 description: Name that identifies the link aggregate interface
46850 example: __INTERFACE-NAME__
46851 - name: interface-name
46853 description: Name given to the interface
46856 example: __INTERFACE-NAME__
46859 description: l-interface object that needs to be created or updated.
46862 $ref: "#/patchDefinitions/l-interface"
46866 summary: delete an existing l-interface
46867 description: delete an existing l-interface
46868 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
46877 description: Response codes found in [response codes](https://wiki.onap.org/).
46881 description: unique name of Physical Network Function.
46884 example: __PNF-NAME__
46885 - name: interface-name
46887 description: Name that identifies the link aggregate interface
46890 example: __INTERFACE-NAME__
46891 - name: interface-name
46893 description: Name given to the interface
46896 example: __INTERFACE-NAME__
46897 - name: resource-version
46899 description: resource-version for concurrency
46902 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
46906 summary: returns l-interfaces
46907 description: returns l-interfaces
46908 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces
46914 description: successful operation
46916 $ref: "#/getDefinitions/l-interfaces"
46918 description: Response codes found in [response codes](https://wiki.onap.org/).
46922 description: unique name of Physical Network Function.
46925 example: __PNF-NAME__
46926 - name: interface-name
46928 description: Name that identifies the link aggregate interface
46931 example: __INTERFACE-NAME__
46934 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
46937 - name: interface-id
46939 description: ID of interface
46942 - name: interface-role
46944 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
46947 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}:
46951 summary: returns lag-interface
46952 description: returns lag-interface
46953 operationId: getNetworkPnfsPnfLagInterfacesLagInterface
46959 description: successful operation
46961 $ref: "#/getDefinitions/lag-interface"
46963 description: Response codes found in [response codes](https://wiki.onap.org/).
46967 description: unique name of Physical Network Function.
46970 example: __PNF-NAME__
46971 - name: interface-name
46973 description: Name that identifies the link aggregate interface
46976 example: __INTERFACE-NAME__
46979 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
46982 - name: interface-id
46984 description: ID of interface
46987 - name: interface-role
46989 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
46995 summary: create or update an existing lag-interface
46997 Create or update an existing lag-interface.
46999 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
47000 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface
47009 description: Response codes found in [response codes](https://wiki.onap.org/).
47013 description: unique name of Physical Network Function.
47016 example: __PNF-NAME__
47017 - name: interface-name
47019 description: Name that identifies the link aggregate interface
47022 example: __INTERFACE-NAME__
47025 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterface.json)
47028 $ref: "#/definitions/lag-interface"
47032 summary: update an existing lag-interface
47034 Update an existing lag-interface
47036 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47037 The PUT operation will entirely replace an existing object.
47038 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
47040 Other differences between PUT and PATCH are:
47042 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
47043 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47044 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47045 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterface
47054 description: Response codes found in [response codes](https://wiki.onap.org/).
47058 description: unique name of Physical Network Function.
47061 example: __PNF-NAME__
47062 - name: interface-name
47064 description: Name that identifies the link aggregate interface
47067 example: __INTERFACE-NAME__
47070 description: lag-interface object that needs to be created or updated.
47073 $ref: "#/patchDefinitions/lag-interface"
47077 summary: delete an existing lag-interface
47078 description: delete an existing lag-interface
47079 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface
47088 description: Response codes found in [response codes](https://wiki.onap.org/).
47092 description: unique name of Physical Network Function.
47095 example: __PNF-NAME__
47096 - name: interface-name
47098 description: Name that identifies the link aggregate interface
47101 example: __INTERFACE-NAME__
47102 - name: resource-version
47104 description: resource-version for concurrency
47107 /network/pnfs/pnf/{pnf-name}/lag-interfaces:
47111 summary: returns lag-interfaces
47112 description: returns lag-interfaces
47113 operationId: getNetworkPnfsPnfLagInterfaces
47119 description: successful operation
47121 $ref: "#/getDefinitions/lag-interfaces"
47123 description: Response codes found in [response codes](https://wiki.onap.org/).
47127 description: unique name of Physical Network Function.
47130 example: __PNF-NAME__
47133 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
47136 /network/pnfs/pnf/{pnf-name}:
47140 summary: returns pnf
47141 description: returns pnf
47142 operationId: getNetworkPnfsPnf
47148 description: successful operation
47150 $ref: "#/getDefinitions/pnf"
47152 description: Response codes found in [response codes](https://wiki.onap.org/).
47156 description: unique name of Physical Network Function.
47159 example: __PNF-NAME__
47162 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
47168 summary: create or update an existing pnf
47170 Create or update an existing pnf.
47172 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
47173 operationId: createOrUpdateNetworkPnfsPnf
47182 description: Response codes found in [response codes](https://wiki.onap.org/).
47186 description: unique name of Physical Network Function.
47189 example: __PNF-NAME__
47192 description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnf.json)
47195 $ref: "#/definitions/pnf"
47199 summary: update an existing pnf
47201 Update an existing pnf
47203 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47204 The PUT operation will entirely replace an existing object.
47205 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
47207 Other differences between PUT and PATCH are:
47209 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
47210 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47211 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47212 operationId: UpdateNetworkPnfsPnf
47221 description: Response codes found in [response codes](https://wiki.onap.org/).
47225 description: unique name of Physical Network Function.
47228 example: __PNF-NAME__
47231 description: pnf object that needs to be created or updated.
47234 $ref: "#/patchDefinitions/pnf"
47238 summary: delete an existing pnf
47239 description: delete an existing pnf
47240 operationId: deleteNetworkPnfsPnf
47249 description: Response codes found in [response codes](https://wiki.onap.org/).
47253 description: unique name of Physical Network Function.
47256 example: __PNF-NAME__
47257 - name: resource-version
47259 description: resource-version for concurrency
47266 summary: returns pnfs
47267 description: returns pnfs
47268 operationId: getNetworkPnfs
47274 description: successful operation
47276 $ref: "#/getDefinitions/pnfs"
47278 description: Response codes found in [response codes](https://wiki.onap.org/).
47279 /network/physical-links/physical-link/{link-name}/relationship-list/relationship:
47283 summary: see node definition for valid relationships
47284 operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
47293 description: Response codes found in [response codes](https://wiki.onap.org/).
47297 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
47300 example: __LINK-NAME__
47303 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPhysicalLinksPhysicalLink.json)
47306 $ref: "#/definitions/relationship"
47310 summary: delete an existing relationship
47311 description: delete an existing relationship
47312 operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
47321 description: Response codes found in [response codes](https://wiki.onap.org/).
47325 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
47328 example: __LINK-NAME__
47329 /network/physical-links/physical-link/{link-name}:
47333 summary: returns physical-link
47334 description: returns physical-link
47335 operationId: getNetworkPhysicalLinksPhysicalLink
47341 description: successful operation
47343 $ref: "#/getDefinitions/physical-link"
47345 description: Response codes found in [response codes](https://wiki.onap.org/).
47349 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
47352 example: __LINK-NAME__
47355 description: Circuit it
47361 summary: create or update an existing physical-link
47363 Create or update an existing physical-link.
47365 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
47366 operationId: createOrUpdateNetworkPhysicalLinksPhysicalLink
47375 description: Response codes found in [response codes](https://wiki.onap.org/).
47379 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
47382 example: __LINK-NAME__
47385 description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPhysicalLinksPhysicalLink.json)
47388 $ref: "#/definitions/physical-link"
47392 summary: update an existing physical-link
47394 Update an existing physical-link
47396 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47397 The PUT operation will entirely replace an existing object.
47398 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
47400 Other differences between PUT and PATCH are:
47402 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
47403 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47404 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47405 operationId: UpdateNetworkPhysicalLinksPhysicalLink
47414 description: Response codes found in [response codes](https://wiki.onap.org/).
47418 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
47421 example: __LINK-NAME__
47424 description: physical-link object that needs to be created or updated.
47427 $ref: "#/patchDefinitions/physical-link"
47431 summary: delete an existing physical-link
47432 description: delete an existing physical-link
47433 operationId: deleteNetworkPhysicalLinksPhysicalLink
47442 description: Response codes found in [response codes](https://wiki.onap.org/).
47446 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
47449 example: __LINK-NAME__
47450 - name: resource-version
47452 description: resource-version for concurrency
47455 /network/physical-links:
47459 summary: returns physical-links
47460 description: returns physical-links
47461 operationId: getNetworkPhysicalLinks
47467 description: successful operation
47469 $ref: "#/getDefinitions/physical-links"
47471 description: Response codes found in [response codes](https://wiki.onap.org/).
47472 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship:
47476 summary: see node definition for valid relationships
47477 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
47486 description: Response codes found in [response codes](https://wiki.onap.org/).
47488 - name: ipsec-configuration-id
47490 description: UUID of this configuration
47493 example: __IPSEC-CONFIGURATION-ID__
47496 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkIpsecConfigurationsIpsecConfiguration.json)
47499 $ref: "#/definitions/relationship"
47503 summary: delete an existing relationship
47504 description: delete an existing relationship
47505 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
47514 description: Response codes found in [response codes](https://wiki.onap.org/).
47516 - name: ipsec-configuration-id
47518 description: UUID of this configuration
47521 example: __IPSEC-CONFIGURATION-ID__
47522 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship:
47526 summary: see node definition for valid relationships
47527 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
47536 description: Response codes found in [response codes](https://wiki.onap.org/).
47538 - name: ipsec-configuration-id
47540 description: UUID of this configuration
47543 example: __IPSEC-CONFIGURATION-ID__
47544 - name: vig-address-type
47546 description: indicates whether the VIG is for AVPN or INTERNET
47549 example: __VIG-ADDRESS-TYPE__
47552 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
47555 $ref: "#/definitions/relationship"
47559 summary: delete an existing relationship
47560 description: delete an existing relationship
47561 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
47570 description: Response codes found in [response codes](https://wiki.onap.org/).
47572 - name: ipsec-configuration-id
47574 description: UUID of this configuration
47577 example: __IPSEC-CONFIGURATION-ID__
47578 - name: vig-address-type
47580 description: indicates whether the VIG is for AVPN or INTERNET
47583 example: __VIG-ADDRESS-TYPE__
47584 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}:
47588 summary: returns vig-server
47589 description: returns vig-server
47590 operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
47596 description: successful operation
47598 $ref: "#/getDefinitions/vig-server"
47600 description: Response codes found in [response codes](https://wiki.onap.org/).
47602 - name: ipsec-configuration-id
47604 description: UUID of this configuration
47607 example: __IPSEC-CONFIGURATION-ID__
47608 - name: vig-address-type
47610 description: indicates whether the VIG is for AVPN or INTERNET
47613 example: __VIG-ADDRESS-TYPE__
47617 summary: create or update an existing vig-server
47619 Create or update an existing vig-server.
47621 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
47622 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
47631 description: Response codes found in [response codes](https://wiki.onap.org/).
47633 - name: ipsec-configuration-id
47635 description: UUID of this configuration
47638 example: __IPSEC-CONFIGURATION-ID__
47639 - name: vig-address-type
47641 description: indicates whether the VIG is for AVPN or INTERNET
47644 example: __VIG-ADDRESS-TYPE__
47647 description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
47650 $ref: "#/definitions/vig-server"
47654 summary: update an existing vig-server
47656 Update an existing vig-server
47658 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47659 The PUT operation will entirely replace an existing object.
47660 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
47662 Other differences between PUT and PATCH are:
47664 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
47665 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47666 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47667 operationId: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
47676 description: Response codes found in [response codes](https://wiki.onap.org/).
47678 - name: ipsec-configuration-id
47680 description: UUID of this configuration
47683 example: __IPSEC-CONFIGURATION-ID__
47684 - name: vig-address-type
47686 description: indicates whether the VIG is for AVPN or INTERNET
47689 example: __VIG-ADDRESS-TYPE__
47692 description: vig-server object that needs to be created or updated.
47695 $ref: "#/patchDefinitions/vig-server"
47699 summary: delete an existing vig-server
47700 description: delete an existing vig-server
47701 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
47710 description: Response codes found in [response codes](https://wiki.onap.org/).
47712 - name: ipsec-configuration-id
47714 description: UUID of this configuration
47717 example: __IPSEC-CONFIGURATION-ID__
47718 - name: vig-address-type
47720 description: indicates whether the VIG is for AVPN or INTERNET
47723 example: __VIG-ADDRESS-TYPE__
47724 - name: resource-version
47726 description: resource-version for concurrency
47729 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers:
47733 summary: returns vig-servers
47734 description: returns vig-servers
47735 operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers
47741 description: successful operation
47743 $ref: "#/getDefinitions/vig-servers"
47745 description: Response codes found in [response codes](https://wiki.onap.org/).
47747 - name: ipsec-configuration-id
47749 description: UUID of this configuration
47752 example: __IPSEC-CONFIGURATION-ID__
47753 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}:
47757 summary: returns ipsec-configuration
47758 description: returns ipsec-configuration
47759 operationId: getNetworkIpsecConfigurationsIpsecConfiguration
47765 description: successful operation
47767 $ref: "#/getDefinitions/ipsec-configuration"
47769 description: Response codes found in [response codes](https://wiki.onap.org/).
47771 - name: ipsec-configuration-id
47773 description: UUID of this configuration
47776 example: __IPSEC-CONFIGURATION-ID__
47780 summary: create or update an existing ipsec-configuration
47782 Create or update an existing ipsec-configuration.
47784 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
47785 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration
47794 description: Response codes found in [response codes](https://wiki.onap.org/).
47796 - name: ipsec-configuration-id
47798 description: UUID of this configuration
47801 example: __IPSEC-CONFIGURATION-ID__
47804 description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkIpsecConfigurationsIpsecConfiguration.json)
47807 $ref: "#/definitions/ipsec-configuration"
47811 summary: update an existing ipsec-configuration
47813 Update an existing ipsec-configuration
47815 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47816 The PUT operation will entirely replace an existing object.
47817 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
47819 Other differences between PUT and PATCH are:
47821 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
47822 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47823 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47824 operationId: UpdateNetworkIpsecConfigurationsIpsecConfiguration
47833 description: Response codes found in [response codes](https://wiki.onap.org/).
47835 - name: ipsec-configuration-id
47837 description: UUID of this configuration
47840 example: __IPSEC-CONFIGURATION-ID__
47843 description: ipsec-configuration object that needs to be created or updated.
47846 $ref: "#/patchDefinitions/ipsec-configuration"
47850 summary: delete an existing ipsec-configuration
47851 description: delete an existing ipsec-configuration
47852 operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration
47861 description: Response codes found in [response codes](https://wiki.onap.org/).
47863 - name: ipsec-configuration-id
47865 description: UUID of this configuration
47868 example: __IPSEC-CONFIGURATION-ID__
47869 - name: resource-version
47871 description: resource-version for concurrency
47874 /network/ipsec-configurations:
47878 summary: returns ipsec-configurations
47879 description: returns ipsec-configurations
47880 operationId: getNetworkIpsecConfigurations
47886 description: successful operation
47888 $ref: "#/getDefinitions/ipsec-configurations"
47890 description: Response codes found in [response codes](https://wiki.onap.org/).
47891 /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship:
47895 summary: see node definition for valid relationships
47896 operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
47905 description: Response codes found in [response codes](https://wiki.onap.org/).
47907 - name: route-table-reference-id
47909 description: Route Table Reference id, UUID assigned to this instance.
47912 example: __ROUTE-TABLE-REFERENCE-ID__
47915 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkRouteTableReferencesRouteTableReference.json)
47918 $ref: "#/definitions/relationship"
47922 summary: delete an existing relationship
47923 description: delete an existing relationship
47924 operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
47933 description: Response codes found in [response codes](https://wiki.onap.org/).
47935 - name: route-table-reference-id
47937 description: Route Table Reference id, UUID assigned to this instance.
47940 example: __ROUTE-TABLE-REFERENCE-ID__
47941 /network/route-table-references/route-table-reference/{route-table-reference-id}:
47945 summary: returns route-table-reference
47946 description: returns route-table-reference
47947 operationId: getNetworkRouteTableReferencesRouteTableReference
47953 description: successful operation
47955 $ref: "#/getDefinitions/route-table-reference"
47957 description: Response codes found in [response codes](https://wiki.onap.org/).
47959 - name: route-table-reference-id
47961 description: Route Table Reference id, UUID assigned to this instance.
47964 example: __ROUTE-TABLE-REFERENCE-ID__
47965 - name: route-table-reference-fqdn
47967 description: FQDN entry in the route table.
47973 summary: create or update an existing route-table-reference
47975 Create or update an existing route-table-reference.
47977 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
47978 operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference
47987 description: Response codes found in [response codes](https://wiki.onap.org/).
47989 - name: route-table-reference-id
47991 description: Route Table Reference id, UUID assigned to this instance.
47994 example: __ROUTE-TABLE-REFERENCE-ID__
47997 description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkRouteTableReferencesRouteTableReference.json)
48000 $ref: "#/definitions/route-table-reference"
48004 summary: update an existing route-table-reference
48006 Update an existing route-table-reference
48008 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
48009 The PUT operation will entirely replace an existing object.
48010 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
48012 Other differences between PUT and PATCH are:
48014 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
48015 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
48016 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
48017 operationId: UpdateNetworkRouteTableReferencesRouteTableReference
48026 description: Response codes found in [response codes](https://wiki.onap.org/).
48028 - name: route-table-reference-id
48030 description: Route Table Reference id, UUID assigned to this instance.
48033 example: __ROUTE-TABLE-REFERENCE-ID__
48036 description: route-table-reference object that needs to be created or updated.
48039 $ref: "#/patchDefinitions/route-table-reference"
48043 summary: delete an existing route-table-reference
48044 description: delete an existing route-table-reference
48045 operationId: deleteNetworkRouteTableReferencesRouteTableReference
48054 description: Response codes found in [response codes](https://wiki.onap.org/).
48056 - name: route-table-reference-id
48058 description: Route Table Reference id, UUID assigned to this instance.
48061 example: __ROUTE-TABLE-REFERENCE-ID__
48062 - name: resource-version
48064 description: resource-version for concurrency
48067 /network/route-table-references:
48071 summary: returns route-table-references
48072 description: returns route-table-references
48073 operationId: getNetworkRouteTableReferences
48079 description: successful operation
48081 $ref: "#/getDefinitions/route-table-references"
48083 description: Response codes found in [response codes](https://wiki.onap.org/).
48084 /network/instance-groups/instance-group/{id}/relationship-list/relationship:
48088 summary: see node definition for valid relationships
48089 operationId: createOrUpdateNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
48098 description: Response codes found in [response codes](https://wiki.onap.org/).
48102 description: Instance Group ID, UUID assigned to this instance.
48108 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkInstanceGroupsInstanceGroup.json)
48111 $ref: "#/definitions/relationship"
48115 summary: delete an existing relationship
48116 description: delete an existing relationship
48117 operationId: deleteNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
48126 description: Response codes found in [response codes](https://wiki.onap.org/).
48130 description: Instance Group ID, UUID assigned to this instance.
48134 /network/instance-groups/instance-group/{id}:
48138 summary: returns instance-group
48139 description: returns instance-group
48140 operationId: getNetworkInstanceGroupsInstanceGroup
48146 description: successful operation
48148 $ref: "#/getDefinitions/instance-group"
48150 description: Response codes found in [response codes](https://wiki.onap.org/).
48154 description: Instance Group ID, UUID assigned to this instance.
48158 - name: description
48160 description: Descriptive text to help identify the usage of this instance-group
48165 description: Only valid value today is lower case ha for high availability
48170 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
48176 summary: create or update an existing instance-group
48178 Create or update an existing instance-group.
48180 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
48181 operationId: createOrUpdateNetworkInstanceGroupsInstanceGroup
48190 description: Response codes found in [response codes](https://wiki.onap.org/).
48194 description: Instance Group ID, UUID assigned to this instance.
48200 description: instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkInstanceGroupsInstanceGroup.json)
48203 $ref: "#/definitions/instance-group"
48207 summary: update an existing instance-group
48209 Update an existing instance-group
48211 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
48212 The PUT operation will entirely replace an existing object.
48213 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
48215 Other differences between PUT and PATCH are:
48217 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
48218 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
48219 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
48220 operationId: UpdateNetworkInstanceGroupsInstanceGroup
48229 description: Response codes found in [response codes](https://wiki.onap.org/).
48233 description: Instance Group ID, UUID assigned to this instance.
48239 description: instance-group object that needs to be created or updated.
48242 $ref: "#/patchDefinitions/instance-group"
48246 summary: delete an existing instance-group
48247 description: delete an existing instance-group
48248 operationId: deleteNetworkInstanceGroupsInstanceGroup
48257 description: Response codes found in [response codes](https://wiki.onap.org/).
48261 description: Instance Group ID, UUID assigned to this instance.
48265 - name: resource-version
48267 description: resource-version for concurrency
48270 /network/instance-groups:
48274 summary: returns instance-groups
48275 description: returns instance-groups
48276 operationId: getNetworkInstanceGroups
48282 description: successful operation
48284 $ref: "#/getDefinitions/instance-groups"
48286 description: Response codes found in [response codes](https://wiki.onap.org/).
48287 /network/zones/zone/{zone-id}/relationship-list/relationship:
48291 summary: see node definition for valid relationships
48292 operationId: createOrUpdateNetworkZonesZoneRelationshipListRelationship
48301 description: Response codes found in [response codes](https://wiki.onap.org/).
48305 description: Code assigned by AIC to the zone
48308 example: __ZONE-ID__
48311 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkZonesZone.json)
48314 $ref: "#/definitions/relationship"
48318 summary: delete an existing relationship
48319 description: delete an existing relationship
48320 operationId: deleteNetworkZonesZoneRelationshipListRelationship
48329 description: Response codes found in [response codes](https://wiki.onap.org/).
48333 description: Code assigned by AIC to the zone
48336 example: __ZONE-ID__
48337 /network/zones/zone/{zone-id}:
48341 summary: returns zone
48342 description: returns zone
48343 operationId: getNetworkZonesZone
48349 description: successful operation
48351 $ref: "#/getDefinitions/zone"
48353 description: Response codes found in [response codes](https://wiki.onap.org/).
48357 description: Code assigned by AIC to the zone
48360 example: __ZONE-ID__
48361 - name: design-type
48363 description: Design of zone [Medium/Large?]
48366 - name: zone-context
48368 description: Context of zone [production/test]
48374 summary: create or update an existing zone
48376 Create or update an existing zone.
48378 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
48379 operationId: createOrUpdateNetworkZonesZone
48388 description: Response codes found in [response codes](https://wiki.onap.org/).
48392 description: Code assigned by AIC to the zone
48395 example: __ZONE-ID__
48398 description: zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkZonesZone.json)
48401 $ref: "#/definitions/zone"
48405 summary: update an existing zone
48407 Update an existing zone
48409 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
48410 The PUT operation will entirely replace an existing object.
48411 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
48413 Other differences between PUT and PATCH are:
48415 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
48416 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
48417 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
48418 operationId: UpdateNetworkZonesZone
48427 description: Response codes found in [response codes](https://wiki.onap.org/).
48431 description: Code assigned by AIC to the zone
48434 example: __ZONE-ID__
48437 description: zone object that needs to be created or updated.
48440 $ref: "#/patchDefinitions/zone"
48444 summary: delete an existing zone
48445 description: delete an existing zone
48446 operationId: deleteNetworkZonesZone
48455 description: Response codes found in [response codes](https://wiki.onap.org/).
48459 description: Code assigned by AIC to the zone
48462 example: __ZONE-ID__
48463 - name: resource-version
48465 description: resource-version for concurrency
48472 summary: returns zones
48473 description: returns zones
48474 operationId: getNetworkZones
48480 description: successful operation
48482 $ref: "#/getDefinitions/zones"
48484 description: Response codes found in [response codes](https://wiki.onap.org/).
48499 $ref: "#/definitions/action-data"
48508 APIs that are more action related than REST (e.g., notify, update).
48512 $ref: "#/definitions/update"
48515 $ref: "#/definitions/notify"
48518 Represents a slice or partial piece of a resource that gets separately allotted
48519 ###### Related Nodes
48520 - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
48521 - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
48522 - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
48523 - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
48524 - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
48525 - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
48526 - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
48527 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
48528 - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
48534 description: Allotted Resource id UUID assigned to this instance.
48537 description: The descriptive information assigned to this allotted resource instance
48540 description: Link back to more information in the controller
48541 model-invariant-id:
48543 description: the ASDC model id for this resource or service model.
48546 description: the ASDC model version for this resource or service model.
48547 persona-model-version:
48549 description: the ASDC model version for this resource or service model.
48552 description: Concurrency value
48553 orchestration-status:
48555 description: Orchestration status
48556 operational-status:
48558 description: Indicator for whether the resource is considered operational
48561 description: Generic description of the type of allotted resource.
48564 description: role in the network that this resource will be providing.
48568 $ref: "#/definitions/tunnel-xconnect"
48572 $ref: "#/definitions/relationship"
48573 allotted-resources:
48575 This object is used to store slices of services being offered
48580 $ref: "#/definitions/allotted-resource"
48583 Availability zone, a collection of compute hosts/pservers
48584 ###### Related Nodes
48585 - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48586 - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
48587 - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48588 - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
48589 - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
48590 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
48591 - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
48592 - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
48593 - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
48595 - availability-zone-name
48598 availability-zone-name:
48600 description: Name of the availability zone. Unique across a cloud region
48603 description: Type of hypervisor. Source of truth should define valid values.
48604 operational-status:
48606 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
48609 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48613 $ref: "#/definitions/relationship"
48614 availability-zones:
48616 Collection of availability zones
48621 $ref: "#/definitions/availability-zone"
48622 az-and-dvs-switches:
48626 $ref: "#/definitions/dvs-switches"
48629 $ref: "#/definitions/availability-zone"
48632 Namespace for business related constructs
48637 $ref: "#/definitions/connector"
48641 $ref: "#/definitions/customer"
48644 ###### Related Nodes
48645 - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
48651 description: unique identifier of probe
48654 description: identifier of probe
48657 description: type of probe
48660 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48664 $ref: "#/definitions/relationship"
48665 classes-of-service:
48667 class-of-service of probe
48672 $ref: "#/definitions/class-of-service"
48673 cloud-infrastructure:
48675 Namespace for cloud infrastructure.
48680 $ref: "#/definitions/complex"
48684 $ref: "#/definitions/cloud-region"
48688 $ref: "#/definitions/network-profile"
48692 $ref: "#/definitions/pserver"
48693 virtual-data-centers:
48696 $ref: "#/definitions/virtual-data-center"
48699 cloud-region designates an installation of a cloud cluster or region or instantiation
48700 ###### Related Nodes
48701 - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48702 - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
48703 - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
48704 - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48705 - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48706 - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48707 - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48708 - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48709 - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48710 - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48711 - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48712 - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48713 - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
48714 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
48715 - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
48716 - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
48723 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
48726 description: Identifier used by the vendor for the region. Second part of composite key
48729 description: Type of the cloud (e.g., openstack)
48730 owner-defined-type:
48732 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
48733 cloud-region-version:
48735 description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
48738 description: URL of the keystone identity service
48741 description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
48744 description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
48747 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48751 $ref: "#/definitions/volume-group"
48755 $ref: "#/definitions/tenant"
48759 $ref: "#/definitions/flavor"
48763 $ref: "#/definitions/group-assignment"
48767 $ref: "#/definitions/snapshot"
48771 $ref: "#/definitions/image"
48775 $ref: "#/definitions/dvs-switch"
48779 $ref: "#/definitions/oam-network"
48780 availability-zones:
48783 $ref: "#/definitions/availability-zone"
48787 $ref: "#/definitions/relationship"
48793 $ref: "#/definitions/cloud-region"
48796 Collection of physical locations that can house cloud-regions.
48797 ###### Related Nodes
48798 - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
48799 - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48800 - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48801 - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
48802 - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
48803 - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48804 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48805 - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
48806 - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48807 - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48808 - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48809 - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
48810 - COMPLEX is DELETED when these are DELETED CTAG-POOL
48812 - physical-location-id
48813 - physical-location-type
48820 physical-location-id:
48822 description: Unique identifier for physical location, e.g., CLLI
48825 description: Data center code which can be an alternate way to identify a complex
48828 description: Gamma complex name for LCP instance.
48831 description: URL of the keystone identity service
48834 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48835 physical-location-type:
48837 description: Type, e.g., central office, data center.
48863 $ref: "#/definitions/ctag-pool"
48867 $ref: "#/definitions/relationship"
48870 Collection of physical locations that can house cloud-regions.
48875 $ref: "#/definitions/complex"
48878 Port Mirror Configuration.
48879 ###### Related Nodes
48880 - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
48881 - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
48882 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
48883 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
48884 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
48885 - CONFIGURATION is DELETED when these are DELETED METADATUM
48886 - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
48889 - configuration-type
48890 - configuration-sub-type
48891 - orchestration-status
48892 - operational-status
48893 - configuration-selflink
48894 - model-customization-id
48898 description: UUID assigned to configuration.
48901 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
48902 configuration-name:
48904 description: Name of the configuration.
48905 configuration-type:
48907 description: port-mirroring-configuration.
48908 configuration-sub-type:
48910 description: vprobe, pprobe.
48911 model-invariant-id:
48913 description: the ASDC model id for this resource or service model.
48916 description: the ASDC model version for this resource or service model.
48917 orchestration-status:
48919 description: Orchestration status of the configuration.
48920 operational-status:
48922 description: Indicator for whether the resource is considered operational.
48923 configuration-selflink:
48925 description: URL to endpoint where AAI can get more details from SDN-GC.
48926 model-customization-id:
48928 description: id of the configuration used to customize the resource
48931 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48935 $ref: "#/definitions/relationship"
48939 $ref: "#/definitions/metadatum"
48942 Collection of configurations
48947 $ref: "#/definitions/configuration"
48950 Collection of resource instances used to connect a variety of disparate inventory widgets
48951 ###### Related Nodes
48952 - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
48953 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
48954 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
48955 - CONNECTOR is DELETED when these are DELETED METADATUM
48957 - resource-instance-id
48959 resource-instance-id:
48961 description: Unique id of resource instance.
48964 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48965 model-invariant-id:
48967 description: the ASDC model id for this resource or service model.
48970 description: the ASDC model version for this resource or service model.
48971 persona-model-version:
48973 description: the ASDC model version for this resource or service model.
48976 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
48977 widget-model-version:
48979 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
48983 $ref: "#/definitions/relationship"
48987 $ref: "#/definitions/metadatum"
48990 Collection of resource instances used to connect a variety of disparate inventory widgets
48995 $ref: "#/definitions/connector"
48996 constrained-element-set:
48998 This is how we would capture constraints defining allowed sets of elements.
48999 ###### Related Nodes
49000 - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
49001 - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
49002 - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
49003 - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
49005 - constrained-element-set-uuid
49009 constrained-element-set-uuid:
49017 element-choice-sets:
49020 $ref: "#/definitions/element-choice-set"
49024 $ref: "#/definitions/relationship"
49025 constrained-element-sets:
49027 constrained-element-set:
49030 $ref: "#/definitions/constrained-element-set"
49033 ###### Related Nodes
49034 - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
49035 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
49045 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49049 $ref: "#/definitions/relationship"
49055 $ref: "#/definitions/ctag-assignment"
49058 A collection of C tags (vlan tags) grouped for a specific purpose.
49059 ###### Related Nodes
49060 - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
49061 - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
49062 - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
49065 - availability-zone-name
49066 - ctag-pool-purpose
49070 description: The Target provider edge router
49071 availability-zone-name:
49073 description: Name of the availability zone
49076 description: Describes what the intended purpose of this pool is.
49079 description: Comma separated list of ctags
49082 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49086 $ref: "#/definitions/relationship"
49092 $ref: "#/definitions/ctag-pool"
49095 customer identifiers to provide linkage back to BSS information.
49096 ###### Related Nodes
49097 - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
49098 - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
49100 - global-customer-id
49104 global-customer-id:
49106 description: Global customer id used across ECOMP to uniquely identify customer.
49109 description: Subscriber name, an alternate way to retrieve a customer.
49112 description: Subscriber type, a way to provide VID with only the INFRA customers.
49115 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49116 service-subscriptions:
49119 $ref: "#/definitions/service-subscription"
49123 $ref: "#/definitions/relationship"
49126 Collection of customer identifiers to provide linkage back to BSS information.
49131 $ref: "#/definitions/customer"
49139 description: See mis-na-virtualization-platform.yang
49142 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49146 $ref: "#/definitions/relationship"
49152 $ref: "#/definitions/cvlan-tag-entry"
49155 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.
49156 ###### Related Nodes
49157 - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
49158 - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
49165 description: DVS switch name
49168 description: URL used to reach the vcenter
49171 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49175 $ref: "#/definitions/relationship"
49178 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
49183 $ref: "#/definitions/dvs-switch"
49186 Internal map to define the properties of an edge and interpret the map EdgeRules
49204 edge-tag-query-request:
49215 $ref: "#/definitions/start-node-filter"
49216 include-node-filter:
49219 $ref: "#/definitions/include-node-filter"
49223 $ref: "#/definitions/secondary-filter"
49224 edge-tag-query-result:
49226 tagged-inventory-item-list:
49229 $ref: "#/definitions/tagged-inventory-item-list"
49230 element-choice-set:
49232 This is how we would capture constraints defining allowed sets of elements.
49233 ###### Related Nodes
49234 - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
49235 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
49236 - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
49238 - element-choice-set-uuid
49239 - element-choice-set-name
49241 element-choice-set-uuid:
49243 element-choice-set-name:
49252 $ref: "#/definitions/model-element"
49256 $ref: "#/definitions/relationship"
49257 element-choice-sets:
49259 element-choice-set:
49262 $ref: "#/definitions/element-choice-set"
49265 Metadata for entitlement group.
49266 ###### Related Nodes
49267 - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49268 - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
49275 description: Unique ID for the entitlement group the resource comes from, should be uuid.
49278 description: Unique ID of an entitlement resource.
49281 description: Concurrency value
49285 $ref: "#/definitions/relationship"
49288 Entitlements, keyed by group-uuid and resource-uuid, related to license management
49293 $ref: "#/definitions/entitlement"
49296 Persist EMS address information used by EMS driver.
49297 ###### Related Nodes
49298 - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
49299 - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
49305 description: Unique ID of EMS.
49308 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49309 esr-system-info-list:
49311 $ref: "#/definitions/esr-system-info-list"
49314 $ref: "#/definitions/relationship-list"
49320 $ref: "#/definitions/esr-ems"
49323 Persist common address information of external systems.
49324 ###### Related Nodes
49325 - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
49326 - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
49327 - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
49328 - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
49330 - esr-system-info-id
49335 esr-system-info-id:
49337 description: Unique ID of esr system info.
49340 description: name of external system.
49343 description: type of external systems.
49346 description: vendor of external systems.
49349 description: version of external systems.
49352 description: url used to access external systems.
49355 description: username used to access external systems.
49358 description: password used to access external systems.
49361 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
49364 description: protocol of third party SDNC, for example netconf/snmp.
49367 description: ca file content if enabled ssl on auth-url.
49370 description: Whether to verify VIM's certificate.
49373 description: service IP of ftp server.
49376 description: service port of ftp server.
49379 description: domain info for authentication.
49382 description: default tenant of VIM.
49385 description: ftp passive mode or not.
49388 description: resource or performance data file path.
49391 description: the status of external system.
49394 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49398 $ref: "#/definitions/relationship"
49399 esr-system-info-list:
49401 Collection of persistent block-level external system auth info.
49406 $ref: "#/definitions/esr-system-info"
49407 esr-thirdparty-sdnc:
49409 Persist SDNC address information used by ONAP SDNC.
49410 ###### Related Nodes
49411 - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
49412 - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
49413 - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
49415 - thirdparty-sdnc-id
49417 thirdparty-sdnc-id:
49419 description: Unique ID of SDNC.
49422 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
49425 description: password used to access SDNC server.
49428 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49429 esr-system-info-list:
49431 $ref: "#/definitions/esr-system-info-list"
49434 $ref: "#/definitions/relationship-list"
49435 esr-thirdparty-sdnc-list:
49437 esr-thirdparty-sdnc:
49440 $ref: "#/definitions/esr-thirdparty-sdnc"
49443 Persist VNFM address information used by VF-C.
49444 ###### Related Nodes
49445 - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
49446 - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
49452 description: Unique ID of VNFM.
49455 description: indecate the VIM to deploy VNF.
49458 description: certificate url of VNFM.
49461 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49462 esr-system-info-list:
49464 $ref: "#/definitions/esr-system-info-list"
49467 $ref: "#/definitions/relationship-list"
49473 $ref: "#/definitions/esr-vnfm"
49476 evc object is an optional child object of the Configuration object.
49477 ###### Related Nodes
49478 - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
49484 description: Unique/key field for the evc object
49485 forwarding-path-topology:
49487 description: Point-to-Point, Multi-Point
49490 description: Commited Information Rate
49493 description: CIR units
49494 connection-diversity-group-id:
49496 description: Diversity Group ID
49499 description: formerly Performance Group
49500 esp-evc-circuit-id:
49502 description: EVC Circuit ID of ESP EVC
49505 description: Committed Information Rate (For ESP)
49508 description: CIR units (For ESP)
49511 description: Identifies ESP
49512 collector-pop-clli:
49514 description: Collector POP CLLI (from the hostname of the access pnf)
49515 inter-connect-type-ingress:
49517 description: Interconnect type on ingress side of EVC.
49518 tagmode-access-ingress:
49520 description: tagode for collector side of EVC
49521 tagmode-access-egress:
49523 description: tagMode for network side of EVC
49527 $ref: "#/definitions/relationship"
49530 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49536 $ref: "#/definitions/evc"
49539 Namespace for external system.
49543 $ref: "#/definitions/esr-ems-list"
49546 $ref: "#/definitions/esr-vnfm-list"
49547 esr-thirdparty-sdnc-list:
49549 $ref: "#/definitions/esr-thirdparty-sdnc-list"
49552 Extra properties for inventory item for response list
49557 $ref: "#/definitions/extra-property"
49567 ###### Related Nodes
49568 - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
49569 - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
49570 - FLAVOR cannot be deleted if linked to VSERVER
49578 description: Flavor id, expected to be unique across cloud-region.
49581 description: Flavor name
49585 description: Number of CPUs
49589 description: Amount of memory
49593 description: Disk space
49597 description: Amount of ephemeral disk space
49600 description: amount of swap space allocation
49603 description: whether flavor is available to all users or private to the tenant it was created in.
49606 description: URL to endpoint where AAI can get more details
49609 description: Boolean as to whether this flavor is no longer enabled
49612 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49616 $ref: "#/definitions/relationship"
49619 Collection of openstack flavors.
49624 $ref: "#/definitions/flavor"
49627 Entity describing a sequenced segment of forwarding path
49628 ###### Related Nodes
49629 - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
49630 - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
49631 - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
49632 - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
49633 - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
49634 - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
49641 description: Unique ID of this segmentation
49644 description: ingress, intermediate, egress
49648 $ref: "#/definitions/relationship"
49651 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49654 forwarder object is an optional child object of the Configuration object.
49655 ###### Related Nodes
49656 - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
49662 description: Key for forwarder-evc object
49665 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
49668 description: Internal VLAN.
49671 description: SVLAN value for ingress of egress forwarder.
49674 description: CVLAN value for ingress of egress forwarder.
49678 $ref: "#/definitions/relationship"
49681 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49687 $ref: "#/definitions/forwarder-evc"
49693 $ref: "#/definitions/forwarder"
49696 Entity that describes the sequenced forwarding path between interfaces of services or resources
49697 ###### Related Nodes
49698 - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
49699 - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
49700 - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
49701 - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
49702 - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
49704 - forwarding-path-id
49705 - forwarding-path-name
49707 forwarding-path-id:
49709 description: Unique ID of this FP
49710 forwarding-path-name:
49712 description: Name of the FP
49716 $ref: "#/definitions/relationship"
49719 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49722 description: the self link for this FP
49726 $ref: "#/definitions/forwarder"
49732 $ref: "#/definitions/forwarding-path"
49735 General purpose VNF
49736 ###### Related Nodes
49737 - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
49738 - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
49739 - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
49740 - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
49741 - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
49742 - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
49743 - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
49744 - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
49745 - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
49746 - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
49747 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
49748 - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49749 - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49750 - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49751 - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49752 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49753 - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
49754 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
49755 - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
49756 - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49757 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
49758 - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
49764 - is-closed-loop-disabled
49768 description: Unique id of VNF. This is unique across the graph.
49771 description: Name of VNF.
49774 description: Alternate name of VNF.
49777 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.
49780 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
49781 regional-resource-zone:
49783 description: Regional way of organizing pservers, source of truth should define values
49786 description: Trigger for operational monitoring of this resource by Service Assurance systems.
49787 operational-status:
49789 description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
49792 description: OBSOLETE - do not use
49795 description: Client should send valid enumerated value
49796 orchestration-status:
49798 description: Orchestration status of this VNF, used by MSO.
49801 description: Heat stack id corresponding to this instance, managed by MSO
49804 description: Corresponds to the SDN-C catalog id used to configure this VCE
49807 description: identifier of managed by company or customer
49810 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
49811 ipv4-loopback0-address:
49813 description: v4 Loopback0 address
49816 description: v6 Loopback address
49817 management-v6-address:
49819 description: v6 management address
49823 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
49826 description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only in some usecases
49830 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
49833 description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only in some usecases
49837 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
49840 description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases
49843 is-closed-loop-disabled:
49847 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49850 description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
49851 encrypted-access-flag:
49853 description: indicates whether generic-vnf access uses SSH
49854 entitlement-assignment-group-uuid:
49856 description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships.
49857 entitlement-resource-uuid:
49859 description: UUID of the specific entitlement resource. OBSOLETE - See child relationships.
49860 license-assignment-group-uuid:
49862 description: UUID of the license assignment group. OBSOLETE - See child relationships.
49865 description: UUID of the actual license resource. OBSOLETE - See child relationships.
49866 model-invariant-id:
49868 description: the ASDC model id for this resource or service model.
49871 description: the ASDC model version for this resource or service model.
49872 persona-model-version:
49874 description: the ASDC model version for this resource or service model.
49875 model-customization-id:
49877 description: captures the id of all the configuration used to customize the resource for the service.
49880 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
49881 widget-model-version:
49883 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
49886 description: as-number of the VNF
49887 regional-resource-subzone:
49889 description: represents sub zone of the rr plane
49892 description: Generic description of the type of NF
49895 description: English description of Network function that the specific VNF deployment is providing
49898 description: role in the network that this model will be providing
49901 description: string assigned to this model used for naming purposes
49904 description: Path to the controller object.
49908 $ref: "#/definitions/relationship"
49912 $ref: "#/definitions/l-interface"
49916 $ref: "#/definitions/lag-interface"
49920 $ref: "#/definitions/vf-module"
49924 $ref: "#/definitions/license"
49928 $ref: "#/definitions/entitlement"
49936 $ref: "#/definitions/generic-vnf"
49939 Openstack group-assignment used to store exclusivity groups (EG).
49940 ###### Related Nodes
49941 - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
49942 - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
49943 - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
49951 description: Group id, expected to be unique across cloud-region.
49954 description: Group type - the type of group this instance refers to
49957 description: Group name - name assigned to the group
49960 description: Group description - description of the group
49963 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49967 $ref: "#/definitions/relationship"
49970 Collection of openstack group assignments
49975 $ref: "#/definitions/group-assignment"
49978 ###### Related Nodes
49979 - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
49987 description: host-route id
49990 description: subnet prefix
49993 description: Could be ip-address, hostname, or service-instance
49996 description: Should be ip-address, hostname, or service-instance to match next-hop
49999 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50003 $ref: "#/definitions/relationship"
50009 $ref: "#/definitions/host-route"
50012 Collection of HPA Capabilities
50017 $ref: "#/definitions/hpa-capability"
50020 Represents a HPA capability
50021 ###### Related Nodes
50022 - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
50023 - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
50024 - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
50025 - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES
50027 - hpa-capability-id
50032 description: UUID to uniquely identify a HPA capability
50035 description: Name of the HPACapability
50038 description: HPA schema version
50041 description: Hardware architecture
50044 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50048 $ref: "#/definitions/relationship"
50049 hpa-feature-attributes:
50052 $ref: "#/definitions/hpa-feature-attributes"
50053 hpa-feature-attributes:
50055 HPA Capability Feature attributes
50056 ###### Related Nodes
50057 - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
50061 description: name of the specific HPA attribute
50064 description: JSON string specifying the value, unit and type of the specific HPA attribute
50067 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50071 $ref: "#/definitions/relationship"
50075 ###### Related Nodes
50076 - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
50077 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
50078 - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
50079 - IMAGE cannot be deleted if linked to VSERVER
50080 - IMAGE is DELETED when these are DELETED METADATUM
50090 description: Image id, expected to be unique across cloud region
50093 description: Image name
50094 image-architecture:
50096 description: Operating system architecture.
50099 description: The common name of the operating system distribution in lowercase
50102 description: The operating system version as specified by the distributor.
50105 description: The application that the image instantiates.
50106 application-vendor:
50108 description: The vendor of the application.
50109 application-version:
50111 description: The version of the application.
50114 description: URL to endpoint where AAI can get more details
50117 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50121 $ref: "#/definitions/relationship"
50125 $ref: "#/definitions/metadatum"
50128 Collectio of Openstack images.
50133 $ref: "#/definitions/image"
50134 include-node-filter:
50140 InstanceFilter for performing a named-query or model query
50143 InstanceFilters for performing a named-query or model query
50148 $ref: "#/definitions/instance-filter"
50151 General mechanism for grouping instances
50152 ###### Related Nodes
50153 - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
50154 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
50155 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
50156 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
50157 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
50158 - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
50159 - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
50160 - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
50168 description: Instance Group ID, UUID assigned to this instance.
50171 description: Descriptive text to help identify the usage of this instance-group
50174 description: Only valid value today is lower case ha for high availability
50177 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
50180 description: Concurrency value
50184 $ref: "#/definitions/relationship"
50187 Collection of openstack route table references
50192 $ref: "#/definitions/instance-group"
50197 $ref: "#/definitions/search"
50200 $ref: "#/definitions/actions"
50201 cloud-infrastructure:
50203 $ref: "#/definitions/cloud-infrastructure"
50206 $ref: "#/definitions/business"
50207 service-design-and-creation:
50209 $ref: "#/definitions/service-design-and-creation"
50212 $ref: "#/definitions/network"
50215 $ref: "#/definitions/aai-internal"
50219 $ref: "#/definitions/aai-internal"
50222 inventory-item-type:
50224 inventory-item-link:
50226 inventory-item-data:
50229 $ref: "#/definitions/inventory-item-data"
50230 tagged-inventory-item-list:
50233 $ref: "#/definitions/tagged-inventory-item-list"
50234 inventory-item-data:
50240 inventory-response-item:
50242 Inventory item for response list
50248 $ref: "#/definitions/extra-properties"
50249 inventory-response-items:
50251 $ref: "#/definitions/inventory-response-items"
50252 inventory-response-items:
50254 Container for inventory items in response list
50256 inventory-response-item:
50259 $ref: "#/definitions/inventory-response-item"
50260 ipsec-configuration:
50262 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
50263 ###### Related Nodes
50264 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
50265 - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
50266 - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
50268 - ipsec-configuration-id
50270 ipsec-configuration-id:
50272 description: UUID of this configuration
50273 requested-vig-address-type:
50275 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
50276 requested-encryption-strength:
50278 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
50279 requested-dmz-type:
50281 description: can offer a shared DMZ or a DMZ specific to a customer
50282 shared-dmz-network-address:
50284 description: Network address of shared DMZ
50285 requested-customer-name:
50287 description: If the DMZ is a custom DMZ, this field will indicate the customer information
50290 description: can be 1 or 2
50291 ikev1-authentication:
50293 description: Contains values like md5, sha1, sha256, sha384
50296 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
50299 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
50302 description: Group name defined in VIG for clients using aggressive mode
50305 description: pre-shared key for the above group name
50308 description: Lifetime for IKEv1 SA
50309 ipsec-authentication:
50311 description: md5, sha1, sha256, sha384
50314 description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
50317 description: Life time for IPSec SA
50320 description: enable PFS or not
50323 description: user ID for xAuth, sm-user, ,nmteHostName
50324 xauth-user-password:
50326 description: Encrypted using the Juniper $9$ algorithm
50329 description: The time between DPD probe
50332 description: Maximum number of DPD before claiming the tunnel is down
50335 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50339 $ref: "#/definitions/relationship"
50343 $ref: "#/definitions/vig-server"
50344 ipsec-configurations:
50346 ipsec-configuration:
50349 $ref: "#/definitions/ipsec-configuration"
50358 Logical interfaces, e.g., a vnic.
50359 ###### Related Nodes
50360 - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
50361 - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
50362 - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
50363 - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
50364 - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
50365 - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
50366 - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
50367 - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
50368 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
50369 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
50370 - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
50371 - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
50372 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
50373 - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
50374 - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
50382 description: Name given to the interface
50385 description: E.g., CUSTOMER, UPLINK, etc.
50388 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
50391 description: URL to endpoint where AAI can get more details
50394 description: ID of interface
50397 description: MAC address for the interface
50400 description: Name of the network
50403 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
50404 interface-description:
50406 description: Human friendly text regarding this interface.
50411 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50417 $ref: "#/definitions/vlan"
50421 $ref: "#/definitions/sriov-vf"
50425 $ref: "#/definitions/l-interface"
50429 $ref: "#/definitions/relationship"
50430 l3-interface-ipv4-address-list:
50433 $ref: "#/definitions/l3-interface-ipv4-address-list"
50434 l3-interface-ipv6-address-list:
50437 $ref: "#/definitions/l3-interface-ipv6-address-list"
50440 Collection of logical interfaces.
50445 $ref: "#/definitions/l-interface"
50446 l3-interface-ipv4-address-list:
50449 ###### Related Nodes
50450 - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
50451 - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
50452 - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
50453 - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
50454 - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
50456 - l3-interface-ipv4-address
50458 l3-interface-ipv4-address:
50460 description: IP address
50461 l3-interface-ipv4-prefix-length:
50464 description: Prefix length, 32 for single address
50468 description: Inner VLAN tag
50472 description: Outer VLAN tag
50475 description: Indicator of fixed or floating address
50478 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50479 neutron-network-id:
50481 description: Neutron network id of the interface that address belongs to
50484 description: Neutron id of subnet that address belongs to
50488 $ref: "#/definitions/relationship"
50489 l3-interface-ipv6-address-list:
50492 ###### Related Nodes
50493 - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
50494 - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
50495 - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
50496 - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
50497 - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
50499 - l3-interface-ipv6-address
50501 l3-interface-ipv6-address:
50503 description: IP address
50504 l3-interface-ipv6-prefix-length:
50507 description: Prefix length, 128 for single address
50511 description: Inner VLAN tag
50515 description: Outer VLAN tag
50518 description: Indicator of fixed or floating address
50521 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50522 neutron-network-id:
50524 description: Neutron network id of the interface that address belongs to
50527 description: Neutron id of subnet that address belongs to
50531 $ref: "#/definitions/relationship"
50534 Generic network definition
50535 ###### Related Nodes
50536 - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
50537 - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
50538 - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
50539 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
50540 - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
50541 - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
50542 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
50543 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
50544 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
50545 - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
50546 - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
50547 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
50548 - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
50549 - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
50550 - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
50551 - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
50556 - is-provider-network
50557 - is-shared-network
50558 - is-external-network
50562 description: Network ID, should be uuid. Unique across A&AI.
50565 description: Name of the network, governed by some naming convention..
50568 description: Type of the network - who defines these values?
50571 description: Role the network plans - who defines these values?
50572 network-technology:
50574 description: Network technology - who defines these values?
50575 neutron-network-id:
50577 description: Neutron network id of this Interface
50582 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
50583 network-role-instance:
50586 description: network role instance
50589 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50590 orchestration-status:
50592 description: Orchestration status of this VNF, mastered by MSO
50595 description: Heat stack id corresponding to this instance, managed by MSO
50598 description: Corresponds to the SDN-C catalog id used to configure this VCE
50599 contrail-network-fqdn:
50601 description: Contrail FQDN for the network
50602 model-invariant-id:
50604 description: the ASDC model id for this resource or service model.
50607 description: the ASDC model version for this resource or service model.
50608 persona-model-version:
50610 description: the ASDC model version for this resource or service model.
50611 model-customization-id:
50613 description: captures the id of all the configuration used to customize the resource for the service.
50616 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
50617 widget-model-version:
50619 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
50620 physical-network-name:
50622 description: Name associated with the physical network.
50623 is-provider-network:
50627 is-external-network:
50631 description: Path to the controller object.
50632 operational-status:
50634 description: Indicator for whether the resource is considered operational.
50638 $ref: "#/definitions/subnet"
50642 $ref: "#/definitions/ctag-assignment"
50643 segmentation-assignments:
50646 $ref: "#/definitions/segmentation-assignment"
50650 $ref: "#/definitions/relationship"
50651 description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
50657 $ref: "#/definitions/l3-network"
50660 Link aggregate interface
50661 ###### Related Nodes
50662 - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
50663 - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
50664 - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
50665 - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
50666 - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
50667 - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
50668 - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
50669 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
50670 - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
50671 - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
50678 description: Name that identifies the link aggregate interface
50679 interface-description:
50681 description: Human friendly text regarding this interface.
50684 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50687 description: Captures the numeric part of the speed
50690 description: Captures the units corresponding to the speed
50693 description: ID of interface
50696 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50699 description: Trigger for operational monitoring of this resource by Service Assurance systems.
50705 $ref: "#/definitions/relationship"
50709 $ref: "#/definitions/l-interface"
50712 Collection of link aggregate interfaces.
50717 $ref: "#/definitions/lag-interface"
50720 LAG links can connect lag-interfaces
50721 ###### Related Nodes
50722 - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
50723 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
50729 description: Alphabetical concatenation of lag-interface names
50732 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50736 $ref: "#/definitions/relationship"
50739 Collection of link aggregation connections
50744 $ref: "#/definitions/lag-link"
50747 Metadata for license group.
50748 ###### Related Nodes
50749 - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
50750 - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
50757 description: Unique ID for the license group the resource belongs to, should be uuid.
50760 description: Unique ID of a license resource.
50763 description: Concurrency value
50767 $ref: "#/definitions/relationship"
50770 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
50775 $ref: "#/definitions/license"
50778 describes a line-of-business
50779 ###### Related Nodes
50780 - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
50782 - line-of-business-name
50784 line-of-business-name:
50786 description: Name of the line-of-business (product)
50789 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50793 $ref: "#/definitions/relationship"
50796 Collection of lines-of-business
50801 $ref: "#/definitions/line-of-business"
50804 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
50805 ###### Related Nodes
50806 - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
50807 - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
50808 - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
50809 - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
50810 - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
50811 - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
50812 - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
50813 - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
50814 - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
50815 - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
50816 - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
50817 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
50818 - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
50819 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
50826 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
50829 description: Type of logical link, e.g., evc
50832 description: Captures the numeric part of the speed
50835 description: Captures the units corresponding to the speed
50838 description: v4, v6, or ds for dual stack
50841 description: For example, static or BGP
50844 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50845 model-invariant-id:
50847 description: the ASDC model id for this resource or service model.
50850 description: the ASDC model version for this resource or service model.
50851 persona-model-version:
50853 description: the ASDC model version for this resource or service model.
50856 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
50857 widget-model-version:
50859 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
50860 operational-status:
50862 description: Indication of operational status of the logical link.
50865 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
50868 description: Indication of the network use of the logical link.
50871 description: Alias or alternate name (CLCI or D1 name).
50874 description: UUID of the logical-link, SDNC generates this.
50877 description: Circuit id
50880 description: Reason for this entity, role it is playing
50884 $ref: "#/definitions/relationship"
50887 Collection of logical connections
50892 $ref: "#/definitions/logical-link"
50895 Collection of metadatum (key/value pairs)
50900 $ref: "#/definitions/metadatum"
50904 ###### Related Nodes
50905 - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
50906 - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
50907 - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
50908 - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
50919 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50922 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
50923 ###### Related Nodes
50924 - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
50925 - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
50926 - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
50927 - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
50928 - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
50929 - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
50930 - MODEL is DELETED when these are DELETED MODEL-VER
50932 - model-invariant-id
50935 model-invariant-id:
50937 description: Unique identifier corresponding to the main definition of a model in ASDC
50940 description: Type of the model, e.g., service, resource, widget, etc.
50943 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50947 $ref: "#/definitions/model-ver"
50951 $ref: "#/definitions/relationship"
50952 model-and-named-query-search:
50954 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
50958 $ref: "#/definitions/query-parameters"
50961 $ref: "#/definitions/instance-filters"
50964 $ref: "#/definitions/secondary-filts"
50967 secondary-filter-cut-point:
50971 This is how we would capture constraints defining allowed sets of elements.
50972 ###### Related Nodes
50973 - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
50974 - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
50975 - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
50977 - model-constraint-uuid
50978 - constrained-element-set-uuid-to-replace
50980 model-constraint-uuid:
50982 constrained-element-set-uuid-to-replace:
50984 constrained-element-sets:
50987 $ref: "#/definitions/constrained-element-set"
50990 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50996 $ref: "#/definitions/model-constraint"
50999 Defines how other models combine to make up a higher-level model.
51000 ###### Related Nodes
51001 - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
51002 - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
51003 - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
51004 - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
51005 - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
51006 - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
51007 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
51008 - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
51010 - model-element-uuid
51011 - new-data-del-flag
51014 model-element-uuid:
51018 description: Indicates whether this element was created as part of instantiation from this model
51021 description: How many of this type of element are required/allowed
51026 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51030 $ref: "#/definitions/model-element"
51031 description: Defines how other models combine to make up a higher-level model
51035 $ref: "#/definitions/model-constraint"
51036 description: Describes new constraints on this model element that are not part of that model's definition
51040 $ref: "#/definitions/relationship"
51046 $ref: "#/definitions/model-element"
51049 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
51050 ###### Related Nodes
51051 - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
51052 - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
51053 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
51054 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
51055 - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
51056 - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
51064 description: Unique identifier corresponding to one version of a model in ASDC
51067 description: Name of the model, which can change from version to version.
51070 description: Version
51073 description: Description
51076 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51080 $ref: "#/definitions/model-element"
51084 $ref: "#/definitions/metadatum"
51088 $ref: "#/definitions/relationship"
51094 $ref: "#/definitions/model-ver"
51097 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
51102 $ref: "#/definitions/model"
51103 multicast-configuration:
51105 ###### Related Nodes
51106 - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
51108 - multicast-configuration-id
51109 - multicast-protocol
51112 multicast-configuration-id:
51114 description: Unique id of multicast configuration.
51115 multicast-protocol:
51117 description: protocol of multicast configuration
51120 description: rp type of multicast configuration
51123 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51127 $ref: "#/definitions/relationship"
51128 multicast-configurations:
51130 multicast configuration of generic-vnf ip-address
51132 multicast-configuration:
51135 $ref: "#/definitions/multicast-configuration"
51141 $ref: "#/definitions/named-query"
51145 ###### Related Nodes
51146 - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
51147 - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
51148 - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
51149 - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
51153 - named-query-version
51159 named-query-version:
51161 required-input-param:
51167 named-query-elements:
51170 $ref: "#/definitions/named-query-element"
51174 $ref: "#/definitions/relationship"
51175 named-query-element:
51178 ###### Related Nodes
51179 - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
51180 - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
51181 - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
51182 - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
51183 - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
51184 - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
51185 - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
51187 - named-query-element-uuid
51189 named-query-element-uuid:
51191 property-collect-list:
51195 property-limit-desc:
51199 named-query-elements:
51202 $ref: "#/definitions/named-query-element"
51206 $ref: "#/definitions/related-lookup"
51207 property-constraints:
51210 $ref: "#/definitions/property-constraint"
51214 $ref: "#/definitions/relationship"
51215 named-query-elements:
51217 named-query-element:
51220 $ref: "#/definitions/named-query-element"
51223 Namespace for network inventory resources.
51228 $ref: "#/definitions/logical-link"
51232 $ref: "#/definitions/site-pair-set"
51236 $ref: "#/definitions/vpn-binding"
51240 $ref: "#/definitions/vpls-pe"
51241 multicast-configurations:
51244 $ref: "#/definitions/multicast-configuration"
51248 $ref: "#/definitions/vce"
51252 $ref: "#/definitions/vnfc"
51256 $ref: "#/definitions/l3-network"
51260 $ref: "#/definitions/network-policy"
51264 $ref: "#/definitions/generic-vnf"
51268 $ref: "#/definitions/lag-link"
51272 $ref: "#/definitions/newvce"
51276 $ref: "#/definitions/pnf"
51280 $ref: "#/definitions/physical-link"
51281 ipsec-configurations:
51284 $ref: "#/definitions/ipsec-configuration"
51285 route-table-references:
51288 $ref: "#/definitions/route-table-reference"
51292 $ref: "#/definitions/instance-group"
51296 $ref: "#/definitions/zone"
51302 $ref: "#/definitions/network-policy"
51305 ###### Related Nodes
51306 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
51307 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
51309 - network-policy-id
51313 description: UUID representing unique key to this instance
51314 network-policy-fqdn:
51316 description: Contrail FQDN for the policy
51319 description: ID for the openStack Heat instance
51322 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51326 $ref: "#/definitions/relationship"
51329 Network profile populated by SDN-GP for SNMP
51330 ###### Related Nodes
51331 - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
51337 description: Unique name of network profile.
51340 description: Encrypted SNMP community string
51343 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51347 $ref: "#/definitions/relationship"
51350 Collection of network profiles
51355 $ref: "#/definitions/network-profile"
51358 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
51359 ###### Related Nodes
51360 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
51361 - NEWVCE is DELETED when these are DELETED L-INTERFACE
51369 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
51372 description: Name of VNF.
51375 description: Alternate name of VNF.
51378 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.
51381 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
51382 operational-status:
51384 description: Indicator for whether the resource is considered operational
51387 description: OBSOLETE - do not use
51390 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
51393 description: Client should send valid enumerated value.
51396 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51397 ipv4-loopback0-address:
51399 description: v4 Loopback0 address
51400 orchestration-status:
51402 description: Orchestration status of this VNF, mastered by MSO.
51405 description: Heat stack id corresponding to this instance, managed by MSO
51408 description: Corresponds to the SDN-C catalog id used to configure this VCE
51412 $ref: "#/definitions/relationship"
51416 $ref: "#/definitions/l-interface"
51419 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
51424 $ref: "#/definitions/newvce"
51425 notification-event:
51429 notification-event-header:
51431 $ref: "#/definitions/notification-event-header"
51432 notification-event-header:
51473 $ref: "#/definitions/key-data"
51478 OAM network, to be deprecated shortly. Do not use for new purposes.
51479 ###### Related Nodes
51480 - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
51481 - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
51482 - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
51490 description: UUID of the network. Unique across a cloud-region
51493 description: Name of the network.
51497 description: cvlan-id
51498 ipv4-oam-gateway-address:
51500 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
51501 ipv4-oam-gateway-address-prefix-length:
51504 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
51507 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51511 $ref: "#/definitions/relationship"
51514 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
51519 $ref: "#/definitions/oam-network"
51520 operational-environment:
51522 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
51523 ###### Related Nodes
51524 - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
51525 - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
51527 - operational-environment-id
51528 - operational-environment-name
51529 - operational-environment-type
51530 - operational-environment-status
51534 operational-environment-id:
51536 description: UUID of an operational environment
51537 operational-environment-name:
51539 description: Operational Environment name
51540 operational-environment-type:
51542 description: Operational Environment Type.
51543 operational-environment-status:
51545 description: Status
51548 description: Tenant Context.
51551 description: Workload Context.
51554 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51558 $ref: "#/definitions/relationship"
51559 operational-environments:
51561 a logical partition of the cloud which allows to have multiple environments in the production AIC.
51563 operational-environment:
51566 $ref: "#/definitions/operational-environment"
51569 Allows for legacy POST of old-style and new-style models
51571 - model-invariant-id
51572 - model-name-version-id
51578 model-invariant-id:
51580 description: Unique identifier corresponding to the main definition of a model in ASDC
51581 model-name-version-id:
51583 description: Unique identifier corresponding to one version of a model in ASDC
51586 description: Type of the model, e.g., service, resource, widget, etc.
51589 description: Name of the model, which can change from version to version.
51592 description: Invariant unique ID which does not change from version to version
51595 description: Version
51598 description: Description
51601 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51604 $ref: "#/definitions/model-vers"
51607 $ref: "#/definitions/relationship-list"
51610 Collection of owning-entities
51615 $ref: "#/definitions/owning-entity"
51618 describes an owning-entity
51619 ###### Related Nodes
51620 - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
51623 - owning-entity-name
51627 description: UUID of an owning entity
51628 owning-entity-name:
51630 description: Owning entity name
51633 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51637 $ref: "#/definitions/relationship"
51640 Physical interface (e.g., nic)
51641 ###### Related Nodes
51642 - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
51643 - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
51644 - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
51645 - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
51646 - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
51647 - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
51648 - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
51649 - P-INTERFACE is DELETED when these are DELETED L-INTERFACE
51650 - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
51657 description: Name that identifies the physical interface
51660 description: Captures the numeric part of the speed
51663 description: Captures the units corresponding to the speed
51666 description: Nature of the services and connectivity on this port.
51667 equipment-identifier:
51669 description: CLEI or other specification for p-interface hardware.
51672 description: Role specification for p-interface hardware.
51675 description: Indicates the physical properties of the interface.
51678 description: Trigger for operational monitoring of this resource by Service Assurance systems.
51681 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51687 $ref: "#/definitions/relationship"
51691 $ref: "#/definitions/l-interface"
51694 Collection of physical interfaces.
51699 $ref: "#/definitions/p-interface"
51702 Collection of physical connections, typically between p-interfaces
51703 ###### Related Nodes
51704 - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
51710 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
51713 description: Captures the numeric part of the speed
51716 description: Captures the units corresponding to the speed
51719 description: Circuit it
51722 description: Dual access mode (e.g., primary, secondary
51725 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
51726 service-provider-name:
51728 description: Name of the service Provider on this link.
51731 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51735 $ref: "#/definitions/relationship"
51738 Collection of physical connections, typically between p-interfaces
51743 $ref: "#/definitions/physical-link"
51746 describes a platform
51747 ###### Related Nodes
51748 - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
51754 description: Name of the platform
51757 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51761 $ref: "#/definitions/relationship"
51764 Collection of platforms
51769 $ref: "#/definitions/platform"
51772 PNF represents a physical network function. typically equipment used in the D1 world.
51773 ###### Related Nodes
51774 - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
51775 - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
51776 - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
51777 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
51778 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
51779 - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
51780 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
51781 - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
51788 description: unique name of Physical Network Function.
51791 description: name of Physical Network Function.
51794 description: source of name2
51797 description: id of pnf
51800 description: Equipment type. Source of truth should define valid values.
51803 description: Equipment vendor. Source of truth should define valid values.
51806 description: Equipment model. Source of truth should define valid values.
51809 description: identifier of managed by company or customer
51812 description: ipv4-oam-address with new naming convention for IP addresses
51815 description: sw-version is the version of SW for the hosted application on the PNF.
51820 description: ID of the physical frame (relay rack) where pnf is installed.
51823 description: Serial number of the device
51824 ipaddress-v4-loopback-0:
51826 description: IPV4 Loopback 0 address
51827 ipaddress-v6-loopback-0:
51829 description: IPV6 Loopback 0 address
51832 description: IPV4 AIM address
51835 description: IPV6 AIM address
51838 description: IPV6 OAM address
51841 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
51844 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51847 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
51850 description: Nf Role is the role performed by this instance in the network.
51854 $ref: "#/definitions/relationship"
51858 $ref: "#/definitions/p-interface"
51862 $ref: "#/definitions/lag-interface"
51865 Collection of Physical Network Functions.
51870 $ref: "#/definitions/pnf"
51873 Used to capture the network interfaces of this VCE
51874 ###### Related Nodes
51875 - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
51876 - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
51877 - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
51880 - orchestration-status
51884 description: Unique ID of the interface
51885 neutron-network-id:
51887 description: Neutron network id of this Interface
51888 neutron-network-name:
51890 description: Neutron network name of this Interface
51893 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
51896 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51899 description: Unique ID for port group in vmware
51902 description: Likely to duplicate value of neutron network name
51905 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
51906 orchestration-status:
51908 description: Orchestration status of this VNF, mastered by MSO
51911 description: Heat stack id corresponding to this instance, managed by MSO
51914 description: Corresponds to the SDN-C catalog id used to configure this VCE
51918 $ref: "#/definitions/cvlan-tag-entry"
51922 $ref: "#/definitions/relationship"
51928 $ref: "#/definitions/port-group"
51931 describes the project
51932 ###### Related Nodes
51933 - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
51939 description: Name of the project deploying a service
51942 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51946 $ref: "#/definitions/relationship"
51949 Collection of projects
51954 $ref: "#/definitions/project"
51957 Property holder for query properties or instance properties
51963 property-constraint:
51966 ###### Related Nodes
51967 - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
51969 - property-constraint-uuid
51974 property-constraint-uuid:
51984 property-constraints:
51986 property-constraint:
51989 $ref: "#/definitions/property-constraint"
51992 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
51993 ###### Related Nodes
51994 - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
51995 - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
51996 - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
51997 - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
51998 - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
51999 - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
52000 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
52001 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
52002 - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
52003 - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
52004 - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
52005 - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
52006 - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
52013 description: Value from executing hostname on the compute node.
52016 description: PTNII name
52020 description: Number of cpus
52024 description: Disk size, in GBs
52028 description: RAM size, in MBs
52031 description: Equipment type. Source of truth should define valid values.
52034 description: Equipment vendor. Source of truth should define valid values.
52037 description: Equipment model. Source of truth should define valid values.
52040 description: Fully-qualified domain name
52043 description: URL to endpoint where AAI can get more details
52046 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
52049 description: Serial number, may be queried
52050 ipaddress-v4-loopback-0:
52052 description: IPV4 Loopback 0 address
52053 ipaddress-v6-loopback-0:
52055 description: IPV6 Loopback 0 address
52058 description: IPV4 AIM address
52061 description: IPV6 AIM address
52064 description: IPV6 OAM address
52067 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
52070 description: ID of Pserver
52073 description: internet topology of Pserver
52078 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52081 description: alternative pserver name
52084 description: purpose of pserver
52087 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
52091 $ref: "#/definitions/relationship"
52095 $ref: "#/definitions/p-interface"
52099 $ref: "#/definitions/lag-interface"
52102 Collection of compute hosts.
52107 $ref: "#/definitions/pserver"
52110 QueryParameters for performing a named-query or model query
52114 $ref: "#/definitions/named-query"
52117 $ref: "#/definitions/overloaded-model"
52121 ###### Related Nodes
52122 - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
52124 - related-lookup-uuid
52126 - source-node-property
52128 - target-node-property
52130 related-lookup-uuid:
52134 source-node-property:
52138 target-node-property:
52140 property-collect-list:
52147 $ref: "#/definitions/relationship"
52153 $ref: "#/definitions/related-lookup"
52154 related-to-property:
52158 description: Key part of a key/value pair
52161 description: Value part of a key/value pair
52166 description: A keyword provided by A&AI to indicate type of node.
52169 description: URL to the object in A&AI.
52173 $ref: "#/definitions/relationship-data"
52177 - relationship-value
52181 description: A keyword provided by A&AI to indicate an attribute.
52182 relationship-value:
52184 description: Value of the attribute.
52190 $ref: "#/definitions/relationship"
52191 reserved-prop-names:
52193 Internal map to define some reserved properties of a vertex
52195 last-mod-source-of-truth:
52213 Response container for the results of a named-query or model query
52215 inventory-response-items:
52217 $ref: "#/definitions/inventory-response-items"
52222 description: The specific type of node in the A&AI graph
52225 description: The URL to the specific resource
52226 route-table-reference:
52228 Openstack route table reference.
52229 ###### Related Nodes
52230 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
52232 - route-table-reference-id
52233 - route-table-reference-fqdn
52235 route-table-reference-id:
52237 description: Route Table Reference id, UUID assigned to this instance.
52238 route-table-reference-fqdn:
52240 description: FQDN entry in the route table.
52243 description: Concurrency value
52247 $ref: "#/definitions/relationship"
52248 route-table-references:
52250 Collection of openstack route table references
52252 route-table-reference:
52255 $ref: "#/definitions/route-table-reference"
52258 Route target information
52259 ###### Related Nodes
52260 - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
52262 - global-route-target
52263 - route-target-role
52265 global-route-target:
52267 description: Number used to identify an RT, globally unique in the network
52270 description: Role assigned to this route target
52273 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52277 $ref: "#/definitions/relationship"
52280 Collection of route target information
52285 $ref: "#/definitions/route-target"
52288 ###### Related Nodes
52289 - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
52290 - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
52291 - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
52293 - routing-instance-id
52295 routing-instance-id:
52297 description: Unique id of routing instance
52300 description: rpm owner
52303 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52307 $ref: "#/definitions/site-pair"
52311 $ref: "#/definitions/relationship"
52314 set of probes related to generic-vnf routing instance
52319 $ref: "#/definitions/routing-instance"
52324 $ref: "#/definitions/oam-networks"
52325 az-and-dvs-switches:
52328 $ref: "#/definitions/az-and-dvs-switches"
52331 edge-tag-query-result:
52333 $ref: "#/definitions/edge-tag-query-result"
52334 edge-tag-query-request:
52336 $ref: "#/definitions/edge-tag-query-request"
52339 $ref: "#/definitions/search-results"
52342 $ref: "#/definitions/sdn-zone-response"
52348 $ref: "#/definitions/result-data"
52351 SecondaryFilt for performing a named-query or model query
52362 SecondaryFilts for performing a named-query or model query
52367 $ref: "#/definitions/secondary-filt"
52368 segmentation-assignment:
52370 Openstack segmentation assignment.
52371 ###### Related Nodes
52372 - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
52378 description: Route Table Reference id, UUID assigned to this instance.
52381 description: Concurrency value
52385 $ref: "#/definitions/relationship"
52386 segmentation-assignments:
52388 Collection of openstack segmentation assignments
52390 segmentation-assignment:
52393 $ref: "#/definitions/segmentation-assignment"
52396 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
52399 - service-description
52403 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
52404 service-description:
52406 description: Description of the service
52409 description: URL to endpoint where AAI can get more details
52412 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52415 description: service version
52419 $ref: "#/definitions/relationship"
52420 service-capabilities:
52422 Collection of service capabilities.
52424 service-capability:
52427 $ref: "#/definitions/service-capability"
52428 service-capability:
52430 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
52431 ###### Related Nodes
52432 - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
52433 - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
52434 - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
52441 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
52444 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.
52447 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52451 $ref: "#/definitions/relationship"
52452 service-design-and-creation:
52454 Namespace for objects managed by ASDC
52459 $ref: "#/definitions/vnf-image"
52463 $ref: "#/definitions/service"
52464 service-capabilities:
52467 $ref: "#/definitions/service-capability"
52471 $ref: "#/definitions/model"
52475 $ref: "#/definitions/named-query"
52478 Instance of a service
52479 ###### Related Nodes
52480 - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
52481 - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
52482 - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
52483 - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
52484 - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
52485 - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
52486 - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
52487 - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
52488 - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
52489 - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
52490 - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
52491 - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
52492 - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
52493 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
52494 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
52495 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
52496 - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM
52497 - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
52499 - service-instance-id
52501 service-instance-id:
52503 description: Uniquely identifies this instance of a service
52504 service-instance-name:
52506 description: This field will store a name assigned to the service-instance.
52507 model-invariant-id:
52509 description: the ASDC model id for this resource or service model.
52512 description: the ASDC model version for this resource or service model.
52513 persona-model-version:
52515 description: the ASDC model version for this resource or service model.
52518 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
52519 widget-model-version:
52521 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
52524 description: Indicates the total bandwidth to be used for this service.
52527 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
52528 bandwidth-down-wan1:
52530 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
52533 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
52534 bandwidth-down-wan2:
52536 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
52539 description: URL customers will use to access the vHN Portal.
52540 service-instance-location-id:
52542 description: An identifier that customers assign to the location where this service is being used.
52545 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52548 description: Path to the controller object.
52549 orchestration-status:
52551 description: Orchestration status of this service.
52555 $ref: "#/definitions/relationship"
52559 $ref: "#/definitions/metadatum"
52560 allotted-resources:
52563 $ref: "#/definitions/allotted-resource"
52566 Collection of service instances
52571 $ref: "#/definitions/service-instance"
52572 service-subscription:
52574 Object that group service instances.
52575 ###### Related Nodes
52576 - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
52577 - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
52578 - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
52579 - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
52585 description: Value defined by orchestration to identify this service across ECOMP.
52586 temp-ub-sub-account-id:
52588 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
52591 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52595 $ref: "#/definitions/service-instance"
52599 $ref: "#/definitions/relationship"
52600 service-subscriptions:
52602 Collection of objects that group service instances.
52604 service-subscription:
52607 $ref: "#/definitions/service-subscription"
52610 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
52615 $ref: "#/definitions/service"
52618 ###### Related Nodes
52619 - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
52620 - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
52621 - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
52627 description: unique identifier of probe
52630 description: Prefix address
52633 description: Prefix address
52636 description: ip version, v4, v6
52637 destination-hostname:
52639 description: Hostname of the destination equipment to which SLAs are measured against.
52640 destination-equip-type:
52642 description: The type of destinatination equipment. Could be Router, etc.
52645 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52646 classes-of-service:
52649 $ref: "#/definitions/class-of-service"
52653 $ref: "#/definitions/relationship"
52656 Set of instances for probes used to measure service level agreements
52657 ###### Related Nodes
52658 - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
52659 - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
52660 - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
52666 description: Unique id of site pair set.
52669 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52673 $ref: "#/definitions/routing-instance"
52677 $ref: "#/definitions/relationship"
52680 Collection of sets of instances for probes related to generic-vnf
52685 $ref: "#/definitions/site-pair-set"
52693 $ref: "#/definitions/site-pair"
52697 ###### Related Nodes
52698 - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52699 - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
52705 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
52708 description: Snapshot name
52709 snapshot-architecture:
52711 description: Operating system architecture
52712 snapshot-os-distro:
52714 description: The common name of the operating system distribution in lowercase
52715 snapshot-os-version:
52717 description: The operating system version as specified by the distributor.
52720 description: The application that the image instantiates.
52721 application-vendor:
52723 description: The vendor of the application.
52724 application-version:
52726 description: The version of the application.
52729 description: URL to endpoint where AAI can get more details
52732 description: This field contains the UUID of the previous snapshot (if any).
52735 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52739 $ref: "#/definitions/relationship"
52742 Collection of openstack snapshots
52747 $ref: "#/definitions/snapshot"
52750 SR-IOV Physical Function
52751 ###### Related Nodes
52752 - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
52753 - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
52759 description: Identifier for the sriov-pf
52762 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52766 $ref: "#/definitions/relationship"
52769 Collection of SR-IOV Physical Functions.
52774 $ref: "#/definitions/sriov-pf"
52777 SR-IOV Virtual Function (not to be confused with virtual network function)
52778 ###### Related Nodes
52779 - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
52785 description: PCI ID used to identify the sriov-vf
52788 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
52791 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
52794 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
52795 vf-vlan-anti-spoof-check:
52797 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.
52798 vf-mac-anti-spoof-check:
52800 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.
52803 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
52804 vf-broadcast-allow:
52806 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
52807 vf-unknown-multicast-allow:
52809 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
52810 vf-unknown-unicast-allow:
52812 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
52815 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
52818 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
52821 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52822 neutron-network-id:
52824 description: Neutron network id of the interface
52828 $ref: "#/definitions/relationship"
52831 Collection of SR-IOV Virtual Functions.
52836 $ref: "#/definitions/sriov-vf"
52845 ###### Related Nodes
52846 - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
52847 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
52848 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
52849 - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
52856 description: Subnet ID, should be UUID.
52859 description: Name associated with the subnet.
52862 description: Neutron id of this subnet
52865 description: gateway ip address
52866 network-start-address:
52868 description: network start address
52871 description: cidr mask
52874 description: ip version
52875 orchestration-status:
52877 description: Orchestration status of this VNF, mastered by MSO
52882 description: the start address reserved for use by dhcp
52885 description: the last address reserved for use by dhcp
52888 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52892 $ref: "#/definitions/relationship"
52898 $ref: "#/definitions/subnet"
52899 tagged-inventory-item-list:
52904 $ref: "#/definitions/inventory-item"
52908 ###### Related Nodes
52909 - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52910 - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
52911 - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
52912 - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
52913 - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
52914 - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
52915 - TENANT cannot be deleted if linked to VSERVER
52922 description: Unique id relative to the cloud-region.
52925 description: Readable name of tenant
52928 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52932 $ref: "#/definitions/vserver"
52936 $ref: "#/definitions/relationship"
52939 Collection of openstack tenants.
52944 $ref: "#/definitions/tenant"
52947 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
52948 ###### Related Nodes
52949 - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
52952 - bandwidth-up-wan1
52953 - bandwidth-down-wan1
52954 - bandwidth-up-wan2
52955 - bandwidth-down-wan2
52959 description: Allotted Resource id UUID assigned to this instance.
52962 description: The WAN uplink bandwidth for WAN1
52963 bandwidth-down-wan1:
52965 description: The WAN downlink bandwidth for WAN1
52968 description: The WAN uplink bandwidth for WAN2
52969 bandwidth-down-wan2:
52971 description: The WAN downlink bandwidth for WAN2
52974 description: Concurrency value
52978 $ref: "#/definitions/relationship"
52981 This object is used to store the specific tunnel cross connect aspects of an allotted resource
52986 $ref: "#/definitions/tunnel-xconnect"
52989 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
52998 $ref: "#/definitions/update-node-key"
53004 $ref: "#/definitions/action"
53013 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
53014 ###### Related Nodes
53015 - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
53016 - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
53017 - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
53018 - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
53019 - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
53020 - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
53021 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
53022 - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
53030 description: Unique id of VNF. This is unique across the graph.
53033 description: Name of VNF.
53036 description: Alternate name of VNF.
53039 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.
53042 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
53043 regional-resource-zone:
53045 description: Regional way of organizing pservers, source of truth should define values
53048 description: Trigger for operational monitoring of this resource by Service Assurance systems.
53049 operational-status:
53051 description: Indicator for whether the resource is considered operational
53054 description: OBSOLETE - do not use
53057 description: Network role being played by this VNF
53058 orchestration-status:
53060 description: Orchestration status of this VNF, mastered by MSO
53063 description: Heat stack id corresponding to this instance, managed by MSO
53066 description: Corresponds to the SDN-C catalog id used to configure this VCE
53069 description: Unique ID of VPE connected to this VCE.
53070 v6-vce-wan-address:
53072 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
53075 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
53078 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53079 ipv4-loopback0-address:
53081 description: Loopback0 address
53082 entitlement-resource-uuid:
53084 description: OBSOLETE - see child relationships
53088 $ref: "#/definitions/port-group"
53092 $ref: "#/definitions/license"
53096 $ref: "#/definitions/entitlement"
53100 $ref: "#/definitions/relationship"
53103 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
53108 $ref: "#/definitions/vce"
53111 a deployment unit of VNFCs
53112 ###### Related Nodes
53113 - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53114 - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
53115 - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
53116 - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
53117 - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
53118 - VF-MODULE cannot be deleted if linked to VNFC
53121 - is-base-vf-module
53125 description: Unique ID of vf-module.
53128 description: Name of vf-module
53131 description: Heat stack id corresponding to this instance.
53132 orchestration-status:
53134 description: orchestration status of this vf-module, mastered by MSO
53139 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53140 model-invariant-id:
53142 description: the ASDC model id for this resource or service model.
53145 description: the ASDC model version for this resource or service model.
53146 persona-model-version:
53148 description: the ASDC model version for this resource or service model.
53149 model-customization-id:
53151 description: captures the id of all the configuration used to customize the resource for the service.
53154 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
53155 widget-model-version:
53157 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
53158 contrail-service-instance-fqdn:
53160 description: the Contrail unique ID for a service-instance
53164 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
53167 description: Path to the controller object.
53171 $ref: "#/definitions/relationship"
53174 Collection of vf-modules, a deployment unit of VNFCs
53179 $ref: "#/definitions/vf-module"
53182 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
53183 ###### Related Nodes
53184 - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
53190 description: indicates whether the VIG is for AVPN or INTERNET
53193 description: v4 IP of the vig server
53196 description: v6 IP of the vig server
53199 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53203 $ref: "#/definitions/relationship"
53209 $ref: "#/definitions/vig-server"
53210 vip-ipv4-address-list:
53213 ###### Related Nodes
53214 - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53215 - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
53216 - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
53217 - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
53223 description: IP address
53224 vip-ipv4-prefix-length:
53227 description: Prefix length, 32 for single address
53231 description: Inner VLAN tag
53235 description: Outer VLAN tag
53238 description: Indicator of fixed or floating address
53241 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53242 neutron-network-id:
53244 description: Neutron network id of the interface that address belongs to
53247 description: Neutron id of subnet that address belongs to
53251 $ref: "#/definitions/relationship"
53252 vip-ipv6-address-list:
53255 ###### Related Nodes
53256 - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53257 - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
53258 - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
53259 - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
53265 description: IP address
53266 vip-ipv6-prefix-length:
53269 description: Prefix length, 128 for single address
53273 description: Inner VLAN tag
53277 description: Outer VLAN tag
53280 description: Indicator of fixed or floating address
53283 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53284 neutron-network-id:
53286 description: Neutron network id of the interface that address belongs to
53289 description: Neutron id of subnet that address belongs to
53293 $ref: "#/definitions/relationship"
53294 virtual-data-center:
53296 Virtual organization of cloud infrastructure elements in a data center context
53297 ###### Related Nodes
53298 - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
53299 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
53300 - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
53307 description: Unique ID of the vdc
53310 description: Name of the virtual data center
53313 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53317 $ref: "#/definitions/relationship"
53318 virtual-data-centers:
53320 Virtual organization of cloud infrastructure elements in a data center context
53322 virtual-data-center:
53325 $ref: "#/definitions/virtual-data-center"
53329 ###### Related Nodes
53330 - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
53331 - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
53332 - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
53333 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
53334 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
53335 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
53336 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
53337 - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
53338 - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
53345 description: String that identifies the interface
53349 description: Inner VLAN tag
53353 description: Outer VLAN tag
53356 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53359 description: Captures the numeric part of the speed
53362 description: Captures the units corresponding to the speed
53365 description: Used to describe (the service associated with) the vlan
53366 backdoor-connection:
53368 description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
53371 description: This indicates the customers VPN ID associated with this vlan
53372 orchestration-status:
53374 description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
53380 $ref: "#/definitions/relationship"
53381 l3-interface-ipv4-address-list:
53384 $ref: "#/definitions/l3-interface-ipv4-address-list"
53385 l3-interface-ipv6-address-list:
53388 $ref: "#/definitions/l3-interface-ipv6-address-list"
53394 $ref: "#/definitions/vlan"
53403 description: Unique id of VNF. This is unique across the graph.
53406 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
53407 ###### Related Nodes
53408 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
53409 - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
53413 - application-vendor
53417 description: Unique ID of this asset
53420 description: The application that the image instantiates.
53421 application-vendor:
53423 description: The vendor of the application.
53424 application-version:
53426 description: The version of the application.
53429 description: URL to endpoint where AAI can get more details
53432 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53436 $ref: "#/definitions/relationship"
53439 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
53444 $ref: "#/definitions/vnf-image"
53447 ###### Related Nodes
53448 - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53449 - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
53450 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
53453 - vnfc-function-code
53456 - is-closed-loop-disabled
53460 description: Unique ID of vnfc.
53461 vnfc-function-code:
53463 description: function code
53469 description: prov status of this vnfc
53470 orchestration-status:
53472 description: Orchestration status of this VNF, mastered by APP-C
53473 ipaddress-v4-oam-vip:
53475 description: Oam V4 vip address of this vnfc
53478 is-closed-loop-disabled:
53482 description: Group notation of VNFC
53485 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53489 $ref: "#/definitions/relationship"
53492 virtual network components associated with a vserver from application controller.
53497 $ref: "#/definitions/vnfc"
53500 Ephemeral Block storage volume.
53501 ###### Related Nodes
53502 - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
53509 description: Unique ID of block storage volume relative to the vserver.
53512 description: URL to endpoint where AAI can get more details
53515 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53519 $ref: "#/definitions/relationship"
53522 Persistent block-level storage.
53523 ###### Related Nodes
53524 - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53525 - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53526 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
53527 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
53528 - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
53531 - volume-group-name
53536 description: Unique ID of volume-group.
53539 description: Name of the volume group.
53542 description: Heat stack id corresponding to this volume-group
53545 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.
53546 orchestration-status:
53548 description: Orchestration status of this volume-group
53549 model-customization-id:
53551 description: captures the id of all the configuration used to customize the resource for the service.
53552 vf-module-model-customization-id:
53554 description: helps relate the volume group to the vf-module whose components will require the volume group
53557 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53561 $ref: "#/definitions/relationship"
53564 Collection of persistent block-level storage.
53569 $ref: "#/definitions/volume-group"
53572 Collection of ephemeral Block storage volumes.
53577 $ref: "#/definitions/volume"
53580 VPLS Provider Edge routers.
53581 ###### Related Nodes
53582 - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53583 - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
53584 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
53585 - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
53586 - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
53594 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
53597 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
53600 description: Client should send valid enumerated value, e.g., VPLS-PE.
53604 description: Temporary location for stag to get to VCE
53607 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53611 $ref: "#/definitions/relationship"
53615 $ref: "#/definitions/p-interface"
53619 $ref: "#/definitions/lag-interface"
53622 Collection of VPLS Provider Edge routers
53627 $ref: "#/definitions/vpls-pe"
53631 ###### Related Nodes
53632 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
53633 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
53634 - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
53635 - VPN-BINDING cannot be deleted if linked to L3-NETWORK,LOGICAL-LINK
53636 - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
53643 description: VPN ID, globally unique within A&AI
53646 description: VPN Name
53649 description: the platform associated with the VPN example AVPN, Mobility
53652 description: Type of the vpn, should be taken from enumerated/valid values
53653 route-distinguisher:
53655 description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
53658 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53662 $ref: "#/definitions/route-target"
53666 $ref: "#/definitions/relationship"
53667 description: l3-networks relate to vpn-bindings
53673 $ref: "#/definitions/vpn-binding"
53676 Virtual Servers, aka virtual machine or VM.
53677 ###### Related Nodes
53678 - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
53679 - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
53680 - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
53681 - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
53682 - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
53683 - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
53684 - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
53685 - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
53686 - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
53687 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
53688 - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
53689 - VSERVER is DELETED when these are DELETED L-INTERFACE
53690 - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
53696 - is-closed-loop-disabled
53700 description: Unique identifier for this vserver relative to its tenant
53703 description: Name of vserver
53706 description: Alternative name of vserver
53709 description: Trigger for operational monitoring of this resource by Service Assurance systems.
53712 description: URL to endpoint where AAI can get more details
53715 is-closed-loop-disabled:
53719 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53723 $ref: "#/definitions/volume"
53727 $ref: "#/definitions/relationship"
53731 $ref: "#/definitions/l-interface"
53734 Collection of virtual Servers, aka virtual machines or VMs.
53739 $ref: "#/definitions/vserver"
53742 A zone is a grouping of assets in a location homing to the same connections into the CBB
53743 ###### Related Nodes
53744 - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53745 - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
53746 - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
53747 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
53756 description: Code assigned by AIC to the zone
53759 description: English name associated with the zone
53762 description: Design of zone [Medium/Large?]
53765 description: Context of zone [production/test]
53768 description: Status of a zone.
53771 description: Concurrency value
53775 $ref: "#/definitions/relationship"
53778 Collection of zones
53783 $ref: "#/definitions/zone"
53798 $ref: "#/patchDefinitions/action-data"
53807 APIs that are more action related than REST (e.g., notify, update).
53811 $ref: "#/patchDefinitions/update"
53814 $ref: "#/patchDefinitions/notify"
53817 Represents a slice or partial piece of a resource that gets separately allotted
53818 ###### Related Nodes
53819 - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
53820 - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
53821 - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
53822 - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
53823 - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
53824 - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
53825 - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
53826 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
53827 - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
53833 description: Allotted Resource id UUID assigned to this instance.
53836 description: The descriptive information assigned to this allotted resource instance
53839 description: Link back to more information in the controller
53840 model-invariant-id:
53842 description: the ASDC model id for this resource or service model.
53845 description: the ASDC model version for this resource or service model.
53846 persona-model-version:
53848 description: the ASDC model version for this resource or service model.
53849 allotted-resources:
53851 This object is used to store slices of services being offered
53856 $ref: "#/patchDefinitions/allotted-resource"
53859 Availability zone, a collection of compute hosts/pservers
53860 ###### Related Nodes
53861 - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53862 - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
53863 - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53864 - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
53865 - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
53866 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
53867 - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
53868 - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
53869 - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
53871 - availability-zone-name
53874 availability-zone-name:
53876 description: Name of the availability zone. Unique across a cloud region
53879 description: Type of hypervisor. Source of truth should define valid values.
53880 operational-status:
53882 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
53883 availability-zones:
53885 Collection of availability zones
53890 $ref: "#/patchDefinitions/availability-zone"
53891 az-and-dvs-switches:
53895 $ref: "#/patchDefinitions/dvs-switches"
53898 $ref: "#/patchDefinitions/availability-zone"
53901 Namespace for business related constructs
53906 $ref: "#/patchDefinitions/connector"
53910 $ref: "#/patchDefinitions/customer"
53913 ###### Related Nodes
53914 - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
53920 description: unique identifier of probe
53923 description: identifier of probe
53926 description: type of probe
53927 classes-of-service:
53929 class-of-service of probe
53934 $ref: "#/patchDefinitions/class-of-service"
53935 cloud-infrastructure:
53937 Namespace for cloud infrastructure.
53942 $ref: "#/patchDefinitions/complex"
53946 $ref: "#/patchDefinitions/cloud-region"
53950 $ref: "#/patchDefinitions/network-profile"
53954 $ref: "#/patchDefinitions/pserver"
53955 virtual-data-centers:
53958 $ref: "#/patchDefinitions/virtual-data-center"
53961 cloud-region designates an installation of a cloud cluster or region or instantiation
53962 ###### Related Nodes
53963 - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53964 - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
53965 - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
53966 - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53967 - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53968 - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53969 - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53970 - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53971 - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53972 - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53973 - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53974 - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53975 - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
53976 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
53977 - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
53978 - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
53985 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
53988 description: Identifier used by the vendor for the region. Second part of composite key
53991 description: Type of the cloud (e.g., openstack)
53992 owner-defined-type:
53994 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
53995 cloud-region-version:
53997 description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
54000 description: URL of the keystone identity service
54003 description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
54006 description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
54012 $ref: "#/patchDefinitions/cloud-region"
54015 Collection of physical locations that can house cloud-regions.
54016 ###### Related Nodes
54017 - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54018 - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
54019 - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
54020 - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
54021 - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
54022 - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
54023 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
54024 - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
54025 - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
54026 - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
54027 - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
54028 - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
54029 - COMPLEX is DELETED when these are DELETED CTAG-POOL
54031 - physical-location-id
54032 - physical-location-type
54039 physical-location-id:
54041 description: Unique identifier for physical location, e.g., CLLI
54044 description: Data center code which can be an alternate way to identify a complex
54047 description: Gamma complex name for LCP instance.
54050 description: URL of the keystone identity service
54053 Collection of physical locations that can house cloud-regions.
54058 $ref: "#/patchDefinitions/complex"
54061 Port Mirror Configuration.
54062 ###### Related Nodes
54063 - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
54064 - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
54065 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
54066 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
54067 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
54068 - CONFIGURATION is DELETED when these are DELETED METADATUM
54069 - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
54072 - configuration-type
54073 - configuration-sub-type
54074 - orchestration-status
54075 - operational-status
54076 - configuration-selflink
54077 - model-customization-id
54081 description: UUID assigned to configuration.
54084 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
54085 configuration-name:
54087 description: Name of the configuration.
54088 configuration-type:
54090 description: port-mirroring-configuration.
54091 configuration-sub-type:
54093 description: vprobe, pprobe.
54094 model-invariant-id:
54096 description: the ASDC model id for this resource or service model.
54099 description: the ASDC model version for this resource or service model.
54100 orchestration-status:
54102 description: Orchestration status of the configuration.
54103 operational-status:
54105 description: Indicator for whether the resource is considered operational.
54106 configuration-selflink:
54108 description: URL to endpoint where AAI can get more details from SDN-GC.
54109 model-customization-id:
54111 description: id of the configuration used to customize the resource
54114 Collection of configurations
54119 $ref: "#/patchDefinitions/configuration"
54122 Collection of resource instances used to connect a variety of disparate inventory widgets
54123 ###### Related Nodes
54124 - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
54125 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
54126 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
54127 - CONNECTOR is DELETED when these are DELETED METADATUM
54129 - resource-instance-id
54131 resource-instance-id:
54133 description: Unique id of resource instance.
54136 Collection of resource instances used to connect a variety of disparate inventory widgets
54141 $ref: "#/patchDefinitions/connector"
54142 constrained-element-set:
54144 This is how we would capture constraints defining allowed sets of elements.
54145 ###### Related Nodes
54146 - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
54147 - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
54148 - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
54149 - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
54151 - constrained-element-set-uuid
54155 constrained-element-set-uuid:
54161 constrained-element-sets:
54163 constrained-element-set:
54166 $ref: "#/patchDefinitions/constrained-element-set"
54169 ###### Related Nodes
54170 - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
54171 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
54184 $ref: "#/patchDefinitions/ctag-assignment"
54187 A collection of C tags (vlan tags) grouped for a specific purpose.
54188 ###### Related Nodes
54189 - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
54190 - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
54191 - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
54194 - availability-zone-name
54195 - ctag-pool-purpose
54199 description: The Target provider edge router
54200 availability-zone-name:
54202 description: Name of the availability zone
54205 description: Describes what the intended purpose of this pool is.
54208 description: Comma separated list of ctags
54214 $ref: "#/patchDefinitions/ctag-pool"
54217 customer identifiers to provide linkage back to BSS information.
54218 ###### Related Nodes
54219 - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
54220 - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
54222 - global-customer-id
54226 global-customer-id:
54228 description: Global customer id used across ECOMP to uniquely identify customer.
54231 description: Subscriber name, an alternate way to retrieve a customer.
54234 description: Subscriber type, a way to provide VID with only the INFRA customers.
54237 Collection of customer identifiers to provide linkage back to BSS information.
54242 $ref: "#/patchDefinitions/customer"
54250 description: See mis-na-virtualization-platform.yang
54256 $ref: "#/patchDefinitions/cvlan-tag-entry"
54259 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.
54260 ###### Related Nodes
54261 - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54262 - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
54269 description: DVS switch name
54272 description: URL used to reach the vcenter
54275 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
54280 $ref: "#/patchDefinitions/dvs-switch"
54283 Internal map to define the properties of an edge and interpret the map EdgeRules
54301 edge-tag-query-request:
54312 $ref: "#/patchDefinitions/start-node-filter"
54313 include-node-filter:
54316 $ref: "#/patchDefinitions/include-node-filter"
54320 $ref: "#/patchDefinitions/secondary-filter"
54321 edge-tag-query-result:
54323 tagged-inventory-item-list:
54326 $ref: "#/patchDefinitions/tagged-inventory-item-list"
54327 element-choice-set:
54329 This is how we would capture constraints defining allowed sets of elements.
54330 ###### Related Nodes
54331 - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
54332 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
54333 - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
54335 - element-choice-set-uuid
54336 - element-choice-set-name
54338 element-choice-set-uuid:
54340 element-choice-set-name:
54344 element-choice-sets:
54346 element-choice-set:
54349 $ref: "#/patchDefinitions/element-choice-set"
54352 Metadata for entitlement group.
54353 ###### Related Nodes
54354 - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54355 - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
54362 description: Unique ID for the entitlement group the resource comes from, should be uuid.
54365 description: Unique ID of an entitlement resource.
54368 Entitlements, keyed by group-uuid and resource-uuid, related to license management
54373 $ref: "#/patchDefinitions/entitlement"
54376 Persist EMS address information used by EMS driver.
54377 ###### Related Nodes
54378 - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
54379 - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
54385 description: Unique ID of EMS.
54391 $ref: "#/patchDefinitions/esr-ems"
54394 Persist common address information of external systems.
54395 ###### Related Nodes
54396 - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
54397 - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
54398 - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
54399 - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
54401 - esr-system-info-id
54406 esr-system-info-id:
54408 description: Unique ID of esr system info.
54411 description: name of external system.
54414 description: type of external systems.
54417 description: vendor of external systems.
54420 description: version of external systems.
54423 description: url used to access external systems.
54426 description: username used to access external systems.
54429 description: password used to access external systems.
54432 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
54435 description: protocol of third party SDNC, for example netconf/snmp.
54438 description: ca file content if enabled ssl on auth-url.
54441 description: Whether to verify VIM's certificate.
54444 description: service IP of ftp server.
54447 description: service port of ftp server.
54450 description: domain info for authentication.
54453 description: default tenant of VIM.
54456 description: ftp passive mode or not.
54459 description: resource or performance data file path.
54462 description: the status of external system.
54463 esr-system-info-list:
54465 Collection of persistent block-level external system auth info.
54470 $ref: "#/patchDefinitions/esr-system-info"
54471 esr-thirdparty-sdnc:
54473 Persist SDNC address information used by ONAP SDNC.
54474 ###### Related Nodes
54475 - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
54476 - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
54477 - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
54479 - thirdparty-sdnc-id
54481 thirdparty-sdnc-id:
54483 description: Unique ID of SDNC.
54486 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
54489 description: password used to access SDNC server.
54490 esr-thirdparty-sdnc-list:
54492 esr-thirdparty-sdnc:
54495 $ref: "#/patchDefinitions/esr-thirdparty-sdnc"
54498 Persist VNFM address information used by VF-C.
54499 ###### Related Nodes
54500 - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
54501 - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
54507 description: Unique ID of VNFM.
54510 description: indecate the VIM to deploy VNF.
54513 description: certificate url of VNFM.
54519 $ref: "#/patchDefinitions/esr-vnfm"
54522 evc object is an optional child object of the Configuration object.
54523 ###### Related Nodes
54524 - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
54530 description: Unique/key field for the evc object
54531 forwarding-path-topology:
54533 description: Point-to-Point, Multi-Point
54536 description: Commited Information Rate
54539 description: CIR units
54540 connection-diversity-group-id:
54542 description: Diversity Group ID
54545 description: formerly Performance Group
54546 esp-evc-circuit-id:
54548 description: EVC Circuit ID of ESP EVC
54551 description: Committed Information Rate (For ESP)
54554 description: CIR units (For ESP)
54557 description: Identifies ESP
54558 collector-pop-clli:
54560 description: Collector POP CLLI (from the hostname of the access pnf)
54561 inter-connect-type-ingress:
54563 description: Interconnect type on ingress side of EVC.
54564 tagmode-access-ingress:
54566 description: tagode for collector side of EVC
54567 tagmode-access-egress:
54569 description: tagMode for network side of EVC
54575 $ref: "#/patchDefinitions/evc"
54578 Namespace for external system.
54582 $ref: "#/patchDefinitions/esr-ems-list"
54585 $ref: "#/patchDefinitions/esr-vnfm-list"
54586 esr-thirdparty-sdnc-list:
54588 $ref: "#/patchDefinitions/esr-thirdparty-sdnc-list"
54591 Extra properties for inventory item for response list
54596 $ref: "#/patchDefinitions/extra-property"
54606 ###### Related Nodes
54607 - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54608 - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
54609 - FLAVOR cannot be deleted if linked to VSERVER
54617 description: Flavor id, expected to be unique across cloud-region.
54620 description: Flavor name
54624 description: Number of CPUs
54628 description: Amount of memory
54632 description: Disk space
54636 description: Amount of ephemeral disk space
54639 description: amount of swap space allocation
54642 description: whether flavor is available to all users or private to the tenant it was created in.
54645 description: URL to endpoint where AAI can get more details
54648 description: Boolean as to whether this flavor is no longer enabled
54651 Collection of openstack flavors.
54656 $ref: "#/patchDefinitions/flavor"
54659 Entity describing a sequenced segment of forwarding path
54660 ###### Related Nodes
54661 - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
54662 - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
54663 - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
54664 - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
54665 - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
54666 - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
54673 description: Unique ID of this segmentation
54676 description: ingress, intermediate, egress
54679 forwarder object is an optional child object of the Configuration object.
54680 ###### Related Nodes
54681 - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
54687 description: Key for forwarder-evc object
54690 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
54693 description: Internal VLAN.
54696 description: SVLAN value for ingress of egress forwarder.
54699 description: CVLAN value for ingress of egress forwarder.
54705 $ref: "#/patchDefinitions/forwarder-evc"
54711 $ref: "#/patchDefinitions/forwarder"
54714 Entity that describes the sequenced forwarding path between interfaces of services or resources
54715 ###### Related Nodes
54716 - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
54717 - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
54718 - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
54719 - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
54720 - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
54722 - forwarding-path-id
54723 - forwarding-path-name
54725 forwarding-path-id:
54727 description: Unique ID of this FP
54728 forwarding-path-name:
54730 description: Name of the FP
54736 $ref: "#/patchDefinitions/forwarding-path"
54739 General purpose VNF
54740 ###### Related Nodes
54741 - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
54742 - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54743 - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
54744 - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54745 - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
54746 - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
54747 - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
54748 - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
54749 - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
54750 - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
54751 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
54752 - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54753 - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54754 - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54755 - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54756 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54757 - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
54758 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
54759 - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
54760 - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54761 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
54762 - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
54768 - is-closed-loop-disabled
54772 description: Unique id of VNF. This is unique across the graph.
54775 description: Name of VNF.
54778 description: Alternate name of VNF.
54781 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.
54784 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
54785 regional-resource-zone:
54787 description: Regional way of organizing pservers, source of truth should define values
54790 description: Trigger for operational monitoring of this resource by Service Assurance systems.
54791 operational-status:
54793 description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
54796 description: OBSOLETE - do not use
54799 description: Client should send valid enumerated value
54800 orchestration-status:
54802 description: Orchestration status of this VNF, used by MSO.
54805 description: Heat stack id corresponding to this instance, managed by MSO
54808 description: Corresponds to the SDN-C catalog id used to configure this VCE
54811 description: identifier of managed by company or customer
54814 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
54815 ipv4-loopback0-address:
54817 description: v4 Loopback0 address
54820 description: v6 Loopback address
54821 management-v6-address:
54823 description: v6 management address
54827 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
54830 description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only in some usecases
54834 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
54837 description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only in some usecases
54841 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
54844 description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases
54847 is-closed-loop-disabled:
54856 $ref: "#/patchDefinitions/generic-vnf"
54859 Openstack group-assignment used to store exclusivity groups (EG).
54860 ###### Related Nodes
54861 - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54862 - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
54863 - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
54871 description: Group id, expected to be unique across cloud-region.
54874 description: Group type - the type of group this instance refers to
54877 description: Group name - name assigned to the group
54880 description: Group description - description of the group
54883 Collection of openstack group assignments
54888 $ref: "#/patchDefinitions/group-assignment"
54891 ###### Related Nodes
54892 - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
54900 description: host-route id
54903 description: subnet prefix
54906 description: Could be ip-address, hostname, or service-instance
54909 description: Should be ip-address, hostname, or service-instance to match next-hop
54915 $ref: "#/patchDefinitions/host-route"
54918 Collection of HPA Capabilities
54923 $ref: "#/patchDefinitions/hpa-capability"
54926 Represents a HPA capability
54927 ###### Related Nodes
54928 - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
54929 - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54930 - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
54931 - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES
54933 - hpa-capability-id
54938 description: UUID to uniquely identify a HPA capability
54941 description: Name of the HPACapability
54944 description: HPA schema version
54947 description: Hardware architecture
54948 hpa-feature-attributes:
54950 HPA Capability Feature attributes
54951 ###### Related Nodes
54952 - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
54956 description: name of the specific HPA attribute
54959 description: JSON string specifying the value, unit and type of the specific HPA attribute
54963 ###### Related Nodes
54964 - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54965 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
54966 - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
54967 - IMAGE cannot be deleted if linked to VSERVER
54968 - IMAGE is DELETED when these are DELETED METADATUM
54978 description: Image id, expected to be unique across cloud region
54981 description: Image name
54982 image-architecture:
54984 description: Operating system architecture.
54987 description: The common name of the operating system distribution in lowercase
54990 description: The operating system version as specified by the distributor.
54993 description: The application that the image instantiates.
54994 application-vendor:
54996 description: The vendor of the application.
54997 application-version:
54999 description: The version of the application.
55002 description: URL to endpoint where AAI can get more details
55005 Collectio of Openstack images.
55010 $ref: "#/patchDefinitions/image"
55011 include-node-filter:
55017 InstanceFilter for performing a named-query or model query
55020 InstanceFilters for performing a named-query or model query
55025 $ref: "#/patchDefinitions/instance-filter"
55028 General mechanism for grouping instances
55029 ###### Related Nodes
55030 - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
55031 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
55032 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
55033 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
55034 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
55035 - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
55036 - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
55037 - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
55045 description: Instance Group ID, UUID assigned to this instance.
55048 description: Descriptive text to help identify the usage of this instance-group
55051 description: Only valid value today is lower case ha for high availability
55054 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
55057 Collection of openstack route table references
55062 $ref: "#/patchDefinitions/instance-group"
55067 $ref: "#/patchDefinitions/search"
55070 $ref: "#/patchDefinitions/actions"
55071 cloud-infrastructure:
55073 $ref: "#/patchDefinitions/cloud-infrastructure"
55076 $ref: "#/patchDefinitions/business"
55077 service-design-and-creation:
55079 $ref: "#/patchDefinitions/service-design-and-creation"
55082 $ref: "#/patchDefinitions/network"
55085 $ref: "#/patchDefinitions/aai-internal"
55089 $ref: "#/patchDefinitions/aai-internal"
55092 inventory-item-type:
55094 inventory-item-link:
55096 inventory-item-data:
55099 $ref: "#/patchDefinitions/inventory-item-data"
55100 tagged-inventory-item-list:
55103 $ref: "#/patchDefinitions/tagged-inventory-item-list"
55104 inventory-item-data:
55110 inventory-response-item:
55112 Inventory item for response list
55118 $ref: "#/patchDefinitions/extra-properties"
55119 inventory-response-items:
55121 $ref: "#/patchDefinitions/inventory-response-items"
55122 inventory-response-items:
55124 Container for inventory items in response list
55126 inventory-response-item:
55129 $ref: "#/patchDefinitions/inventory-response-item"
55130 ipsec-configuration:
55132 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
55133 ###### Related Nodes
55134 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
55135 - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
55136 - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
55138 - ipsec-configuration-id
55140 ipsec-configuration-id:
55142 description: UUID of this configuration
55143 requested-vig-address-type:
55145 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
55146 requested-encryption-strength:
55148 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
55149 requested-dmz-type:
55151 description: can offer a shared DMZ or a DMZ specific to a customer
55152 shared-dmz-network-address:
55154 description: Network address of shared DMZ
55155 requested-customer-name:
55157 description: If the DMZ is a custom DMZ, this field will indicate the customer information
55160 description: can be 1 or 2
55161 ikev1-authentication:
55163 description: Contains values like md5, sha1, sha256, sha384
55166 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
55169 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
55172 description: Group name defined in VIG for clients using aggressive mode
55175 description: pre-shared key for the above group name
55178 description: Lifetime for IKEv1 SA
55179 ipsec-authentication:
55181 description: md5, sha1, sha256, sha384
55184 description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
55187 description: Life time for IPSec SA
55190 description: enable PFS or not
55193 description: user ID for xAuth, sm-user, ,nmteHostName
55194 xauth-user-password:
55196 description: Encrypted using the Juniper $9$ algorithm
55199 description: The time between DPD probe
55202 description: Maximum number of DPD before claiming the tunnel is down
55203 ipsec-configurations:
55205 ipsec-configuration:
55208 $ref: "#/patchDefinitions/ipsec-configuration"
55217 Logical interfaces, e.g., a vnic.
55218 ###### Related Nodes
55219 - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
55220 - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
55221 - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
55222 - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
55223 - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
55224 - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
55225 - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
55226 - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
55227 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
55228 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
55229 - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
55230 - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
55231 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
55232 - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
55233 - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
55241 description: Name given to the interface
55244 description: E.g., CUSTOMER, UPLINK, etc.
55247 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
55250 description: URL to endpoint where AAI can get more details
55253 description: ID of interface
55256 description: MAC address for the interface
55259 description: Name of the network
55262 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
55263 interface-description:
55265 description: Human friendly text regarding this interface.
55270 Collection of logical interfaces.
55275 $ref: "#/patchDefinitions/l-interface"
55276 l3-interface-ipv4-address-list:
55279 ###### Related Nodes
55280 - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
55281 - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
55282 - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
55283 - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
55284 - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
55286 - l3-interface-ipv4-address
55288 l3-interface-ipv4-address:
55290 description: IP address
55291 l3-interface-ipv4-prefix-length:
55294 description: Prefix length, 32 for single address
55298 description: Inner VLAN tag
55302 description: Outer VLAN tag
55305 description: Indicator of fixed or floating address
55306 l3-interface-ipv6-address-list:
55309 ###### Related Nodes
55310 - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
55311 - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
55312 - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
55313 - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
55314 - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
55316 - l3-interface-ipv6-address
55318 l3-interface-ipv6-address:
55320 description: IP address
55321 l3-interface-ipv6-prefix-length:
55324 description: Prefix length, 128 for single address
55328 description: Inner VLAN tag
55332 description: Outer VLAN tag
55335 description: Indicator of fixed or floating address
55338 Generic network definition
55339 ###### Related Nodes
55340 - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
55341 - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
55342 - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
55343 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
55344 - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
55345 - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
55346 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
55347 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
55348 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
55349 - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
55350 - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
55351 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
55352 - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
55353 - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
55354 - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
55355 - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
55360 - is-provider-network
55361 - is-shared-network
55362 - is-external-network
55366 description: Network ID, should be uuid. Unique across A&AI.
55369 description: Name of the network, governed by some naming convention..
55372 description: Type of the network - who defines these values?
55375 description: Role the network plans - who defines these values?
55376 network-technology:
55378 description: Network technology - who defines these values?
55379 neutron-network-id:
55381 description: Neutron network id of this Interface
55386 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
55387 network-role-instance:
55390 description: network role instance
55396 $ref: "#/patchDefinitions/l3-network"
55399 Link aggregate interface
55400 ###### Related Nodes
55401 - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
55402 - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
55403 - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
55404 - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
55405 - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
55406 - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
55407 - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
55408 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
55409 - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
55410 - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
55417 description: Name that identifies the link aggregate interface
55418 interface-description:
55420 description: Human friendly text regarding this interface.
55423 Collection of link aggregate interfaces.
55428 $ref: "#/patchDefinitions/lag-interface"
55431 LAG links can connect lag-interfaces
55432 ###### Related Nodes
55433 - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
55434 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
55440 description: Alphabetical concatenation of lag-interface names
55443 Collection of link aggregation connections
55448 $ref: "#/patchDefinitions/lag-link"
55451 Metadata for license group.
55452 ###### Related Nodes
55453 - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
55454 - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
55461 description: Unique ID for the license group the resource belongs to, should be uuid.
55464 description: Unique ID of a license resource.
55467 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
55472 $ref: "#/patchDefinitions/license"
55475 describes a line-of-business
55476 ###### Related Nodes
55477 - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
55479 - line-of-business-name
55481 line-of-business-name:
55483 description: Name of the line-of-business (product)
55486 Collection of lines-of-business
55491 $ref: "#/patchDefinitions/line-of-business"
55494 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
55495 ###### Related Nodes
55496 - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
55497 - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
55498 - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
55499 - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
55500 - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
55501 - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
55502 - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
55503 - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
55504 - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
55505 - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
55506 - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
55507 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
55508 - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
55509 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
55516 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
55519 description: Type of logical link, e.g., evc
55522 description: Captures the numeric part of the speed
55525 description: Captures the units corresponding to the speed
55528 description: v4, v6, or ds for dual stack
55531 description: For example, static or BGP
55534 Collection of logical connections
55539 $ref: "#/patchDefinitions/logical-link"
55542 Collection of metadatum (key/value pairs)
55547 $ref: "#/patchDefinitions/metadatum"
55551 ###### Related Nodes
55552 - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
55553 - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
55554 - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
55555 - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
55566 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
55567 ###### Related Nodes
55568 - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
55569 - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
55570 - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
55571 - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
55572 - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
55573 - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
55574 - MODEL is DELETED when these are DELETED MODEL-VER
55576 - model-invariant-id
55579 model-invariant-id:
55581 description: Unique identifier corresponding to the main definition of a model in ASDC
55584 description: Type of the model, e.g., service, resource, widget, etc.
55585 model-and-named-query-search:
55587 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
55591 $ref: "#/patchDefinitions/query-parameters"
55594 $ref: "#/patchDefinitions/instance-filters"
55597 $ref: "#/patchDefinitions/secondary-filts"
55600 secondary-filter-cut-point:
55604 This is how we would capture constraints defining allowed sets of elements.
55605 ###### Related Nodes
55606 - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
55607 - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
55608 - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
55610 - model-constraint-uuid
55611 - constrained-element-set-uuid-to-replace
55613 model-constraint-uuid:
55615 constrained-element-set-uuid-to-replace:
55617 constrained-element-sets:
55620 $ref: "#/patchDefinitions/constrained-element-set"
55626 $ref: "#/patchDefinitions/model-constraint"
55629 Defines how other models combine to make up a higher-level model.
55630 ###### Related Nodes
55631 - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
55632 - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
55633 - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
55634 - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
55635 - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
55636 - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
55637 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
55638 - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
55640 - model-element-uuid
55641 - new-data-del-flag
55644 model-element-uuid:
55648 description: Indicates whether this element was created as part of instantiation from this model
55651 description: How many of this type of element are required/allowed
55659 $ref: "#/patchDefinitions/model-element"
55662 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
55663 ###### Related Nodes
55664 - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
55665 - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
55666 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
55667 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
55668 - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
55669 - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
55677 description: Unique identifier corresponding to one version of a model in ASDC
55680 description: Name of the model, which can change from version to version.
55683 description: Version
55686 description: Description
55692 $ref: "#/patchDefinitions/model-ver"
55695 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
55700 $ref: "#/patchDefinitions/model"
55701 multicast-configuration:
55703 ###### Related Nodes
55704 - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
55706 - multicast-configuration-id
55707 - multicast-protocol
55710 multicast-configuration-id:
55712 description: Unique id of multicast configuration.
55713 multicast-protocol:
55715 description: protocol of multicast configuration
55718 description: rp type of multicast configuration
55719 multicast-configurations:
55721 multicast configuration of generic-vnf ip-address
55723 multicast-configuration:
55726 $ref: "#/patchDefinitions/multicast-configuration"
55732 $ref: "#/patchDefinitions/named-query"
55736 ###### Related Nodes
55737 - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
55738 - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
55739 - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
55740 - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
55744 - named-query-version
55750 named-query-version:
55752 required-input-param:
55756 named-query-element:
55759 ###### Related Nodes
55760 - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
55761 - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
55762 - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55763 - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55764 - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55765 - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55766 - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
55768 - named-query-element-uuid
55770 named-query-element-uuid:
55772 property-collect-list:
55774 named-query-elements:
55776 named-query-element:
55779 $ref: "#/patchDefinitions/named-query-element"
55782 Namespace for network inventory resources.
55787 $ref: "#/patchDefinitions/logical-link"
55791 $ref: "#/patchDefinitions/site-pair-set"
55795 $ref: "#/patchDefinitions/vpn-binding"
55799 $ref: "#/patchDefinitions/vpls-pe"
55800 multicast-configurations:
55803 $ref: "#/patchDefinitions/multicast-configuration"
55807 $ref: "#/patchDefinitions/vce"
55811 $ref: "#/patchDefinitions/vnfc"
55815 $ref: "#/patchDefinitions/l3-network"
55819 $ref: "#/patchDefinitions/network-policy"
55823 $ref: "#/patchDefinitions/generic-vnf"
55827 $ref: "#/patchDefinitions/lag-link"
55831 $ref: "#/patchDefinitions/newvce"
55835 $ref: "#/patchDefinitions/pnf"
55839 $ref: "#/patchDefinitions/physical-link"
55840 ipsec-configurations:
55843 $ref: "#/patchDefinitions/ipsec-configuration"
55844 route-table-references:
55847 $ref: "#/patchDefinitions/route-table-reference"
55851 $ref: "#/patchDefinitions/instance-group"
55855 $ref: "#/patchDefinitions/zone"
55861 $ref: "#/patchDefinitions/network-policy"
55864 ###### Related Nodes
55865 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
55866 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
55868 - network-policy-id
55872 description: UUID representing unique key to this instance
55873 network-policy-fqdn:
55875 description: Contrail FQDN for the policy
55878 description: ID for the openStack Heat instance
55881 Network profile populated by SDN-GP for SNMP
55882 ###### Related Nodes
55883 - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
55889 description: Unique name of network profile.
55892 description: Encrypted SNMP community string
55895 Collection of network profiles
55900 $ref: "#/patchDefinitions/network-profile"
55903 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
55904 ###### Related Nodes
55905 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
55906 - NEWVCE is DELETED when these are DELETED L-INTERFACE
55914 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
55917 description: Name of VNF.
55920 description: Alternate name of VNF.
55923 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.
55926 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
55927 operational-status:
55929 description: Indicator for whether the resource is considered operational
55932 description: OBSOLETE - do not use
55935 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
55938 description: Client should send valid enumerated value.
55941 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
55946 $ref: "#/patchDefinitions/newvce"
55947 notification-event:
55951 notification-event-header:
55953 $ref: "#/patchDefinitions/notification-event-header"
55954 notification-event-header:
55995 $ref: "#/patchDefinitions/key-data"
56000 OAM network, to be deprecated shortly. Do not use for new purposes.
56001 ###### Related Nodes
56002 - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56003 - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
56004 - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
56012 description: UUID of the network. Unique across a cloud-region
56015 description: Name of the network.
56019 description: cvlan-id
56020 ipv4-oam-gateway-address:
56022 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
56023 ipv4-oam-gateway-address-prefix-length:
56026 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
56029 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
56034 $ref: "#/patchDefinitions/oam-network"
56035 operational-environment:
56037 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
56038 ###### Related Nodes
56039 - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
56040 - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
56042 - operational-environment-id
56043 - operational-environment-name
56044 - operational-environment-type
56045 - operational-environment-status
56049 operational-environment-id:
56051 description: UUID of an operational environment
56052 operational-environment-name:
56054 description: Operational Environment name
56055 operational-environment-type:
56057 description: Operational Environment Type.
56058 operational-environment-status:
56060 description: Status
56063 description: Tenant Context.
56066 description: Workload Context.
56067 operational-environments:
56069 a logical partition of the cloud which allows to have multiple environments in the production AIC.
56071 operational-environment:
56074 $ref: "#/patchDefinitions/operational-environment"
56077 Allows for legacy POST of old-style and new-style models
56079 - model-invariant-id
56080 - model-name-version-id
56086 model-invariant-id:
56088 description: Unique identifier corresponding to the main definition of a model in ASDC
56089 model-name-version-id:
56091 description: Unique identifier corresponding to one version of a model in ASDC
56094 description: Type of the model, e.g., service, resource, widget, etc.
56097 description: Name of the model, which can change from version to version.
56100 description: Invariant unique ID which does not change from version to version
56103 description: Version
56106 description: Description
56109 Collection of owning-entities
56114 $ref: "#/patchDefinitions/owning-entity"
56117 describes an owning-entity
56118 ###### Related Nodes
56119 - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
56122 - owning-entity-name
56126 description: UUID of an owning entity
56127 owning-entity-name:
56129 description: Owning entity name
56132 Physical interface (e.g., nic)
56133 ###### Related Nodes
56134 - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
56135 - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
56136 - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
56137 - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
56138 - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
56139 - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
56140 - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
56141 - P-INTERFACE is DELETED when these are DELETED L-INTERFACE
56142 - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
56149 description: Name that identifies the physical interface
56152 description: Captures the numeric part of the speed
56155 description: Captures the units corresponding to the speed
56158 description: Nature of the services and connectivity on this port.
56159 equipment-identifier:
56161 description: CLEI or other specification for p-interface hardware.
56164 description: Role specification for p-interface hardware.
56167 description: Indicates the physical properties of the interface.
56170 description: Trigger for operational monitoring of this resource by Service Assurance systems.
56173 Collection of physical interfaces.
56178 $ref: "#/patchDefinitions/p-interface"
56181 Collection of physical connections, typically between p-interfaces
56182 ###### Related Nodes
56183 - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
56189 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
56192 description: Captures the numeric part of the speed
56195 description: Captures the units corresponding to the speed
56198 description: Circuit it
56201 description: Dual access mode (e.g., primary, secondary
56204 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
56205 service-provider-name:
56207 description: Name of the service Provider on this link.
56210 Collection of physical connections, typically between p-interfaces
56215 $ref: "#/patchDefinitions/physical-link"
56218 describes a platform
56219 ###### Related Nodes
56220 - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
56226 description: Name of the platform
56229 Collection of platforms
56234 $ref: "#/patchDefinitions/platform"
56237 PNF represents a physical network function. typically equipment used in the D1 world.
56238 ###### Related Nodes
56239 - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
56240 - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56241 - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
56242 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
56243 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
56244 - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
56245 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
56246 - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
56253 description: unique name of Physical Network Function.
56256 description: name of Physical Network Function.
56259 description: source of name2
56262 description: id of pnf
56265 description: Equipment type. Source of truth should define valid values.
56268 description: Equipment vendor. Source of truth should define valid values.
56271 description: Equipment model. Source of truth should define valid values.
56274 description: identifier of managed by company or customer
56277 description: ipv4-oam-address with new naming convention for IP addresses
56280 description: sw-version is the version of SW for the hosted application on the PNF.
56285 description: ID of the physical frame (relay rack) where pnf is installed.
56288 description: Serial number of the device
56289 ipaddress-v4-loopback-0:
56291 description: IPV4 Loopback 0 address
56292 ipaddress-v6-loopback-0:
56294 description: IPV6 Loopback 0 address
56297 description: IPV4 AIM address
56300 description: IPV6 AIM address
56303 description: IPV6 OAM address
56306 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
56309 Collection of Physical Network Functions.
56314 $ref: "#/patchDefinitions/pnf"
56317 Used to capture the network interfaces of this VCE
56318 ###### Related Nodes
56319 - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
56320 - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
56321 - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
56324 - orchestration-status
56328 description: Unique ID of the interface
56329 neutron-network-id:
56331 description: Neutron network id of this Interface
56332 neutron-network-name:
56334 description: Neutron network name of this Interface
56337 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
56343 $ref: "#/patchDefinitions/port-group"
56346 describes the project
56347 ###### Related Nodes
56348 - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
56354 description: Name of the project deploying a service
56357 Collection of projects
56362 $ref: "#/patchDefinitions/project"
56365 Property holder for query properties or instance properties
56371 property-constraint:
56374 ###### Related Nodes
56375 - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
56377 - property-constraint-uuid
56382 property-constraint-uuid:
56390 property-constraints:
56392 property-constraint:
56395 $ref: "#/patchDefinitions/property-constraint"
56398 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
56399 ###### Related Nodes
56400 - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
56401 - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
56402 - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
56403 - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
56404 - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
56405 - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
56406 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
56407 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
56408 - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
56409 - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
56410 - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
56411 - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
56412 - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
56419 description: Value from executing hostname on the compute node.
56422 description: PTNII name
56426 description: Number of cpus
56430 description: Disk size, in GBs
56434 description: RAM size, in MBs
56437 description: Equipment type. Source of truth should define valid values.
56440 description: Equipment vendor. Source of truth should define valid values.
56443 description: Equipment model. Source of truth should define valid values.
56446 description: Fully-qualified domain name
56449 description: URL to endpoint where AAI can get more details
56452 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
56455 description: Serial number, may be queried
56456 ipaddress-v4-loopback-0:
56458 description: IPV4 Loopback 0 address
56459 ipaddress-v6-loopback-0:
56461 description: IPV6 Loopback 0 address
56464 description: IPV4 AIM address
56467 description: IPV6 AIM address
56470 description: IPV6 OAM address
56473 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
56476 description: ID of Pserver
56479 description: internet topology of Pserver
56484 Collection of compute hosts.
56489 $ref: "#/patchDefinitions/pserver"
56492 QueryParameters for performing a named-query or model query
56496 $ref: "#/patchDefinitions/named-query"
56499 $ref: "#/patchDefinitions/overloaded-model"
56503 ###### Related Nodes
56504 - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
56506 - related-lookup-uuid
56508 - source-node-property
56510 - target-node-property
56512 related-lookup-uuid:
56516 source-node-property:
56520 target-node-property:
56522 property-collect-list:
56529 $ref: "#/patchDefinitions/related-lookup"
56530 related-to-property:
56534 description: Key part of a key/value pair
56537 description: Value part of a key/value pair
56542 description: A keyword provided by A&AI to indicate type of node.
56545 description: URL to the object in A&AI.
56549 $ref: "#/patchDefinitions/relationship-data"
56550 related-to-property:
56553 $ref: "#/patchDefinitions/related-to-property"
56557 - relationship-value
56561 description: A keyword provided by A&AI to indicate an attribute.
56562 relationship-value:
56564 description: Value of the attribute.
56565 reserved-prop-names:
56567 Internal map to define some reserved properties of a vertex
56569 last-mod-source-of-truth:
56587 Response container for the results of a named-query or model query
56589 inventory-response-items:
56591 $ref: "#/patchDefinitions/inventory-response-items"
56596 description: The specific type of node in the A&AI graph
56599 description: The URL to the specific resource
56600 route-table-reference:
56602 Openstack route table reference.
56603 ###### Related Nodes
56604 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
56606 - route-table-reference-id
56607 - route-table-reference-fqdn
56609 route-table-reference-id:
56611 description: Route Table Reference id, UUID assigned to this instance.
56612 route-table-reference-fqdn:
56614 description: FQDN entry in the route table.
56615 route-table-references:
56617 Collection of openstack route table references
56619 route-table-reference:
56622 $ref: "#/patchDefinitions/route-table-reference"
56625 Route target information
56626 ###### Related Nodes
56627 - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
56629 - global-route-target
56630 - route-target-role
56632 global-route-target:
56634 description: Number used to identify an RT, globally unique in the network
56637 description: Role assigned to this route target
56640 Collection of route target information
56645 $ref: "#/patchDefinitions/route-target"
56648 ###### Related Nodes
56649 - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
56650 - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
56651 - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
56653 - routing-instance-id
56655 routing-instance-id:
56657 description: Unique id of routing instance
56660 description: rpm owner
56663 set of probes related to generic-vnf routing instance
56668 $ref: "#/patchDefinitions/routing-instance"
56673 $ref: "#/patchDefinitions/oam-networks"
56674 az-and-dvs-switches:
56677 $ref: "#/patchDefinitions/az-and-dvs-switches"
56680 edge-tag-query-result:
56682 $ref: "#/patchDefinitions/edge-tag-query-result"
56683 edge-tag-query-request:
56685 $ref: "#/patchDefinitions/edge-tag-query-request"
56688 $ref: "#/patchDefinitions/search-results"
56691 $ref: "#/patchDefinitions/sdn-zone-response"
56697 $ref: "#/patchDefinitions/result-data"
56700 SecondaryFilt for performing a named-query or model query
56711 SecondaryFilts for performing a named-query or model query
56716 $ref: "#/patchDefinitions/secondary-filt"
56717 segmentation-assignment:
56719 Openstack segmentation assignment.
56720 ###### Related Nodes
56721 - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
56727 description: Route Table Reference id, UUID assigned to this instance.
56728 segmentation-assignments:
56730 Collection of openstack segmentation assignments
56732 segmentation-assignment:
56735 $ref: "#/patchDefinitions/segmentation-assignment"
56738 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
56741 - service-description
56745 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
56746 service-description:
56748 description: Description of the service
56751 description: URL to endpoint where AAI can get more details
56752 service-capabilities:
56754 Collection of service capabilities.
56756 service-capability:
56759 $ref: "#/patchDefinitions/service-capability"
56760 service-capability:
56762 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
56763 ###### Related Nodes
56764 - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
56765 - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
56766 - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
56773 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
56776 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.
56777 service-design-and-creation:
56779 Namespace for objects managed by ASDC
56784 $ref: "#/patchDefinitions/vnf-image"
56788 $ref: "#/patchDefinitions/service"
56789 service-capabilities:
56792 $ref: "#/patchDefinitions/service-capability"
56796 $ref: "#/patchDefinitions/model"
56800 $ref: "#/patchDefinitions/named-query"
56803 Instance of a service
56804 ###### Related Nodes
56805 - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
56806 - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
56807 - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
56808 - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
56809 - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
56810 - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
56811 - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56812 - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
56813 - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
56814 - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
56815 - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
56816 - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
56817 - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
56818 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
56819 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
56820 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
56821 - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM
56822 - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
56824 - service-instance-id
56826 service-instance-id:
56828 description: Uniquely identifies this instance of a service
56829 service-instance-name:
56831 description: This field will store a name assigned to the service-instance.
56832 model-invariant-id:
56834 description: the ASDC model id for this resource or service model.
56837 description: the ASDC model version for this resource or service model.
56838 persona-model-version:
56840 description: the ASDC model version for this resource or service model.
56843 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
56844 widget-model-version:
56846 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
56849 description: Indicates the total bandwidth to be used for this service.
56852 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
56853 bandwidth-down-wan1:
56855 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
56858 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
56859 bandwidth-down-wan2:
56861 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
56864 description: URL customers will use to access the vHN Portal.
56865 service-instance-location-id:
56867 description: An identifier that customers assign to the location where this service is being used.
56870 Collection of service instances
56875 $ref: "#/patchDefinitions/service-instance"
56876 service-subscription:
56878 Object that group service instances.
56879 ###### Related Nodes
56880 - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
56881 - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
56882 - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
56883 - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
56889 description: Value defined by orchestration to identify this service across ECOMP.
56890 temp-ub-sub-account-id:
56892 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
56893 service-subscriptions:
56895 Collection of objects that group service instances.
56897 service-subscription:
56900 $ref: "#/patchDefinitions/service-subscription"
56903 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
56908 $ref: "#/patchDefinitions/service"
56911 ###### Related Nodes
56912 - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
56913 - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
56914 - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
56920 description: unique identifier of probe
56923 description: Prefix address
56926 description: Prefix address
56929 description: ip version, v4, v6
56930 destination-hostname:
56932 description: Hostname of the destination equipment to which SLAs are measured against.
56933 destination-equip-type:
56935 description: The type of destinatination equipment. Could be Router, etc.
56938 Set of instances for probes used to measure service level agreements
56939 ###### Related Nodes
56940 - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
56941 - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
56942 - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
56948 description: Unique id of site pair set.
56951 Collection of sets of instances for probes related to generic-vnf
56956 $ref: "#/patchDefinitions/site-pair-set"
56964 $ref: "#/patchDefinitions/site-pair"
56968 ###### Related Nodes
56969 - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56970 - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
56976 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
56979 description: Snapshot name
56980 snapshot-architecture:
56982 description: Operating system architecture
56983 snapshot-os-distro:
56985 description: The common name of the operating system distribution in lowercase
56986 snapshot-os-version:
56988 description: The operating system version as specified by the distributor.
56991 description: The application that the image instantiates.
56992 application-vendor:
56994 description: The vendor of the application.
56995 application-version:
56997 description: The version of the application.
57000 description: URL to endpoint where AAI can get more details
57003 description: This field contains the UUID of the previous snapshot (if any).
57006 Collection of openstack snapshots
57011 $ref: "#/patchDefinitions/snapshot"
57014 SR-IOV Physical Function
57015 ###### Related Nodes
57016 - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
57017 - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
57023 description: Identifier for the sriov-pf
57026 Collection of SR-IOV Physical Functions.
57031 $ref: "#/patchDefinitions/sriov-pf"
57034 SR-IOV Virtual Function (not to be confused with virtual network function)
57035 ###### Related Nodes
57036 - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
57042 description: PCI ID used to identify the sriov-vf
57045 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
57048 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
57051 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
57052 vf-vlan-anti-spoof-check:
57054 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.
57055 vf-mac-anti-spoof-check:
57057 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.
57060 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
57061 vf-broadcast-allow:
57063 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
57064 vf-unknown-multicast-allow:
57066 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
57067 vf-unknown-unicast-allow:
57069 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
57072 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
57075 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
57078 Collection of SR-IOV Virtual Functions.
57083 $ref: "#/patchDefinitions/sriov-vf"
57092 ###### Related Nodes
57093 - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
57094 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
57095 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
57096 - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
57103 description: Subnet ID, should be UUID.
57106 description: Name associated with the subnet.
57109 description: Neutron id of this subnet
57112 description: gateway ip address
57113 network-start-address:
57115 description: network start address
57118 description: cidr mask
57121 description: ip version
57122 orchestration-status:
57124 description: Orchestration status of this VNF, mastered by MSO
57129 description: the start address reserved for use by dhcp
57132 description: the last address reserved for use by dhcp
57138 $ref: "#/patchDefinitions/subnet"
57139 tagged-inventory-item-list:
57144 $ref: "#/patchDefinitions/inventory-item"
57148 ###### Related Nodes
57149 - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57150 - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
57151 - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
57152 - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
57153 - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
57154 - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
57155 - TENANT cannot be deleted if linked to VSERVER
57162 description: Unique id relative to the cloud-region.
57165 description: Readable name of tenant
57168 Collection of openstack tenants.
57173 $ref: "#/patchDefinitions/tenant"
57176 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
57177 ###### Related Nodes
57178 - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
57181 - bandwidth-up-wan1
57182 - bandwidth-down-wan1
57183 - bandwidth-up-wan2
57184 - bandwidth-down-wan2
57188 description: Allotted Resource id UUID assigned to this instance.
57191 description: The WAN uplink bandwidth for WAN1
57192 bandwidth-down-wan1:
57194 description: The WAN downlink bandwidth for WAN1
57197 description: The WAN uplink bandwidth for WAN2
57198 bandwidth-down-wan2:
57200 description: The WAN downlink bandwidth for WAN2
57203 This object is used to store the specific tunnel cross connect aspects of an allotted resource
57208 $ref: "#/patchDefinitions/tunnel-xconnect"
57211 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
57220 $ref: "#/patchDefinitions/update-node-key"
57226 $ref: "#/patchDefinitions/action"
57235 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
57236 ###### Related Nodes
57237 - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
57238 - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
57239 - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
57240 - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
57241 - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
57242 - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
57243 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
57244 - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
57252 description: Unique id of VNF. This is unique across the graph.
57255 description: Name of VNF.
57258 description: Alternate name of VNF.
57261 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.
57264 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
57265 regional-resource-zone:
57267 description: Regional way of organizing pservers, source of truth should define values
57270 description: Trigger for operational monitoring of this resource by Service Assurance systems.
57271 operational-status:
57273 description: Indicator for whether the resource is considered operational
57276 description: OBSOLETE - do not use
57279 description: Network role being played by this VNF
57280 orchestration-status:
57282 description: Orchestration status of this VNF, mastered by MSO
57285 description: Heat stack id corresponding to this instance, managed by MSO
57288 description: Corresponds to the SDN-C catalog id used to configure this VCE
57291 description: Unique ID of VPE connected to this VCE.
57292 v6-vce-wan-address:
57294 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
57297 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
57300 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
57305 $ref: "#/patchDefinitions/vce"
57308 a deployment unit of VNFCs
57309 ###### Related Nodes
57310 - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
57311 - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
57312 - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
57313 - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
57314 - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
57315 - VF-MODULE cannot be deleted if linked to VNFC
57318 - is-base-vf-module
57322 description: Unique ID of vf-module.
57325 description: Name of vf-module
57328 description: Heat stack id corresponding to this instance.
57329 orchestration-status:
57331 description: orchestration status of this vf-module, mastered by MSO
57336 Collection of vf-modules, a deployment unit of VNFCs
57341 $ref: "#/patchDefinitions/vf-module"
57344 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
57345 ###### Related Nodes
57346 - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
57352 description: indicates whether the VIG is for AVPN or INTERNET
57355 description: v4 IP of the vig server
57358 description: v6 IP of the vig server
57364 $ref: "#/patchDefinitions/vig-server"
57365 vip-ipv4-address-list:
57368 ###### Related Nodes
57369 - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57370 - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
57371 - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
57372 - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
57378 description: IP address
57379 vip-ipv4-prefix-length:
57382 description: Prefix length, 32 for single address
57386 description: Inner VLAN tag
57390 description: Outer VLAN tag
57393 description: Indicator of fixed or floating address
57394 vip-ipv6-address-list:
57397 ###### Related Nodes
57398 - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57399 - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
57400 - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
57401 - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
57407 description: IP address
57408 vip-ipv6-prefix-length:
57411 description: Prefix length, 128 for single address
57415 description: Inner VLAN tag
57419 description: Outer VLAN tag
57422 description: Indicator of fixed or floating address
57423 virtual-data-center:
57425 Virtual organization of cloud infrastructure elements in a data center context
57426 ###### Related Nodes
57427 - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
57428 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
57429 - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
57436 description: Unique ID of the vdc
57439 description: Name of the virtual data center
57440 virtual-data-centers:
57442 Virtual organization of cloud infrastructure elements in a data center context
57444 virtual-data-center:
57447 $ref: "#/patchDefinitions/virtual-data-center"
57451 ###### Related Nodes
57452 - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
57453 - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
57454 - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
57455 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
57456 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
57457 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
57458 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
57459 - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
57460 - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
57467 description: String that identifies the interface
57471 description: Inner VLAN tag
57475 description: Outer VLAN tag
57481 $ref: "#/patchDefinitions/vlan"
57490 description: Unique id of VNF. This is unique across the graph.
57493 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
57494 ###### Related Nodes
57495 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
57496 - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
57500 - application-vendor
57504 description: Unique ID of this asset
57507 description: The application that the image instantiates.
57508 application-vendor:
57510 description: The vendor of the application.
57511 application-version:
57513 description: The version of the application.
57516 description: URL to endpoint where AAI can get more details
57519 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
57524 $ref: "#/patchDefinitions/vnf-image"
57527 ###### Related Nodes
57528 - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
57529 - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
57530 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
57533 - vnfc-function-code
57536 - is-closed-loop-disabled
57540 description: Unique ID of vnfc.
57541 vnfc-function-code:
57543 description: function code
57549 description: prov status of this vnfc
57550 orchestration-status:
57552 description: Orchestration status of this VNF, mastered by APP-C
57553 ipaddress-v4-oam-vip:
57555 description: Oam V4 vip address of this vnfc
57558 is-closed-loop-disabled:
57562 description: Group notation of VNFC
57565 virtual network components associated with a vserver from application controller.
57570 $ref: "#/patchDefinitions/vnfc"
57573 Ephemeral Block storage volume.
57574 ###### Related Nodes
57575 - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
57582 description: Unique ID of block storage volume relative to the vserver.
57585 description: URL to endpoint where AAI can get more details
57588 Persistent block-level storage.
57589 ###### Related Nodes
57590 - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57591 - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57592 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
57593 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
57594 - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
57597 - volume-group-name
57602 description: Unique ID of volume-group.
57605 description: Name of the volume group.
57608 description: Heat stack id corresponding to this volume-group
57611 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.
57612 orchestration-status:
57614 description: Orchestration status of this volume-group
57615 model-customization-id:
57617 description: captures the id of all the configuration used to customize the resource for the service.
57618 vf-module-model-customization-id:
57620 description: helps relate the volume group to the vf-module whose components will require the volume group
57623 Collection of persistent block-level storage.
57628 $ref: "#/patchDefinitions/volume-group"
57631 Collection of ephemeral Block storage volumes.
57636 $ref: "#/patchDefinitions/volume"
57639 VPLS Provider Edge routers.
57640 ###### Related Nodes
57641 - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57642 - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
57643 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
57644 - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
57645 - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
57653 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
57656 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
57659 description: Client should send valid enumerated value, e.g., VPLS-PE.
57663 description: Temporary location for stag to get to VCE
57666 Collection of VPLS Provider Edge routers
57671 $ref: "#/patchDefinitions/vpls-pe"
57675 ###### Related Nodes
57676 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
57677 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
57678 - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
57679 - VPN-BINDING cannot be deleted if linked to L3-NETWORK,LOGICAL-LINK
57680 - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
57687 description: VPN ID, globally unique within A&AI
57690 description: VPN Name
57693 description: the platform associated with the VPN example AVPN, Mobility
57696 description: Type of the vpn, should be taken from enumerated/valid values
57697 route-distinguisher:
57699 description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
57705 $ref: "#/patchDefinitions/vpn-binding"
57708 Virtual Servers, aka virtual machine or VM.
57709 ###### Related Nodes
57710 - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
57711 - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
57712 - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
57713 - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
57714 - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
57715 - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
57716 - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
57717 - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
57718 - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
57719 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
57720 - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
57721 - VSERVER is DELETED when these are DELETED L-INTERFACE
57722 - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
57728 - is-closed-loop-disabled
57732 description: Unique identifier for this vserver relative to its tenant
57735 description: Name of vserver
57738 description: Alternative name of vserver
57741 description: Trigger for operational monitoring of this resource by Service Assurance systems.
57744 description: URL to endpoint where AAI can get more details
57747 is-closed-loop-disabled:
57751 Collection of virtual Servers, aka virtual machines or VMs.
57756 $ref: "#/patchDefinitions/vserver"
57759 A zone is a grouping of assets in a location homing to the same connections into the CBB
57760 ###### Related Nodes
57761 - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57762 - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
57763 - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
57764 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
57773 description: Code assigned by AIC to the zone
57776 description: English name associated with the zone
57779 description: Design of zone [Medium/Large?]
57782 description: Context of zone [production/test]
57785 description: Status of a zone.
57788 Collection of zones
57793 $ref: "#/patchDefinitions/zone"
57808 $ref: "#/getDefinitions/action-data"
57817 APIs that are more action related than REST (e.g., notify, update).
57821 $ref: "#/getDefinitions/update"
57824 $ref: "#/getDefinitions/notify"
57827 Represents a slice or partial piece of a resource that gets separately allotted
57828 ###### Related Nodes
57829 - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
57830 - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
57831 - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
57832 - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
57833 - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
57834 - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
57835 - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
57836 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
57837 - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
57843 description: Allotted Resource id UUID assigned to this instance.
57846 description: The descriptive information assigned to this allotted resource instance
57849 description: Link back to more information in the controller
57850 model-invariant-id:
57852 description: the ASDC model id for this resource or service model.
57855 description: the ASDC model version for this resource or service model.
57856 persona-model-version:
57858 description: the ASDC model version for this resource or service model.
57861 description: Concurrency value
57862 orchestration-status:
57864 description: Orchestration status
57865 operational-status:
57867 description: Indicator for whether the resource is considered operational
57870 description: Generic description of the type of allotted resource.
57873 description: role in the network that this resource will be providing.
57877 $ref: "#/getDefinitions/tunnel-xconnect"
57881 $ref: "#/getDefinitions/relationship"
57882 allotted-resources:
57884 This object is used to store slices of services being offered
57889 $ref: "#/getDefinitions/allotted-resource"
57892 Availability zone, a collection of compute hosts/pservers
57893 ###### Related Nodes
57894 - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57895 - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
57896 - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57897 - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
57898 - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
57899 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
57900 - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
57901 - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
57902 - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
57904 - availability-zone-name
57907 availability-zone-name:
57909 description: Name of the availability zone. Unique across a cloud region
57912 description: Type of hypervisor. Source of truth should define valid values.
57913 operational-status:
57915 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
57918 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57922 $ref: "#/getDefinitions/relationship"
57923 availability-zones:
57925 Collection of availability zones
57930 $ref: "#/getDefinitions/availability-zone"
57931 az-and-dvs-switches:
57935 $ref: "#/getDefinitions/dvs-switches"
57938 $ref: "#/getDefinitions/availability-zone"
57941 Namespace for business related constructs
57946 $ref: "#/getDefinitions/connector"
57950 $ref: "#/getDefinitions/customer"
57953 ###### Related Nodes
57954 - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
57960 description: unique identifier of probe
57963 description: identifier of probe
57966 description: type of probe
57969 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57973 $ref: "#/getDefinitions/relationship"
57974 classes-of-service:
57976 class-of-service of probe
57981 $ref: "#/getDefinitions/class-of-service"
57982 cloud-infrastructure:
57984 Namespace for cloud infrastructure.
57989 $ref: "#/getDefinitions/complex"
57993 $ref: "#/getDefinitions/cloud-region"
57997 $ref: "#/getDefinitions/network-profile"
58001 $ref: "#/getDefinitions/pserver"
58002 virtual-data-centers:
58005 $ref: "#/getDefinitions/virtual-data-center"
58008 cloud-region designates an installation of a cloud cluster or region or instantiation
58009 ###### Related Nodes
58010 - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58011 - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
58012 - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
58013 - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58014 - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58015 - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58016 - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58017 - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58018 - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58019 - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58020 - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58021 - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58022 - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
58023 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
58024 - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
58025 - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
58032 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
58035 description: Identifier used by the vendor for the region. Second part of composite key
58038 description: Type of the cloud (e.g., openstack)
58039 owner-defined-type:
58041 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
58042 cloud-region-version:
58044 description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
58047 description: URL of the keystone identity service
58050 description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
58053 description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
58056 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58060 $ref: "#/getDefinitions/volume-group"
58064 $ref: "#/getDefinitions/tenant"
58068 $ref: "#/getDefinitions/flavor"
58072 $ref: "#/getDefinitions/group-assignment"
58076 $ref: "#/getDefinitions/snapshot"
58080 $ref: "#/getDefinitions/image"
58084 $ref: "#/getDefinitions/dvs-switch"
58088 $ref: "#/getDefinitions/oam-network"
58089 availability-zones:
58092 $ref: "#/getDefinitions/availability-zone"
58096 $ref: "#/getDefinitions/relationship"
58102 $ref: "#/getDefinitions/cloud-region"
58105 Collection of physical locations that can house cloud-regions.
58106 ###### Related Nodes
58107 - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
58108 - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58109 - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58110 - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
58111 - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
58112 - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58113 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58114 - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
58115 - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58116 - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58117 - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58118 - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
58119 - COMPLEX is DELETED when these are DELETED CTAG-POOL
58121 - physical-location-id
58122 - physical-location-type
58129 physical-location-id:
58131 description: Unique identifier for physical location, e.g., CLLI
58134 description: Data center code which can be an alternate way to identify a complex
58137 description: Gamma complex name for LCP instance.
58140 description: URL of the keystone identity service
58143 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58144 physical-location-type:
58146 description: Type, e.g., central office, data center.
58172 $ref: "#/getDefinitions/ctag-pool"
58176 $ref: "#/getDefinitions/relationship"
58179 Collection of physical locations that can house cloud-regions.
58184 $ref: "#/getDefinitions/complex"
58187 Port Mirror Configuration.
58188 ###### Related Nodes
58189 - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
58190 - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
58191 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
58192 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
58193 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
58194 - CONFIGURATION is DELETED when these are DELETED METADATUM
58195 - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
58198 - configuration-type
58199 - configuration-sub-type
58200 - orchestration-status
58201 - operational-status
58202 - configuration-selflink
58203 - model-customization-id
58207 description: UUID assigned to configuration.
58210 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
58211 configuration-name:
58213 description: Name of the configuration.
58214 configuration-type:
58216 description: port-mirroring-configuration.
58217 configuration-sub-type:
58219 description: vprobe, pprobe.
58220 model-invariant-id:
58222 description: the ASDC model id for this resource or service model.
58225 description: the ASDC model version for this resource or service model.
58226 orchestration-status:
58228 description: Orchestration status of the configuration.
58229 operational-status:
58231 description: Indicator for whether the resource is considered operational.
58232 configuration-selflink:
58234 description: URL to endpoint where AAI can get more details from SDN-GC.
58235 model-customization-id:
58237 description: id of the configuration used to customize the resource
58240 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58244 $ref: "#/getDefinitions/relationship"
58248 $ref: "#/getDefinitions/metadatum"
58251 Collection of configurations
58256 $ref: "#/getDefinitions/configuration"
58259 Collection of resource instances used to connect a variety of disparate inventory widgets
58260 ###### Related Nodes
58261 - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
58262 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
58263 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
58264 - CONNECTOR is DELETED when these are DELETED METADATUM
58266 - resource-instance-id
58268 resource-instance-id:
58270 description: Unique id of resource instance.
58273 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58274 model-invariant-id:
58276 description: the ASDC model id for this resource or service model.
58279 description: the ASDC model version for this resource or service model.
58280 persona-model-version:
58282 description: the ASDC model version for this resource or service model.
58285 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
58286 widget-model-version:
58288 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
58292 $ref: "#/getDefinitions/relationship"
58296 $ref: "#/getDefinitions/metadatum"
58299 Collection of resource instances used to connect a variety of disparate inventory widgets
58304 $ref: "#/getDefinitions/connector"
58305 constrained-element-set:
58307 This is how we would capture constraints defining allowed sets of elements.
58308 ###### Related Nodes
58309 - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
58310 - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
58311 - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
58312 - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
58314 - constrained-element-set-uuid
58318 constrained-element-set-uuid:
58326 element-choice-sets:
58329 $ref: "#/getDefinitions/element-choice-set"
58333 $ref: "#/getDefinitions/relationship"
58334 constrained-element-sets:
58336 constrained-element-set:
58339 $ref: "#/getDefinitions/constrained-element-set"
58342 ###### Related Nodes
58343 - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
58344 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
58354 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58358 $ref: "#/getDefinitions/relationship"
58364 $ref: "#/getDefinitions/ctag-assignment"
58367 A collection of C tags (vlan tags) grouped for a specific purpose.
58368 ###### Related Nodes
58369 - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
58370 - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
58371 - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
58374 - availability-zone-name
58375 - ctag-pool-purpose
58379 description: The Target provider edge router
58380 availability-zone-name:
58382 description: Name of the availability zone
58385 description: Describes what the intended purpose of this pool is.
58388 description: Comma separated list of ctags
58391 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58395 $ref: "#/getDefinitions/relationship"
58401 $ref: "#/getDefinitions/ctag-pool"
58404 customer identifiers to provide linkage back to BSS information.
58405 ###### Related Nodes
58406 - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
58407 - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
58409 - global-customer-id
58413 global-customer-id:
58415 description: Global customer id used across ECOMP to uniquely identify customer.
58418 description: Subscriber name, an alternate way to retrieve a customer.
58421 description: Subscriber type, a way to provide VID with only the INFRA customers.
58424 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58425 service-subscriptions:
58428 $ref: "#/getDefinitions/service-subscription"
58432 $ref: "#/getDefinitions/relationship"
58435 Collection of customer identifiers to provide linkage back to BSS information.
58440 $ref: "#/getDefinitions/customer"
58448 description: See mis-na-virtualization-platform.yang
58451 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58455 $ref: "#/getDefinitions/relationship"
58461 $ref: "#/getDefinitions/cvlan-tag-entry"
58464 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.
58465 ###### Related Nodes
58466 - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58467 - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
58474 description: DVS switch name
58477 description: URL used to reach the vcenter
58480 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58484 $ref: "#/getDefinitions/relationship"
58487 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
58492 $ref: "#/getDefinitions/dvs-switch"
58495 Internal map to define the properties of an edge and interpret the map EdgeRules
58513 edge-tag-query-request:
58524 $ref: "#/getDefinitions/start-node-filter"
58525 include-node-filter:
58528 $ref: "#/getDefinitions/include-node-filter"
58532 $ref: "#/getDefinitions/secondary-filter"
58533 edge-tag-query-result:
58535 tagged-inventory-item-list:
58538 $ref: "#/getDefinitions/tagged-inventory-item-list"
58539 element-choice-set:
58541 This is how we would capture constraints defining allowed sets of elements.
58542 ###### Related Nodes
58543 - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
58544 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
58545 - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
58547 - element-choice-set-uuid
58548 - element-choice-set-name
58550 element-choice-set-uuid:
58552 element-choice-set-name:
58561 $ref: "#/getDefinitions/model-element"
58565 $ref: "#/getDefinitions/relationship"
58566 element-choice-sets:
58568 element-choice-set:
58571 $ref: "#/getDefinitions/element-choice-set"
58574 Metadata for entitlement group.
58575 ###### Related Nodes
58576 - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58577 - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
58584 description: Unique ID for the entitlement group the resource comes from, should be uuid.
58587 description: Unique ID of an entitlement resource.
58590 description: Concurrency value
58594 $ref: "#/getDefinitions/relationship"
58597 Entitlements, keyed by group-uuid and resource-uuid, related to license management
58602 $ref: "#/getDefinitions/entitlement"
58605 Persist EMS address information used by EMS driver.
58606 ###### Related Nodes
58607 - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
58608 - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
58614 description: Unique ID of EMS.
58617 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58618 esr-system-info-list:
58620 $ref: "#/getDefinitions/esr-system-info-list"
58623 $ref: "#/getDefinitions/relationship-list"
58629 $ref: "#/getDefinitions/esr-ems"
58632 Persist common address information of external systems.
58633 ###### Related Nodes
58634 - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
58635 - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
58636 - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
58637 - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
58639 - esr-system-info-id
58644 esr-system-info-id:
58646 description: Unique ID of esr system info.
58649 description: name of external system.
58652 description: type of external systems.
58655 description: vendor of external systems.
58658 description: version of external systems.
58661 description: url used to access external systems.
58664 description: username used to access external systems.
58667 description: password used to access external systems.
58670 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
58673 description: protocol of third party SDNC, for example netconf/snmp.
58676 description: ca file content if enabled ssl on auth-url.
58679 description: Whether to verify VIM's certificate.
58682 description: service IP of ftp server.
58685 description: service port of ftp server.
58688 description: domain info for authentication.
58691 description: default tenant of VIM.
58694 description: ftp passive mode or not.
58697 description: resource or performance data file path.
58700 description: the status of external system.
58703 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58707 $ref: "#/getDefinitions/relationship"
58708 esr-system-info-list:
58710 Collection of persistent block-level external system auth info.
58715 $ref: "#/getDefinitions/esr-system-info"
58716 esr-thirdparty-sdnc:
58718 Persist SDNC address information used by ONAP SDNC.
58719 ###### Related Nodes
58720 - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
58721 - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
58722 - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
58724 - thirdparty-sdnc-id
58726 thirdparty-sdnc-id:
58728 description: Unique ID of SDNC.
58731 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
58734 description: password used to access SDNC server.
58737 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58738 esr-system-info-list:
58740 $ref: "#/getDefinitions/esr-system-info-list"
58743 $ref: "#/getDefinitions/relationship-list"
58744 esr-thirdparty-sdnc-list:
58746 esr-thirdparty-sdnc:
58749 $ref: "#/getDefinitions/esr-thirdparty-sdnc"
58752 Persist VNFM address information used by VF-C.
58753 ###### Related Nodes
58754 - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
58755 - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
58761 description: Unique ID of VNFM.
58764 description: indecate the VIM to deploy VNF.
58767 description: certificate url of VNFM.
58770 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58771 esr-system-info-list:
58773 $ref: "#/getDefinitions/esr-system-info-list"
58776 $ref: "#/getDefinitions/relationship-list"
58782 $ref: "#/getDefinitions/esr-vnfm"
58785 evc object is an optional child object of the Configuration object.
58786 ###### Related Nodes
58787 - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
58793 description: Unique/key field for the evc object
58794 forwarding-path-topology:
58796 description: Point-to-Point, Multi-Point
58799 description: Commited Information Rate
58802 description: CIR units
58803 connection-diversity-group-id:
58805 description: Diversity Group ID
58808 description: formerly Performance Group
58809 esp-evc-circuit-id:
58811 description: EVC Circuit ID of ESP EVC
58814 description: Committed Information Rate (For ESP)
58817 description: CIR units (For ESP)
58820 description: Identifies ESP
58821 collector-pop-clli:
58823 description: Collector POP CLLI (from the hostname of the access pnf)
58824 inter-connect-type-ingress:
58826 description: Interconnect type on ingress side of EVC.
58827 tagmode-access-ingress:
58829 description: tagode for collector side of EVC
58830 tagmode-access-egress:
58832 description: tagMode for network side of EVC
58836 $ref: "#/getDefinitions/relationship"
58839 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58845 $ref: "#/getDefinitions/evc"
58848 Namespace for external system.
58852 $ref: "#/getDefinitions/esr-ems-list"
58855 $ref: "#/getDefinitions/esr-vnfm-list"
58856 esr-thirdparty-sdnc-list:
58858 $ref: "#/getDefinitions/esr-thirdparty-sdnc-list"
58861 Extra properties for inventory item for response list
58866 $ref: "#/getDefinitions/extra-property"
58876 ###### Related Nodes
58877 - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58878 - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
58879 - FLAVOR cannot be deleted if linked to VSERVER
58887 description: Flavor id, expected to be unique across cloud-region.
58890 description: Flavor name
58894 description: Number of CPUs
58898 description: Amount of memory
58902 description: Disk space
58906 description: Amount of ephemeral disk space
58909 description: amount of swap space allocation
58912 description: whether flavor is available to all users or private to the tenant it was created in.
58915 description: URL to endpoint where AAI can get more details
58918 description: Boolean as to whether this flavor is no longer enabled
58921 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58925 $ref: "#/getDefinitions/relationship"
58928 Collection of openstack flavors.
58933 $ref: "#/getDefinitions/flavor"
58936 Entity describing a sequenced segment of forwarding path
58937 ###### Related Nodes
58938 - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
58939 - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
58940 - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
58941 - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
58942 - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
58943 - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
58950 description: Unique ID of this segmentation
58953 description: ingress, intermediate, egress
58957 $ref: "#/getDefinitions/relationship"
58960 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58963 forwarder object is an optional child object of the Configuration object.
58964 ###### Related Nodes
58965 - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
58971 description: Key for forwarder-evc object
58974 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
58977 description: Internal VLAN.
58980 description: SVLAN value for ingress of egress forwarder.
58983 description: CVLAN value for ingress of egress forwarder.
58987 $ref: "#/getDefinitions/relationship"
58990 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58996 $ref: "#/getDefinitions/forwarder-evc"
59002 $ref: "#/getDefinitions/forwarder"
59005 Entity that describes the sequenced forwarding path between interfaces of services or resources
59006 ###### Related Nodes
59007 - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
59008 - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
59009 - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
59010 - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
59011 - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
59013 - forwarding-path-id
59014 - forwarding-path-name
59016 forwarding-path-id:
59018 description: Unique ID of this FP
59019 forwarding-path-name:
59021 description: Name of the FP
59025 $ref: "#/getDefinitions/relationship"
59028 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59031 description: the self link for this FP
59035 $ref: "#/getDefinitions/forwarder"
59041 $ref: "#/getDefinitions/forwarding-path"
59044 General purpose VNF
59045 ###### Related Nodes
59046 - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
59047 - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59048 - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
59049 - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
59050 - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
59051 - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
59052 - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
59053 - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
59054 - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
59055 - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
59056 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
59057 - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59058 - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59059 - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59060 - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59061 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59062 - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
59063 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
59064 - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
59065 - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59066 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
59067 - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
59073 - is-closed-loop-disabled
59077 description: Unique id of VNF. This is unique across the graph.
59080 description: Name of VNF.
59083 description: Alternate name of VNF.
59086 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.
59089 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
59090 regional-resource-zone:
59092 description: Regional way of organizing pservers, source of truth should define values
59095 description: Trigger for operational monitoring of this resource by Service Assurance systems.
59096 operational-status:
59098 description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
59101 description: OBSOLETE - do not use
59104 description: Client should send valid enumerated value
59105 orchestration-status:
59107 description: Orchestration status of this VNF, used by MSO.
59110 description: Heat stack id corresponding to this instance, managed by MSO
59113 description: Corresponds to the SDN-C catalog id used to configure this VCE
59116 description: identifier of managed by company or customer
59119 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
59120 ipv4-loopback0-address:
59122 description: v4 Loopback0 address
59125 description: v6 Loopback address
59126 management-v6-address:
59128 description: v6 management address
59132 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
59135 description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only in some usecases
59139 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
59142 description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only in some usecases
59146 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
59149 description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases
59152 is-closed-loop-disabled:
59156 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59159 description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
59160 encrypted-access-flag:
59162 description: indicates whether generic-vnf access uses SSH
59163 entitlement-assignment-group-uuid:
59165 description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships.
59166 entitlement-resource-uuid:
59168 description: UUID of the specific entitlement resource. OBSOLETE - See child relationships.
59169 license-assignment-group-uuid:
59171 description: UUID of the license assignment group. OBSOLETE - See child relationships.
59174 description: UUID of the actual license resource. OBSOLETE - See child relationships.
59175 model-invariant-id:
59177 description: the ASDC model id for this resource or service model.
59180 description: the ASDC model version for this resource or service model.
59181 persona-model-version:
59183 description: the ASDC model version for this resource or service model.
59184 model-customization-id:
59186 description: captures the id of all the configuration used to customize the resource for the service.
59189 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
59190 widget-model-version:
59192 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
59195 description: as-number of the VNF
59196 regional-resource-subzone:
59198 description: represents sub zone of the rr plane
59201 description: Generic description of the type of NF
59204 description: English description of Network function that the specific VNF deployment is providing
59207 description: role in the network that this model will be providing
59210 description: string assigned to this model used for naming purposes
59213 description: Path to the controller object.
59217 $ref: "#/getDefinitions/relationship"
59221 $ref: "#/getDefinitions/l-interface"
59225 $ref: "#/getDefinitions/lag-interface"
59229 $ref: "#/getDefinitions/vf-module"
59233 $ref: "#/getDefinitions/license"
59237 $ref: "#/getDefinitions/entitlement"
59245 $ref: "#/getDefinitions/generic-vnf"
59248 Openstack group-assignment used to store exclusivity groups (EG).
59249 ###### Related Nodes
59250 - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59251 - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
59252 - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
59260 description: Group id, expected to be unique across cloud-region.
59263 description: Group type - the type of group this instance refers to
59266 description: Group name - name assigned to the group
59269 description: Group description - description of the group
59272 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59276 $ref: "#/getDefinitions/relationship"
59279 Collection of openstack group assignments
59284 $ref: "#/getDefinitions/group-assignment"
59287 ###### Related Nodes
59288 - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
59296 description: host-route id
59299 description: subnet prefix
59302 description: Could be ip-address, hostname, or service-instance
59305 description: Should be ip-address, hostname, or service-instance to match next-hop
59308 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59312 $ref: "#/getDefinitions/relationship"
59318 $ref: "#/getDefinitions/host-route"
59321 Collection of HPA Capabilities
59326 $ref: "#/getDefinitions/hpa-capability"
59329 Represents a HPA capability
59330 ###### Related Nodes
59331 - TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
59332 - TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59333 - FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
59334 - HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES
59336 - hpa-capability-id
59341 description: UUID to uniquely identify a HPA capability
59344 description: Name of the HPACapability
59347 description: HPA schema version
59350 description: Hardware architecture
59353 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59357 $ref: "#/getDefinitions/relationship"
59358 hpa-feature-attributes:
59361 $ref: "#/getDefinitions/hpa-feature-attributes"
59362 hpa-feature-attributes:
59364 HPA Capability Feature attributes
59365 ###### Related Nodes
59366 - TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
59370 description: name of the specific HPA attribute
59373 description: JSON string specifying the value, unit and type of the specific HPA attribute
59376 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59380 $ref: "#/getDefinitions/relationship"
59384 ###### Related Nodes
59385 - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59386 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
59387 - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
59388 - IMAGE cannot be deleted if linked to VSERVER
59389 - IMAGE is DELETED when these are DELETED METADATUM
59399 description: Image id, expected to be unique across cloud region
59402 description: Image name
59403 image-architecture:
59405 description: Operating system architecture.
59408 description: The common name of the operating system distribution in lowercase
59411 description: The operating system version as specified by the distributor.
59414 description: The application that the image instantiates.
59415 application-vendor:
59417 description: The vendor of the application.
59418 application-version:
59420 description: The version of the application.
59423 description: URL to endpoint where AAI can get more details
59426 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59430 $ref: "#/getDefinitions/relationship"
59434 $ref: "#/getDefinitions/metadatum"
59437 Collectio of Openstack images.
59442 $ref: "#/getDefinitions/image"
59443 include-node-filter:
59449 InstanceFilter for performing a named-query or model query
59452 InstanceFilters for performing a named-query or model query
59457 $ref: "#/getDefinitions/instance-filter"
59460 General mechanism for grouping instances
59461 ###### Related Nodes
59462 - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
59463 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59464 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59465 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
59466 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
59467 - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59468 - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59469 - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59477 description: Instance Group ID, UUID assigned to this instance.
59480 description: Descriptive text to help identify the usage of this instance-group
59483 description: Only valid value today is lower case ha for high availability
59486 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
59489 description: Concurrency value
59493 $ref: "#/getDefinitions/relationship"
59496 Collection of openstack route table references
59501 $ref: "#/getDefinitions/instance-group"
59506 $ref: "#/getDefinitions/search"
59509 $ref: "#/getDefinitions/actions"
59510 cloud-infrastructure:
59512 $ref: "#/getDefinitions/cloud-infrastructure"
59515 $ref: "#/getDefinitions/business"
59516 service-design-and-creation:
59518 $ref: "#/getDefinitions/service-design-and-creation"
59521 $ref: "#/getDefinitions/network"
59524 $ref: "#/getDefinitions/aai-internal"
59528 $ref: "#/getDefinitions/aai-internal"
59531 inventory-item-type:
59533 inventory-item-link:
59535 inventory-item-data:
59538 $ref: "#/getDefinitions/inventory-item-data"
59539 tagged-inventory-item-list:
59542 $ref: "#/getDefinitions/tagged-inventory-item-list"
59543 inventory-item-data:
59549 inventory-response-item:
59551 Inventory item for response list
59557 $ref: "#/getDefinitions/extra-properties"
59558 inventory-response-items:
59560 $ref: "#/getDefinitions/inventory-response-items"
59561 inventory-response-items:
59563 Container for inventory items in response list
59565 inventory-response-item:
59568 $ref: "#/getDefinitions/inventory-response-item"
59569 ipsec-configuration:
59571 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
59572 ###### Related Nodes
59573 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
59574 - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
59575 - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
59577 - ipsec-configuration-id
59579 ipsec-configuration-id:
59581 description: UUID of this configuration
59582 requested-vig-address-type:
59584 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
59585 requested-encryption-strength:
59587 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
59588 requested-dmz-type:
59590 description: can offer a shared DMZ or a DMZ specific to a customer
59591 shared-dmz-network-address:
59593 description: Network address of shared DMZ
59594 requested-customer-name:
59596 description: If the DMZ is a custom DMZ, this field will indicate the customer information
59599 description: can be 1 or 2
59600 ikev1-authentication:
59602 description: Contains values like md5, sha1, sha256, sha384
59605 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
59608 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
59611 description: Group name defined in VIG for clients using aggressive mode
59614 description: pre-shared key for the above group name
59617 description: Lifetime for IKEv1 SA
59618 ipsec-authentication:
59620 description: md5, sha1, sha256, sha384
59623 description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
59626 description: Life time for IPSec SA
59629 description: enable PFS or not
59632 description: user ID for xAuth, sm-user, ,nmteHostName
59633 xauth-user-password:
59635 description: Encrypted using the Juniper $9$ algorithm
59638 description: The time between DPD probe
59641 description: Maximum number of DPD before claiming the tunnel is down
59644 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59648 $ref: "#/getDefinitions/relationship"
59652 $ref: "#/getDefinitions/vig-server"
59653 ipsec-configurations:
59655 ipsec-configuration:
59658 $ref: "#/getDefinitions/ipsec-configuration"
59667 Logical interfaces, e.g., a vnic.
59668 ###### Related Nodes
59669 - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59670 - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
59671 - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59672 - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
59673 - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
59674 - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
59675 - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
59676 - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
59677 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
59678 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
59679 - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
59680 - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
59681 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
59682 - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
59683 - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
59691 description: Name given to the interface
59694 description: E.g., CUSTOMER, UPLINK, etc.
59697 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
59700 description: URL to endpoint where AAI can get more details
59703 description: ID of interface
59706 description: MAC address for the interface
59709 description: Name of the network
59712 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
59713 interface-description:
59715 description: Human friendly text regarding this interface.
59720 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59726 $ref: "#/getDefinitions/vlan"
59730 $ref: "#/getDefinitions/sriov-vf"
59734 $ref: "#/getDefinitions/l-interface"
59738 $ref: "#/getDefinitions/relationship"
59739 l3-interface-ipv4-address-list:
59742 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
59743 l3-interface-ipv6-address-list:
59746 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
59749 Collection of logical interfaces.
59754 $ref: "#/getDefinitions/l-interface"
59755 l3-interface-ipv4-address-list:
59758 ###### Related Nodes
59759 - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
59760 - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
59761 - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
59762 - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
59763 - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
59765 - l3-interface-ipv4-address
59767 l3-interface-ipv4-address:
59769 description: IP address
59770 l3-interface-ipv4-prefix-length:
59773 description: Prefix length, 32 for single address
59777 description: Inner VLAN tag
59781 description: Outer VLAN tag
59784 description: Indicator of fixed or floating address
59787 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59788 neutron-network-id:
59790 description: Neutron network id of the interface that address belongs to
59793 description: Neutron id of subnet that address belongs to
59797 $ref: "#/getDefinitions/relationship"
59798 l3-interface-ipv6-address-list:
59801 ###### Related Nodes
59802 - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
59803 - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
59804 - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
59805 - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
59806 - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
59808 - l3-interface-ipv6-address
59810 l3-interface-ipv6-address:
59812 description: IP address
59813 l3-interface-ipv6-prefix-length:
59816 description: Prefix length, 128 for single address
59820 description: Inner VLAN tag
59824 description: Outer VLAN tag
59827 description: Indicator of fixed or floating address
59830 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59831 neutron-network-id:
59833 description: Neutron network id of the interface that address belongs to
59836 description: Neutron id of subnet that address belongs to
59840 $ref: "#/getDefinitions/relationship"
59843 Generic network definition
59844 ###### Related Nodes
59845 - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
59846 - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
59847 - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
59848 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
59849 - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
59850 - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
59851 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
59852 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
59853 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
59854 - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
59855 - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
59856 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
59857 - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
59858 - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
59859 - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
59860 - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
59865 - is-provider-network
59866 - is-shared-network
59867 - is-external-network
59871 description: Network ID, should be uuid. Unique across A&AI.
59874 description: Name of the network, governed by some naming convention..
59877 description: Type of the network - who defines these values?
59880 description: Role the network plans - who defines these values?
59881 network-technology:
59883 description: Network technology - who defines these values?
59884 neutron-network-id:
59886 description: Neutron network id of this Interface
59891 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
59892 network-role-instance:
59895 description: network role instance
59898 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59899 orchestration-status:
59901 description: Orchestration status of this VNF, mastered by MSO
59904 description: Heat stack id corresponding to this instance, managed by MSO
59907 description: Corresponds to the SDN-C catalog id used to configure this VCE
59908 contrail-network-fqdn:
59910 description: Contrail FQDN for the network
59911 model-invariant-id:
59913 description: the ASDC model id for this resource or service model.
59916 description: the ASDC model version for this resource or service model.
59917 persona-model-version:
59919 description: the ASDC model version for this resource or service model.
59920 model-customization-id:
59922 description: captures the id of all the configuration used to customize the resource for the service.
59925 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
59926 widget-model-version:
59928 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
59929 physical-network-name:
59931 description: Name associated with the physical network.
59932 is-provider-network:
59936 is-external-network:
59940 description: Path to the controller object.
59941 operational-status:
59943 description: Indicator for whether the resource is considered operational.
59947 $ref: "#/getDefinitions/subnet"
59951 $ref: "#/getDefinitions/ctag-assignment"
59952 segmentation-assignments:
59955 $ref: "#/getDefinitions/segmentation-assignment"
59959 $ref: "#/getDefinitions/relationship"
59960 description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
59966 $ref: "#/getDefinitions/l3-network"
59969 Link aggregate interface
59970 ###### Related Nodes
59971 - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59972 - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
59973 - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
59974 - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
59975 - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
59976 - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
59977 - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
59978 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
59979 - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
59980 - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
59987 description: Name that identifies the link aggregate interface
59988 interface-description:
59990 description: Human friendly text regarding this interface.
59993 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59996 description: Captures the numeric part of the speed
59999 description: Captures the units corresponding to the speed
60002 description: ID of interface
60005 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
60008 description: Trigger for operational monitoring of this resource by Service Assurance systems.
60014 $ref: "#/getDefinitions/relationship"
60018 $ref: "#/getDefinitions/l-interface"
60021 Collection of link aggregate interfaces.
60026 $ref: "#/getDefinitions/lag-interface"
60029 LAG links can connect lag-interfaces
60030 ###### Related Nodes
60031 - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
60032 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
60038 description: Alphabetical concatenation of lag-interface names
60041 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60045 $ref: "#/getDefinitions/relationship"
60048 Collection of link aggregation connections
60053 $ref: "#/getDefinitions/lag-link"
60056 Metadata for license group.
60057 ###### Related Nodes
60058 - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
60059 - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
60066 description: Unique ID for the license group the resource belongs to, should be uuid.
60069 description: Unique ID of a license resource.
60072 description: Concurrency value
60076 $ref: "#/getDefinitions/relationship"
60079 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
60084 $ref: "#/getDefinitions/license"
60087 describes a line-of-business
60088 ###### Related Nodes
60089 - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
60091 - line-of-business-name
60093 line-of-business-name:
60095 description: Name of the line-of-business (product)
60098 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60102 $ref: "#/getDefinitions/relationship"
60105 Collection of lines-of-business
60110 $ref: "#/getDefinitions/line-of-business"
60113 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
60114 ###### Related Nodes
60115 - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
60116 - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
60117 - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
60118 - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
60119 - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
60120 - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
60121 - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
60122 - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
60123 - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
60124 - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
60125 - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
60126 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
60127 - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
60128 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
60135 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
60138 description: Type of logical link, e.g., evc
60141 description: Captures the numeric part of the speed
60144 description: Captures the units corresponding to the speed
60147 description: v4, v6, or ds for dual stack
60150 description: For example, static or BGP
60153 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60154 model-invariant-id:
60156 description: the ASDC model id for this resource or service model.
60159 description: the ASDC model version for this resource or service model.
60160 persona-model-version:
60162 description: the ASDC model version for this resource or service model.
60165 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
60166 widget-model-version:
60168 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
60169 operational-status:
60171 description: Indication of operational status of the logical link.
60174 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
60177 description: Indication of the network use of the logical link.
60180 description: Alias or alternate name (CLCI or D1 name).
60183 description: UUID of the logical-link, SDNC generates this.
60186 description: Circuit id
60189 description: Reason for this entity, role it is playing
60193 $ref: "#/getDefinitions/relationship"
60196 Collection of logical connections
60201 $ref: "#/getDefinitions/logical-link"
60204 Collection of metadatum (key/value pairs)
60209 $ref: "#/getDefinitions/metadatum"
60213 ###### Related Nodes
60214 - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
60215 - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
60216 - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
60217 - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
60228 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60231 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
60232 ###### Related Nodes
60233 - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
60234 - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
60235 - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
60236 - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
60237 - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
60238 - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
60239 - MODEL is DELETED when these are DELETED MODEL-VER
60241 - model-invariant-id
60244 model-invariant-id:
60246 description: Unique identifier corresponding to the main definition of a model in ASDC
60249 description: Type of the model, e.g., service, resource, widget, etc.
60252 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60256 $ref: "#/getDefinitions/model-ver"
60260 $ref: "#/getDefinitions/relationship"
60261 model-and-named-query-search:
60263 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
60267 $ref: "#/getDefinitions/query-parameters"
60270 $ref: "#/getDefinitions/instance-filters"
60273 $ref: "#/getDefinitions/secondary-filts"
60276 secondary-filter-cut-point:
60280 This is how we would capture constraints defining allowed sets of elements.
60281 ###### Related Nodes
60282 - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
60283 - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
60284 - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
60286 - model-constraint-uuid
60287 - constrained-element-set-uuid-to-replace
60289 model-constraint-uuid:
60291 constrained-element-set-uuid-to-replace:
60293 constrained-element-sets:
60296 $ref: "#/getDefinitions/constrained-element-set"
60299 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60305 $ref: "#/getDefinitions/model-constraint"
60308 Defines how other models combine to make up a higher-level model.
60309 ###### Related Nodes
60310 - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
60311 - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
60312 - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
60313 - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
60314 - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
60315 - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
60316 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
60317 - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
60319 - model-element-uuid
60320 - new-data-del-flag
60323 model-element-uuid:
60327 description: Indicates whether this element was created as part of instantiation from this model
60330 description: How many of this type of element are required/allowed
60335 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60339 $ref: "#/getDefinitions/model-element"
60340 description: Defines how other models combine to make up a higher-level model
60344 $ref: "#/getDefinitions/model-constraint"
60345 description: Describes new constraints on this model element that are not part of that model's definition
60349 $ref: "#/getDefinitions/relationship"
60355 $ref: "#/getDefinitions/model-element"
60358 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
60359 ###### Related Nodes
60360 - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
60361 - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
60362 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
60363 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
60364 - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
60365 - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
60373 description: Unique identifier corresponding to one version of a model in ASDC
60376 description: Name of the model, which can change from version to version.
60379 description: Version
60382 description: Description
60385 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60389 $ref: "#/getDefinitions/model-element"
60393 $ref: "#/getDefinitions/metadatum"
60397 $ref: "#/getDefinitions/relationship"
60403 $ref: "#/getDefinitions/model-ver"
60406 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
60411 $ref: "#/getDefinitions/model"
60412 multicast-configuration:
60414 ###### Related Nodes
60415 - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
60417 - multicast-configuration-id
60418 - multicast-protocol
60421 multicast-configuration-id:
60423 description: Unique id of multicast configuration.
60424 multicast-protocol:
60426 description: protocol of multicast configuration
60429 description: rp type of multicast configuration
60432 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60436 $ref: "#/getDefinitions/relationship"
60437 multicast-configurations:
60439 multicast configuration of generic-vnf ip-address
60441 multicast-configuration:
60444 $ref: "#/getDefinitions/multicast-configuration"
60450 $ref: "#/getDefinitions/named-query"
60454 ###### Related Nodes
60455 - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
60456 - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
60457 - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
60458 - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
60462 - named-query-version
60468 named-query-version:
60470 required-input-param:
60476 named-query-elements:
60479 $ref: "#/getDefinitions/named-query-element"
60483 $ref: "#/getDefinitions/relationship"
60484 named-query-element:
60487 ###### Related Nodes
60488 - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
60489 - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
60490 - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
60491 - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
60492 - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
60493 - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
60494 - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
60496 - named-query-element-uuid
60498 named-query-element-uuid:
60500 property-collect-list:
60504 property-limit-desc:
60508 named-query-elements:
60511 $ref: "#/getDefinitions/named-query-element"
60515 $ref: "#/getDefinitions/related-lookup"
60516 property-constraints:
60519 $ref: "#/getDefinitions/property-constraint"
60523 $ref: "#/getDefinitions/relationship"
60524 named-query-elements:
60526 named-query-element:
60529 $ref: "#/getDefinitions/named-query-element"
60532 Namespace for network inventory resources.
60537 $ref: "#/getDefinitions/logical-link"
60541 $ref: "#/getDefinitions/site-pair-set"
60545 $ref: "#/getDefinitions/vpn-binding"
60549 $ref: "#/getDefinitions/vpls-pe"
60550 multicast-configurations:
60553 $ref: "#/getDefinitions/multicast-configuration"
60557 $ref: "#/getDefinitions/vce"
60561 $ref: "#/getDefinitions/vnfc"
60565 $ref: "#/getDefinitions/l3-network"
60569 $ref: "#/getDefinitions/network-policy"
60573 $ref: "#/getDefinitions/generic-vnf"
60577 $ref: "#/getDefinitions/lag-link"
60581 $ref: "#/getDefinitions/newvce"
60585 $ref: "#/getDefinitions/pnf"
60589 $ref: "#/getDefinitions/physical-link"
60590 ipsec-configurations:
60593 $ref: "#/getDefinitions/ipsec-configuration"
60594 route-table-references:
60597 $ref: "#/getDefinitions/route-table-reference"
60601 $ref: "#/getDefinitions/instance-group"
60605 $ref: "#/getDefinitions/zone"
60611 $ref: "#/getDefinitions/network-policy"
60614 ###### Related Nodes
60615 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
60616 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
60618 - network-policy-id
60622 description: UUID representing unique key to this instance
60623 network-policy-fqdn:
60625 description: Contrail FQDN for the policy
60628 description: ID for the openStack Heat instance
60631 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60635 $ref: "#/getDefinitions/relationship"
60638 Network profile populated by SDN-GP for SNMP
60639 ###### Related Nodes
60640 - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
60646 description: Unique name of network profile.
60649 description: Encrypted SNMP community string
60652 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60656 $ref: "#/getDefinitions/relationship"
60659 Collection of network profiles
60664 $ref: "#/getDefinitions/network-profile"
60667 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
60668 ###### Related Nodes
60669 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
60670 - NEWVCE is DELETED when these are DELETED L-INTERFACE
60678 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
60681 description: Name of VNF.
60684 description: Alternate name of VNF.
60687 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.
60690 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
60691 operational-status:
60693 description: Indicator for whether the resource is considered operational
60696 description: OBSOLETE - do not use
60699 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
60702 description: Client should send valid enumerated value.
60705 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60706 ipv4-loopback0-address:
60708 description: v4 Loopback0 address
60709 orchestration-status:
60711 description: Orchestration status of this VNF, mastered by MSO.
60714 description: Heat stack id corresponding to this instance, managed by MSO
60717 description: Corresponds to the SDN-C catalog id used to configure this VCE
60721 $ref: "#/getDefinitions/relationship"
60725 $ref: "#/getDefinitions/l-interface"
60728 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
60733 $ref: "#/getDefinitions/newvce"
60734 notification-event:
60738 notification-event-header:
60740 $ref: "#/getDefinitions/notification-event-header"
60741 notification-event-header:
60782 $ref: "#/getDefinitions/key-data"
60787 OAM network, to be deprecated shortly. Do not use for new purposes.
60788 ###### Related Nodes
60789 - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60790 - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
60791 - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
60799 description: UUID of the network. Unique across a cloud-region
60802 description: Name of the network.
60806 description: cvlan-id
60807 ipv4-oam-gateway-address:
60809 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
60810 ipv4-oam-gateway-address-prefix-length:
60813 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
60816 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60820 $ref: "#/getDefinitions/relationship"
60823 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
60828 $ref: "#/getDefinitions/oam-network"
60829 operational-environment:
60831 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
60832 ###### Related Nodes
60833 - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
60834 - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
60836 - operational-environment-id
60837 - operational-environment-name
60838 - operational-environment-type
60839 - operational-environment-status
60843 operational-environment-id:
60845 description: UUID of an operational environment
60846 operational-environment-name:
60848 description: Operational Environment name
60849 operational-environment-type:
60851 description: Operational Environment Type.
60852 operational-environment-status:
60854 description: Status
60857 description: Tenant Context.
60860 description: Workload Context.
60863 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60867 $ref: "#/getDefinitions/relationship"
60868 operational-environments:
60870 a logical partition of the cloud which allows to have multiple environments in the production AIC.
60872 operational-environment:
60875 $ref: "#/getDefinitions/operational-environment"
60878 Allows for legacy POST of old-style and new-style models
60880 - model-invariant-id
60881 - model-name-version-id
60887 model-invariant-id:
60889 description: Unique identifier corresponding to the main definition of a model in ASDC
60890 model-name-version-id:
60892 description: Unique identifier corresponding to one version of a model in ASDC
60895 description: Type of the model, e.g., service, resource, widget, etc.
60898 description: Name of the model, which can change from version to version.
60901 description: Invariant unique ID which does not change from version to version
60904 description: Version
60907 description: Description
60910 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60913 $ref: "#/getDefinitions/model-vers"
60916 $ref: "#/getDefinitions/relationship-list"
60919 Collection of owning-entities
60924 $ref: "#/getDefinitions/owning-entity"
60927 describes an owning-entity
60928 ###### Related Nodes
60929 - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
60932 - owning-entity-name
60936 description: UUID of an owning entity
60937 owning-entity-name:
60939 description: Owning entity name
60942 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60946 $ref: "#/getDefinitions/relationship"
60949 Physical interface (e.g., nic)
60950 ###### Related Nodes
60951 - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
60952 - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
60953 - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
60954 - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
60955 - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
60956 - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
60957 - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
60958 - P-INTERFACE is DELETED when these are DELETED L-INTERFACE
60959 - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
60966 description: Name that identifies the physical interface
60969 description: Captures the numeric part of the speed
60972 description: Captures the units corresponding to the speed
60975 description: Nature of the services and connectivity on this port.
60976 equipment-identifier:
60978 description: CLEI or other specification for p-interface hardware.
60981 description: Role specification for p-interface hardware.
60984 description: Indicates the physical properties of the interface.
60987 description: Trigger for operational monitoring of this resource by Service Assurance systems.
60990 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60996 $ref: "#/getDefinitions/relationship"
61000 $ref: "#/getDefinitions/l-interface"
61003 Collection of physical interfaces.
61008 $ref: "#/getDefinitions/p-interface"
61011 Collection of physical connections, typically between p-interfaces
61012 ###### Related Nodes
61013 - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
61019 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
61022 description: Captures the numeric part of the speed
61025 description: Captures the units corresponding to the speed
61028 description: Circuit it
61031 description: Dual access mode (e.g., primary, secondary
61034 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
61035 service-provider-name:
61037 description: Name of the service Provider on this link.
61040 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61044 $ref: "#/getDefinitions/relationship"
61047 Collection of physical connections, typically between p-interfaces
61052 $ref: "#/getDefinitions/physical-link"
61055 describes a platform
61056 ###### Related Nodes
61057 - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
61063 description: Name of the platform
61066 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61070 $ref: "#/getDefinitions/relationship"
61073 Collection of platforms
61078 $ref: "#/getDefinitions/platform"
61081 PNF represents a physical network function. typically equipment used in the D1 world.
61082 ###### Related Nodes
61083 - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
61084 - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61085 - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
61086 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
61087 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
61088 - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
61089 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
61090 - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
61097 description: unique name of Physical Network Function.
61100 description: name of Physical Network Function.
61103 description: source of name2
61106 description: id of pnf
61109 description: Equipment type. Source of truth should define valid values.
61112 description: Equipment vendor. Source of truth should define valid values.
61115 description: Equipment model. Source of truth should define valid values.
61118 description: identifier of managed by company or customer
61121 description: ipv4-oam-address with new naming convention for IP addresses
61124 description: sw-version is the version of SW for the hosted application on the PNF.
61129 description: ID of the physical frame (relay rack) where pnf is installed.
61132 description: Serial number of the device
61133 ipaddress-v4-loopback-0:
61135 description: IPV4 Loopback 0 address
61136 ipaddress-v6-loopback-0:
61138 description: IPV6 Loopback 0 address
61141 description: IPV4 AIM address
61144 description: IPV6 AIM address
61147 description: IPV6 OAM address
61150 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
61153 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61156 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
61159 description: Nf Role is the role performed by this instance in the network.
61163 $ref: "#/getDefinitions/relationship"
61167 $ref: "#/getDefinitions/p-interface"
61171 $ref: "#/getDefinitions/lag-interface"
61174 Collection of Physical Network Functions.
61179 $ref: "#/getDefinitions/pnf"
61182 Used to capture the network interfaces of this VCE
61183 ###### Related Nodes
61184 - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
61185 - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
61186 - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
61189 - orchestration-status
61193 description: Unique ID of the interface
61194 neutron-network-id:
61196 description: Neutron network id of this Interface
61197 neutron-network-name:
61199 description: Neutron network name of this Interface
61202 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
61205 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61208 description: Unique ID for port group in vmware
61211 description: Likely to duplicate value of neutron network name
61214 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
61215 orchestration-status:
61217 description: Orchestration status of this VNF, mastered by MSO
61220 description: Heat stack id corresponding to this instance, managed by MSO
61223 description: Corresponds to the SDN-C catalog id used to configure this VCE
61227 $ref: "#/getDefinitions/cvlan-tag-entry"
61231 $ref: "#/getDefinitions/relationship"
61237 $ref: "#/getDefinitions/port-group"
61240 describes the project
61241 ###### Related Nodes
61242 - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
61248 description: Name of the project deploying a service
61251 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61255 $ref: "#/getDefinitions/relationship"
61258 Collection of projects
61263 $ref: "#/getDefinitions/project"
61266 Property holder for query properties or instance properties
61272 property-constraint:
61275 ###### Related Nodes
61276 - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
61278 - property-constraint-uuid
61283 property-constraint-uuid:
61293 property-constraints:
61295 property-constraint:
61298 $ref: "#/getDefinitions/property-constraint"
61301 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
61302 ###### Related Nodes
61303 - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
61304 - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
61305 - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
61306 - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
61307 - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
61308 - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
61309 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
61310 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
61311 - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
61312 - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
61313 - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
61314 - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
61315 - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
61322 description: Value from executing hostname on the compute node.
61325 description: PTNII name
61329 description: Number of cpus
61333 description: Disk size, in GBs
61337 description: RAM size, in MBs
61340 description: Equipment type. Source of truth should define valid values.
61343 description: Equipment vendor. Source of truth should define valid values.
61346 description: Equipment model. Source of truth should define valid values.
61349 description: Fully-qualified domain name
61352 description: URL to endpoint where AAI can get more details
61355 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
61358 description: Serial number, may be queried
61359 ipaddress-v4-loopback-0:
61361 description: IPV4 Loopback 0 address
61362 ipaddress-v6-loopback-0:
61364 description: IPV6 Loopback 0 address
61367 description: IPV4 AIM address
61370 description: IPV6 AIM address
61373 description: IPV6 OAM address
61376 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
61379 description: ID of Pserver
61382 description: internet topology of Pserver
61387 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61390 description: alternative pserver name
61393 description: purpose of pserver
61396 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
61400 $ref: "#/getDefinitions/relationship"
61404 $ref: "#/getDefinitions/p-interface"
61408 $ref: "#/getDefinitions/lag-interface"
61411 Collection of compute hosts.
61416 $ref: "#/getDefinitions/pserver"
61419 QueryParameters for performing a named-query or model query
61423 $ref: "#/getDefinitions/named-query"
61426 $ref: "#/getDefinitions/overloaded-model"
61430 ###### Related Nodes
61431 - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
61433 - related-lookup-uuid
61435 - source-node-property
61437 - target-node-property
61439 related-lookup-uuid:
61443 source-node-property:
61447 target-node-property:
61449 property-collect-list:
61456 $ref: "#/getDefinitions/relationship"
61462 $ref: "#/getDefinitions/related-lookup"
61463 related-to-property:
61467 description: Key part of a key/value pair
61470 description: Value part of a key/value pair
61475 description: A keyword provided by A&AI to indicate type of node.
61478 description: URL to the object in A&AI.
61482 $ref: "#/getDefinitions/relationship-data"
61483 related-to-property:
61486 $ref: "#/getDefinitions/related-to-property"
61490 - relationship-value
61494 description: A keyword provided by A&AI to indicate an attribute.
61495 relationship-value:
61497 description: Value of the attribute.
61503 $ref: "#/getDefinitions/relationship"
61504 reserved-prop-names:
61506 Internal map to define some reserved properties of a vertex
61508 last-mod-source-of-truth:
61526 Response container for the results of a named-query or model query
61528 inventory-response-items:
61530 $ref: "#/getDefinitions/inventory-response-items"
61535 description: The specific type of node in the A&AI graph
61538 description: The URL to the specific resource
61539 route-table-reference:
61541 Openstack route table reference.
61542 ###### Related Nodes
61543 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
61545 - route-table-reference-id
61546 - route-table-reference-fqdn
61548 route-table-reference-id:
61550 description: Route Table Reference id, UUID assigned to this instance.
61551 route-table-reference-fqdn:
61553 description: FQDN entry in the route table.
61556 description: Concurrency value
61560 $ref: "#/getDefinitions/relationship"
61561 route-table-references:
61563 Collection of openstack route table references
61565 route-table-reference:
61568 $ref: "#/getDefinitions/route-table-reference"
61571 Route target information
61572 ###### Related Nodes
61573 - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
61575 - global-route-target
61576 - route-target-role
61578 global-route-target:
61580 description: Number used to identify an RT, globally unique in the network
61583 description: Role assigned to this route target
61586 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61590 $ref: "#/getDefinitions/relationship"
61593 Collection of route target information
61598 $ref: "#/getDefinitions/route-target"
61601 ###### Related Nodes
61602 - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
61603 - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
61604 - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
61606 - routing-instance-id
61608 routing-instance-id:
61610 description: Unique id of routing instance
61613 description: rpm owner
61616 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61620 $ref: "#/getDefinitions/site-pair"
61624 $ref: "#/getDefinitions/relationship"
61627 set of probes related to generic-vnf routing instance
61632 $ref: "#/getDefinitions/routing-instance"
61637 $ref: "#/getDefinitions/oam-networks"
61638 az-and-dvs-switches:
61641 $ref: "#/getDefinitions/az-and-dvs-switches"
61644 edge-tag-query-result:
61646 $ref: "#/getDefinitions/edge-tag-query-result"
61647 edge-tag-query-request:
61649 $ref: "#/getDefinitions/edge-tag-query-request"
61652 $ref: "#/getDefinitions/search-results"
61655 $ref: "#/getDefinitions/sdn-zone-response"
61661 $ref: "#/getDefinitions/result-data"
61664 SecondaryFilt for performing a named-query or model query
61675 SecondaryFilts for performing a named-query or model query
61680 $ref: "#/getDefinitions/secondary-filt"
61681 segmentation-assignment:
61683 Openstack segmentation assignment.
61684 ###### Related Nodes
61685 - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
61691 description: Route Table Reference id, UUID assigned to this instance.
61694 description: Concurrency value
61698 $ref: "#/getDefinitions/relationship"
61699 segmentation-assignments:
61701 Collection of openstack segmentation assignments
61703 segmentation-assignment:
61706 $ref: "#/getDefinitions/segmentation-assignment"
61709 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
61712 - service-description
61716 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
61717 service-description:
61719 description: Description of the service
61722 description: URL to endpoint where AAI can get more details
61725 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61728 description: service version
61732 $ref: "#/getDefinitions/relationship"
61733 service-capabilities:
61735 Collection of service capabilities.
61737 service-capability:
61740 $ref: "#/getDefinitions/service-capability"
61741 service-capability:
61743 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
61744 ###### Related Nodes
61745 - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
61746 - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
61747 - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
61754 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
61757 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.
61760 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61764 $ref: "#/getDefinitions/relationship"
61765 service-design-and-creation:
61767 Namespace for objects managed by ASDC
61772 $ref: "#/getDefinitions/vnf-image"
61776 $ref: "#/getDefinitions/service"
61777 service-capabilities:
61780 $ref: "#/getDefinitions/service-capability"
61784 $ref: "#/getDefinitions/model"
61788 $ref: "#/getDefinitions/named-query"
61791 Instance of a service
61792 ###### Related Nodes
61793 - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
61794 - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
61795 - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
61796 - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
61797 - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
61798 - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
61799 - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61800 - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
61801 - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
61802 - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
61803 - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
61804 - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
61805 - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
61806 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
61807 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
61808 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
61809 - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM
61810 - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
61812 - service-instance-id
61814 service-instance-id:
61816 description: Uniquely identifies this instance of a service
61817 service-instance-name:
61819 description: This field will store a name assigned to the service-instance.
61820 model-invariant-id:
61822 description: the ASDC model id for this resource or service model.
61825 description: the ASDC model version for this resource or service model.
61826 persona-model-version:
61828 description: the ASDC model version for this resource or service model.
61831 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
61832 widget-model-version:
61834 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
61837 description: Indicates the total bandwidth to be used for this service.
61840 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
61841 bandwidth-down-wan1:
61843 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
61846 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
61847 bandwidth-down-wan2:
61849 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
61852 description: URL customers will use to access the vHN Portal.
61853 service-instance-location-id:
61855 description: An identifier that customers assign to the location where this service is being used.
61858 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61861 description: Path to the controller object.
61862 orchestration-status:
61864 description: Orchestration status of this service.
61868 $ref: "#/getDefinitions/relationship"
61872 $ref: "#/getDefinitions/metadatum"
61873 allotted-resources:
61876 $ref: "#/getDefinitions/allotted-resource"
61879 Collection of service instances
61884 $ref: "#/getDefinitions/service-instance"
61885 service-subscription:
61887 Object that group service instances.
61888 ###### Related Nodes
61889 - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
61890 - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
61891 - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
61892 - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
61898 description: Value defined by orchestration to identify this service across ECOMP.
61899 temp-ub-sub-account-id:
61901 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
61904 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61908 $ref: "#/getDefinitions/service-instance"
61912 $ref: "#/getDefinitions/relationship"
61913 service-subscriptions:
61915 Collection of objects that group service instances.
61917 service-subscription:
61920 $ref: "#/getDefinitions/service-subscription"
61923 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
61928 $ref: "#/getDefinitions/service"
61931 ###### Related Nodes
61932 - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
61933 - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
61934 - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
61940 description: unique identifier of probe
61943 description: Prefix address
61946 description: Prefix address
61949 description: ip version, v4, v6
61950 destination-hostname:
61952 description: Hostname of the destination equipment to which SLAs are measured against.
61953 destination-equip-type:
61955 description: The type of destinatination equipment. Could be Router, etc.
61958 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61959 classes-of-service:
61962 $ref: "#/getDefinitions/class-of-service"
61966 $ref: "#/getDefinitions/relationship"
61969 Set of instances for probes used to measure service level agreements
61970 ###### Related Nodes
61971 - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
61972 - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
61973 - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
61979 description: Unique id of site pair set.
61982 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61986 $ref: "#/getDefinitions/routing-instance"
61990 $ref: "#/getDefinitions/relationship"
61993 Collection of sets of instances for probes related to generic-vnf
61998 $ref: "#/getDefinitions/site-pair-set"
62006 $ref: "#/getDefinitions/site-pair"
62010 ###### Related Nodes
62011 - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62012 - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
62018 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
62021 description: Snapshot name
62022 snapshot-architecture:
62024 description: Operating system architecture
62025 snapshot-os-distro:
62027 description: The common name of the operating system distribution in lowercase
62028 snapshot-os-version:
62030 description: The operating system version as specified by the distributor.
62033 description: The application that the image instantiates.
62034 application-vendor:
62036 description: The vendor of the application.
62037 application-version:
62039 description: The version of the application.
62042 description: URL to endpoint where AAI can get more details
62045 description: This field contains the UUID of the previous snapshot (if any).
62048 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62052 $ref: "#/getDefinitions/relationship"
62055 Collection of openstack snapshots
62060 $ref: "#/getDefinitions/snapshot"
62063 SR-IOV Physical Function
62064 ###### Related Nodes
62065 - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
62066 - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
62072 description: Identifier for the sriov-pf
62075 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62079 $ref: "#/getDefinitions/relationship"
62082 Collection of SR-IOV Physical Functions.
62087 $ref: "#/getDefinitions/sriov-pf"
62090 SR-IOV Virtual Function (not to be confused with virtual network function)
62091 ###### Related Nodes
62092 - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
62098 description: PCI ID used to identify the sriov-vf
62101 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
62104 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
62107 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
62108 vf-vlan-anti-spoof-check:
62110 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.
62111 vf-mac-anti-spoof-check:
62113 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.
62116 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
62117 vf-broadcast-allow:
62119 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
62120 vf-unknown-multicast-allow:
62122 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
62123 vf-unknown-unicast-allow:
62125 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
62128 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
62131 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
62134 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62135 neutron-network-id:
62137 description: Neutron network id of the interface
62141 $ref: "#/getDefinitions/relationship"
62144 Collection of SR-IOV Virtual Functions.
62149 $ref: "#/getDefinitions/sriov-vf"
62158 ###### Related Nodes
62159 - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
62160 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
62161 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
62162 - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
62169 description: Subnet ID, should be UUID.
62172 description: Name associated with the subnet.
62175 description: Neutron id of this subnet
62178 description: gateway ip address
62179 network-start-address:
62181 description: network start address
62184 description: cidr mask
62187 description: ip version
62188 orchestration-status:
62190 description: Orchestration status of this VNF, mastered by MSO
62195 description: the start address reserved for use by dhcp
62198 description: the last address reserved for use by dhcp
62201 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62205 $ref: "#/getDefinitions/relationship"
62211 $ref: "#/getDefinitions/subnet"
62212 tagged-inventory-item-list:
62217 $ref: "#/getDefinitions/inventory-item"
62221 ###### Related Nodes
62222 - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62223 - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
62224 - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
62225 - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
62226 - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
62227 - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
62228 - TENANT cannot be deleted if linked to VSERVER
62235 description: Unique id relative to the cloud-region.
62238 description: Readable name of tenant
62241 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62245 $ref: "#/getDefinitions/vserver"
62249 $ref: "#/getDefinitions/relationship"
62252 Collection of openstack tenants.
62257 $ref: "#/getDefinitions/tenant"
62260 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
62261 ###### Related Nodes
62262 - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
62265 - bandwidth-up-wan1
62266 - bandwidth-down-wan1
62267 - bandwidth-up-wan2
62268 - bandwidth-down-wan2
62272 description: Allotted Resource id UUID assigned to this instance.
62275 description: The WAN uplink bandwidth for WAN1
62276 bandwidth-down-wan1:
62278 description: The WAN downlink bandwidth for WAN1
62281 description: The WAN uplink bandwidth for WAN2
62282 bandwidth-down-wan2:
62284 description: The WAN downlink bandwidth for WAN2
62287 description: Concurrency value
62291 $ref: "#/getDefinitions/relationship"
62294 This object is used to store the specific tunnel cross connect aspects of an allotted resource
62299 $ref: "#/getDefinitions/tunnel-xconnect"
62302 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
62311 $ref: "#/getDefinitions/update-node-key"
62317 $ref: "#/getDefinitions/action"
62326 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
62327 ###### Related Nodes
62328 - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
62329 - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
62330 - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
62331 - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
62332 - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
62333 - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
62334 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
62335 - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
62343 description: Unique id of VNF. This is unique across the graph.
62346 description: Name of VNF.
62349 description: Alternate name of VNF.
62352 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.
62355 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
62356 regional-resource-zone:
62358 description: Regional way of organizing pservers, source of truth should define values
62361 description: Trigger for operational monitoring of this resource by Service Assurance systems.
62362 operational-status:
62364 description: Indicator for whether the resource is considered operational
62367 description: OBSOLETE - do not use
62370 description: Network role being played by this VNF
62371 orchestration-status:
62373 description: Orchestration status of this VNF, mastered by MSO
62376 description: Heat stack id corresponding to this instance, managed by MSO
62379 description: Corresponds to the SDN-C catalog id used to configure this VCE
62382 description: Unique ID of VPE connected to this VCE.
62383 v6-vce-wan-address:
62385 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
62388 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
62391 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62392 ipv4-loopback0-address:
62394 description: Loopback0 address
62395 entitlement-resource-uuid:
62397 description: OBSOLETE - see child relationships
62401 $ref: "#/getDefinitions/port-group"
62405 $ref: "#/getDefinitions/license"
62409 $ref: "#/getDefinitions/entitlement"
62413 $ref: "#/getDefinitions/relationship"
62416 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
62421 $ref: "#/getDefinitions/vce"
62424 a deployment unit of VNFCs
62425 ###### Related Nodes
62426 - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
62427 - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
62428 - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
62429 - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
62430 - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
62431 - VF-MODULE cannot be deleted if linked to VNFC
62434 - is-base-vf-module
62438 description: Unique ID of vf-module.
62441 description: Name of vf-module
62444 description: Heat stack id corresponding to this instance.
62445 orchestration-status:
62447 description: orchestration status of this vf-module, mastered by MSO
62452 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62453 model-invariant-id:
62455 description: the ASDC model id for this resource or service model.
62458 description: the ASDC model version for this resource or service model.
62459 persona-model-version:
62461 description: the ASDC model version for this resource or service model.
62462 model-customization-id:
62464 description: captures the id of all the configuration used to customize the resource for the service.
62467 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
62468 widget-model-version:
62470 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
62471 contrail-service-instance-fqdn:
62473 description: the Contrail unique ID for a service-instance
62477 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
62480 description: Path to the controller object.
62484 $ref: "#/getDefinitions/relationship"
62487 Collection of vf-modules, a deployment unit of VNFCs
62492 $ref: "#/getDefinitions/vf-module"
62495 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
62496 ###### Related Nodes
62497 - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
62503 description: indicates whether the VIG is for AVPN or INTERNET
62506 description: v4 IP of the vig server
62509 description: v6 IP of the vig server
62512 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62516 $ref: "#/getDefinitions/relationship"
62522 $ref: "#/getDefinitions/vig-server"
62523 vip-ipv4-address-list:
62526 ###### Related Nodes
62527 - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62528 - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
62529 - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
62530 - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
62536 description: IP address
62537 vip-ipv4-prefix-length:
62540 description: Prefix length, 32 for single address
62544 description: Inner VLAN tag
62548 description: Outer VLAN tag
62551 description: Indicator of fixed or floating address
62554 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62555 neutron-network-id:
62557 description: Neutron network id of the interface that address belongs to
62560 description: Neutron id of subnet that address belongs to
62564 $ref: "#/getDefinitions/relationship"
62565 vip-ipv6-address-list:
62568 ###### Related Nodes
62569 - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62570 - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
62571 - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
62572 - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
62578 description: IP address
62579 vip-ipv6-prefix-length:
62582 description: Prefix length, 128 for single address
62586 description: Inner VLAN tag
62590 description: Outer VLAN tag
62593 description: Indicator of fixed or floating address
62596 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62597 neutron-network-id:
62599 description: Neutron network id of the interface that address belongs to
62602 description: Neutron id of subnet that address belongs to
62606 $ref: "#/getDefinitions/relationship"
62607 virtual-data-center:
62609 Virtual organization of cloud infrastructure elements in a data center context
62610 ###### Related Nodes
62611 - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
62612 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
62613 - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
62620 description: Unique ID of the vdc
62623 description: Name of the virtual data center
62626 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62630 $ref: "#/getDefinitions/relationship"
62631 virtual-data-centers:
62633 Virtual organization of cloud infrastructure elements in a data center context
62635 virtual-data-center:
62638 $ref: "#/getDefinitions/virtual-data-center"
62642 ###### Related Nodes
62643 - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
62644 - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
62645 - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
62646 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
62647 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
62648 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
62649 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
62650 - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
62651 - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
62658 description: String that identifies the interface
62662 description: Inner VLAN tag
62666 description: Outer VLAN tag
62669 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62672 description: Captures the numeric part of the speed
62675 description: Captures the units corresponding to the speed
62678 description: Used to describe (the service associated with) the vlan
62679 backdoor-connection:
62681 description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
62684 description: This indicates the customers VPN ID associated with this vlan
62685 orchestration-status:
62687 description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
62693 $ref: "#/getDefinitions/relationship"
62694 l3-interface-ipv4-address-list:
62697 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
62698 l3-interface-ipv6-address-list:
62701 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
62707 $ref: "#/getDefinitions/vlan"
62716 description: Unique id of VNF. This is unique across the graph.
62719 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
62720 ###### Related Nodes
62721 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
62722 - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
62726 - application-vendor
62730 description: Unique ID of this asset
62733 description: The application that the image instantiates.
62734 application-vendor:
62736 description: The vendor of the application.
62737 application-version:
62739 description: The version of the application.
62742 description: URL to endpoint where AAI can get more details
62745 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62749 $ref: "#/getDefinitions/relationship"
62752 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
62757 $ref: "#/getDefinitions/vnf-image"
62760 ###### Related Nodes
62761 - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
62762 - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
62763 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
62766 - vnfc-function-code
62769 - is-closed-loop-disabled
62773 description: Unique ID of vnfc.
62774 vnfc-function-code:
62776 description: function code
62782 description: prov status of this vnfc
62783 orchestration-status:
62785 description: Orchestration status of this VNF, mastered by APP-C
62786 ipaddress-v4-oam-vip:
62788 description: Oam V4 vip address of this vnfc
62791 is-closed-loop-disabled:
62795 description: Group notation of VNFC
62798 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62802 $ref: "#/getDefinitions/relationship"
62805 virtual network components associated with a vserver from application controller.
62810 $ref: "#/getDefinitions/vnfc"
62813 Ephemeral Block storage volume.
62814 ###### Related Nodes
62815 - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
62822 description: Unique ID of block storage volume relative to the vserver.
62825 description: URL to endpoint where AAI can get more details
62828 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62832 $ref: "#/getDefinitions/relationship"
62835 Persistent block-level storage.
62836 ###### Related Nodes
62837 - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62838 - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62839 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
62840 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
62841 - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
62844 - volume-group-name
62849 description: Unique ID of volume-group.
62852 description: Name of the volume group.
62855 description: Heat stack id corresponding to this volume-group
62858 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.
62859 orchestration-status:
62861 description: Orchestration status of this volume-group
62862 model-customization-id:
62864 description: captures the id of all the configuration used to customize the resource for the service.
62865 vf-module-model-customization-id:
62867 description: helps relate the volume group to the vf-module whose components will require the volume group
62870 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62874 $ref: "#/getDefinitions/relationship"
62877 Collection of persistent block-level storage.
62882 $ref: "#/getDefinitions/volume-group"
62885 Collection of ephemeral Block storage volumes.
62890 $ref: "#/getDefinitions/volume"
62893 VPLS Provider Edge routers.
62894 ###### Related Nodes
62895 - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62896 - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
62897 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
62898 - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
62899 - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
62907 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
62910 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
62913 description: Client should send valid enumerated value, e.g., VPLS-PE.
62917 description: Temporary location for stag to get to VCE
62920 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62924 $ref: "#/getDefinitions/relationship"
62928 $ref: "#/getDefinitions/p-interface"
62932 $ref: "#/getDefinitions/lag-interface"
62935 Collection of VPLS Provider Edge routers
62940 $ref: "#/getDefinitions/vpls-pe"
62944 ###### Related Nodes
62945 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
62946 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
62947 - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
62948 - VPN-BINDING cannot be deleted if linked to L3-NETWORK,LOGICAL-LINK
62949 - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
62956 description: VPN ID, globally unique within A&AI
62959 description: VPN Name
62962 description: the platform associated with the VPN example AVPN, Mobility
62965 description: Type of the vpn, should be taken from enumerated/valid values
62966 route-distinguisher:
62968 description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
62971 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
62975 $ref: "#/getDefinitions/route-target"
62979 $ref: "#/getDefinitions/relationship"
62980 description: l3-networks relate to vpn-bindings
62986 $ref: "#/getDefinitions/vpn-binding"
62989 Virtual Servers, aka virtual machine or VM.
62990 ###### Related Nodes
62991 - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
62992 - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
62993 - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
62994 - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
62995 - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
62996 - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
62997 - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
62998 - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
62999 - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
63000 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
63001 - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
63002 - VSERVER is DELETED when these are DELETED L-INTERFACE
63003 - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
63009 - is-closed-loop-disabled
63013 description: Unique identifier for this vserver relative to its tenant
63016 description: Name of vserver
63019 description: Alternative name of vserver
63022 description: Trigger for operational monitoring of this resource by Service Assurance systems.
63025 description: URL to endpoint where AAI can get more details
63028 is-closed-loop-disabled:
63032 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
63036 $ref: "#/getDefinitions/volume"
63040 $ref: "#/getDefinitions/relationship"
63044 $ref: "#/getDefinitions/l-interface"
63047 Collection of virtual Servers, aka virtual machines or VMs.
63052 $ref: "#/getDefinitions/vserver"
63055 A zone is a grouping of assets in a location homing to the same connections into the CBB
63056 ###### Related Nodes
63057 - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
63058 - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
63059 - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
63060 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
63069 description: Code assigned by AIC to the zone
63072 description: English name associated with the zone
63075 description: Design of zone [Medium/Large?]
63078 description: Context of zone [production/test]
63081 description: Status of a zone.
63084 description: Concurrency value
63088 $ref: "#/getDefinitions/relationship"
63091 Collection of zones
63096 $ref: "#/getDefinitions/zone"