5 [Differences versus the previous schema version](apidocs/aai_swagger_v8.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/v8/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/v8/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/v8/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/v8/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/v8/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 and clients should expect changes to occur in the future to this field as ASDC 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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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: ID of Pserver
8391 - name: pserver-name2
8393 description: alternative pserver name
8396 - name: interface-id
8398 description: ID of interface
8403 description: MAC address for the interface
8406 - name: network-name
8408 description: Name of the network
8411 - name: vlan-id-inner
8413 description: Inner VLAN tag
8419 description: This indicates the customers VPN ID associated with this vlan
8422 - name: vlan-id-inner
8424 description: Inner VLAN tag
8428 - name: neutron-network-id
8430 description: Neutron network id of the interface that address belongs to
8433 - name: neutron-subnet-id
8435 description: Neutron id of subnet that address belongs to
8440 - CloudInfrastructure
8441 summary: create or update an existing l3-interface-ipv4-address-list
8443 Create or update an existing l3-interface-ipv4-address-list.
8445 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8446 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8455 description: Response codes found in [response codes](https://wiki.onap.org/).
8459 description: Value from executing hostname on the compute node.
8462 example: __HOSTNAME__
8463 - name: interface-name
8465 description: Name that identifies the physical interface
8468 example: __INTERFACE-NAME__
8469 - name: interface-name
8471 description: Name given to the interface
8474 example: __INTERFACE-NAME__
8475 - name: vlan-interface
8477 description: String that identifies the interface
8480 example: __VLAN-INTERFACE__
8481 - name: l3-interface-ipv4-address
8483 description: IP address
8486 example: __L3-INTERFACE-IPV4-ADDRESS__
8489 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
8492 $ref: "#/definitions/l3-interface-ipv4-address-list"
8495 - CloudInfrastructure
8496 summary: update an existing l3-interface-ipv4-address-list
8498 Update an existing l3-interface-ipv4-address-list
8500 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8501 The PUT operation will entirely replace an existing object.
8502 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8504 Other differences between PUT and PATCH are:
8506 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8507 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8508 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8509 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8518 description: Response codes found in [response codes](https://wiki.onap.org/).
8522 description: Value from executing hostname on the compute node.
8525 example: __HOSTNAME__
8526 - name: interface-name
8528 description: Name that identifies the physical interface
8531 example: __INTERFACE-NAME__
8532 - name: interface-name
8534 description: Name given to the interface
8537 example: __INTERFACE-NAME__
8538 - name: vlan-interface
8540 description: String that identifies the interface
8543 example: __VLAN-INTERFACE__
8544 - name: l3-interface-ipv4-address
8546 description: IP address
8549 example: __L3-INTERFACE-IPV4-ADDRESS__
8552 description: l3-interface-ipv4-address-list object that needs to be created or updated.
8555 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
8558 - CloudInfrastructure
8559 summary: delete an existing l3-interface-ipv4-address-list
8560 description: delete an existing l3-interface-ipv4-address-list
8561 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8570 description: Response codes found in [response codes](https://wiki.onap.org/).
8574 description: Value from executing hostname on the compute node.
8577 example: __HOSTNAME__
8578 - name: interface-name
8580 description: Name that identifies the physical interface
8583 example: __INTERFACE-NAME__
8584 - name: interface-name
8586 description: Name given to the interface
8589 example: __INTERFACE-NAME__
8590 - name: vlan-interface
8592 description: String that identifies the interface
8595 example: __VLAN-INTERFACE__
8596 - name: l3-interface-ipv4-address
8598 description: IP address
8601 example: __L3-INTERFACE-IPV4-ADDRESS__
8602 - name: resource-version
8604 description: resource-version for concurrency
8607 /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:
8610 - CloudInfrastructure
8611 summary: see node definition for valid relationships
8612 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
8621 description: Response codes found in [response codes](https://wiki.onap.org/).
8625 description: Value from executing hostname on the compute node.
8628 example: __HOSTNAME__
8629 - name: interface-name
8631 description: Name that identifies the physical interface
8634 example: __INTERFACE-NAME__
8635 - name: interface-name
8637 description: Name given to the interface
8640 example: __INTERFACE-NAME__
8641 - name: vlan-interface
8643 description: String that identifies the interface
8646 example: __VLAN-INTERFACE__
8647 - name: l3-interface-ipv6-address
8649 description: IP address
8652 example: __L3-INTERFACE-IPV6-ADDRESS__
8655 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
8658 $ref: "#/definitions/relationship"
8661 - CloudInfrastructure
8662 summary: delete an existing relationship
8663 description: delete an existing relationship
8664 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
8673 description: Response codes found in [response codes](https://wiki.onap.org/).
8677 description: Value from executing hostname on the compute node.
8680 example: __HOSTNAME__
8681 - name: interface-name
8683 description: Name that identifies the physical interface
8686 example: __INTERFACE-NAME__
8687 - name: interface-name
8689 description: Name given to the interface
8692 example: __INTERFACE-NAME__
8693 - name: vlan-interface
8695 description: String that identifies the interface
8698 example: __VLAN-INTERFACE__
8699 - name: l3-interface-ipv6-address
8701 description: IP address
8704 example: __L3-INTERFACE-IPV6-ADDRESS__
8705 /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}:
8708 - CloudInfrastructure
8709 summary: returns l3-interface-ipv6-address-list
8710 description: returns l3-interface-ipv6-address-list
8711 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8717 description: successful operation
8719 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
8721 description: Response codes found in [response codes](https://wiki.onap.org/).
8725 description: Value from executing hostname on the compute node.
8728 example: __HOSTNAME__
8729 - name: interface-name
8731 description: Name that identifies the physical interface
8734 example: __INTERFACE-NAME__
8735 - name: interface-name
8737 description: Name given to the interface
8740 example: __INTERFACE-NAME__
8741 - name: vlan-interface
8743 description: String that identifies the interface
8746 example: __VLAN-INTERFACE__
8747 - name: l3-interface-ipv6-address
8749 description: IP address
8752 example: __L3-INTERFACE-IPV6-ADDRESS__
8755 description: ID of Pserver
8762 - name: pserver-name2
8764 description: alternative pserver name
8767 - name: interface-id
8769 description: ID of interface
8774 description: MAC address for the interface
8777 - name: network-name
8779 description: Name of the network
8782 - name: vlan-id-inner
8784 description: Inner VLAN tag
8790 description: This indicates the customers VPN ID associated with this vlan
8793 - name: vlan-id-inner
8795 description: Inner VLAN tag
8799 - name: neutron-network-id
8801 description: Neutron network id of the interface that address belongs to
8804 - name: neutron-subnet-id
8806 description: Neutron id of subnet that address belongs to
8811 - CloudInfrastructure
8812 summary: create or update an existing l3-interface-ipv6-address-list
8814 Create or update an existing l3-interface-ipv6-address-list.
8816 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8817 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8826 description: Response codes found in [response codes](https://wiki.onap.org/).
8830 description: Value from executing hostname on the compute node.
8833 example: __HOSTNAME__
8834 - name: interface-name
8836 description: Name that identifies the physical interface
8839 example: __INTERFACE-NAME__
8840 - name: interface-name
8842 description: Name given to the interface
8845 example: __INTERFACE-NAME__
8846 - name: vlan-interface
8848 description: String that identifies the interface
8851 example: __VLAN-INTERFACE__
8852 - name: l3-interface-ipv6-address
8854 description: IP address
8857 example: __L3-INTERFACE-IPV6-ADDRESS__
8860 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
8863 $ref: "#/definitions/l3-interface-ipv6-address-list"
8866 - CloudInfrastructure
8867 summary: update an existing l3-interface-ipv6-address-list
8869 Update an existing l3-interface-ipv6-address-list
8871 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8872 The PUT operation will entirely replace an existing object.
8873 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8875 Other differences between PUT and PATCH are:
8877 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8878 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8879 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8880 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8889 description: Response codes found in [response codes](https://wiki.onap.org/).
8893 description: Value from executing hostname on the compute node.
8896 example: __HOSTNAME__
8897 - name: interface-name
8899 description: Name that identifies the physical interface
8902 example: __INTERFACE-NAME__
8903 - name: interface-name
8905 description: Name given to the interface
8908 example: __INTERFACE-NAME__
8909 - name: vlan-interface
8911 description: String that identifies the interface
8914 example: __VLAN-INTERFACE__
8915 - name: l3-interface-ipv6-address
8917 description: IP address
8920 example: __L3-INTERFACE-IPV6-ADDRESS__
8923 description: l3-interface-ipv6-address-list object that needs to be created or updated.
8926 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
8929 - CloudInfrastructure
8930 summary: delete an existing l3-interface-ipv6-address-list
8931 description: delete an existing l3-interface-ipv6-address-list
8932 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8941 description: Response codes found in [response codes](https://wiki.onap.org/).
8945 description: Value from executing hostname on the compute node.
8948 example: __HOSTNAME__
8949 - name: interface-name
8951 description: Name that identifies the physical interface
8954 example: __INTERFACE-NAME__
8955 - name: interface-name
8957 description: Name given to the interface
8960 example: __INTERFACE-NAME__
8961 - name: vlan-interface
8963 description: String that identifies the interface
8966 example: __VLAN-INTERFACE__
8967 - name: l3-interface-ipv6-address
8969 description: IP address
8972 example: __L3-INTERFACE-IPV6-ADDRESS__
8973 - name: resource-version
8975 description: resource-version for concurrency
8978 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
8981 - CloudInfrastructure
8982 summary: returns vlan
8983 description: returns vlan
8984 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
8990 description: successful operation
8992 $ref: "#/getDefinitions/vlan"
8994 description: Response codes found in [response codes](https://wiki.onap.org/).
8998 description: Value from executing hostname on the compute node.
9001 example: __HOSTNAME__
9002 - name: interface-name
9004 description: Name that identifies the physical interface
9007 example: __INTERFACE-NAME__
9008 - name: interface-name
9010 description: Name given to the interface
9013 example: __INTERFACE-NAME__
9014 - name: vlan-interface
9016 description: String that identifies the interface
9019 example: __VLAN-INTERFACE__
9022 description: ID of Pserver
9029 - name: pserver-name2
9031 description: alternative pserver name
9034 - name: interface-id
9036 description: ID of interface
9041 description: MAC address for the interface
9044 - name: network-name
9046 description: Name of the network
9049 - name: vlan-id-inner
9051 description: Inner VLAN tag
9057 description: This indicates the customers VPN ID associated with this vlan
9062 - CloudInfrastructure
9063 summary: create or update an existing vlan
9065 Create or update an existing vlan.
9067 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9068 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9077 description: Response codes found in [response codes](https://wiki.onap.org/).
9081 description: Value from executing hostname on the compute node.
9084 example: __HOSTNAME__
9085 - name: interface-name
9087 description: Name that identifies the physical interface
9090 example: __INTERFACE-NAME__
9091 - name: interface-name
9093 description: Name given to the interface
9096 example: __INTERFACE-NAME__
9097 - name: vlan-interface
9099 description: String that identifies the interface
9102 example: __VLAN-INTERFACE__
9105 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
9108 $ref: "#/definitions/vlan"
9111 - CloudInfrastructure
9112 summary: update an existing vlan
9114 Update an existing vlan
9116 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9117 The PUT operation will entirely replace an existing object.
9118 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9120 Other differences between PUT and PATCH are:
9122 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9123 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9124 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9125 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9134 description: Response codes found in [response codes](https://wiki.onap.org/).
9138 description: Value from executing hostname on the compute node.
9141 example: __HOSTNAME__
9142 - name: interface-name
9144 description: Name that identifies the physical interface
9147 example: __INTERFACE-NAME__
9148 - name: interface-name
9150 description: Name given to the interface
9153 example: __INTERFACE-NAME__
9154 - name: vlan-interface
9156 description: String that identifies the interface
9159 example: __VLAN-INTERFACE__
9162 description: vlan object that needs to be created or updated.
9165 $ref: "#/patchDefinitions/vlan"
9168 - CloudInfrastructure
9169 summary: delete an existing vlan
9170 description: delete an existing vlan
9171 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9180 description: Response codes found in [response codes](https://wiki.onap.org/).
9184 description: Value from executing hostname on the compute node.
9187 example: __HOSTNAME__
9188 - name: interface-name
9190 description: Name that identifies the physical interface
9193 example: __INTERFACE-NAME__
9194 - name: interface-name
9196 description: Name given to the interface
9199 example: __INTERFACE-NAME__
9200 - name: vlan-interface
9202 description: String that identifies the interface
9205 example: __VLAN-INTERFACE__
9206 - name: resource-version
9208 description: resource-version for concurrency
9211 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
9214 - CloudInfrastructure
9215 summary: returns vlans
9216 description: returns vlans
9217 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans
9223 description: successful operation
9225 $ref: "#/getDefinitions/vlans"
9227 description: Response codes found in [response codes](https://wiki.onap.org/).
9231 description: Value from executing hostname on the compute node.
9234 example: __HOSTNAME__
9235 - name: interface-name
9237 description: Name that identifies the physical interface
9240 example: __INTERFACE-NAME__
9241 - name: interface-name
9243 description: Name given to the interface
9246 example: __INTERFACE-NAME__
9249 description: ID of Pserver
9256 - name: pserver-name2
9258 description: alternative pserver name
9261 - name: interface-id
9263 description: ID of interface
9268 description: MAC address for the interface
9271 - name: network-name
9273 description: Name of the network
9276 /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:
9279 - CloudInfrastructure
9280 summary: see node definition for valid relationships
9281 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
9290 description: Response codes found in [response codes](https://wiki.onap.org/).
9294 description: Value from executing hostname on the compute node.
9297 example: __HOSTNAME__
9298 - name: interface-name
9300 description: Name that identifies the physical interface
9303 example: __INTERFACE-NAME__
9304 - name: interface-name
9306 description: Name given to the interface
9309 example: __INTERFACE-NAME__
9312 description: PCI ID used to identify the sriov-vf
9318 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
9321 $ref: "#/definitions/relationship"
9324 - CloudInfrastructure
9325 summary: delete an existing relationship
9326 description: delete an existing relationship
9327 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
9336 description: Response codes found in [response codes](https://wiki.onap.org/).
9340 description: Value from executing hostname on the compute node.
9343 example: __HOSTNAME__
9344 - name: interface-name
9346 description: Name that identifies the physical interface
9349 example: __INTERFACE-NAME__
9350 - name: interface-name
9352 description: Name given to the interface
9355 example: __INTERFACE-NAME__
9358 description: PCI ID used to identify the sriov-vf
9362 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
9365 - CloudInfrastructure
9366 summary: returns sriov-vf
9367 description: returns sriov-vf
9368 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9374 description: successful operation
9376 $ref: "#/getDefinitions/sriov-vf"
9378 description: Response codes found in [response codes](https://wiki.onap.org/).
9382 description: Value from executing hostname on the compute node.
9385 example: __HOSTNAME__
9386 - name: interface-name
9388 description: Name that identifies the physical interface
9391 example: __INTERFACE-NAME__
9392 - name: interface-name
9394 description: Name given to the interface
9397 example: __INTERFACE-NAME__
9400 description: PCI ID used to identify the sriov-vf
9406 description: ID of Pserver
9413 - name: pserver-name2
9415 description: alternative pserver name
9418 - name: interface-id
9420 description: ID of interface
9425 description: MAC address for the interface
9428 - name: network-name
9430 description: Name of the network
9433 - name: vf-vlan-filter
9435 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
9438 - name: vf-mac-filter
9440 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
9443 - name: vf-vlan-strip
9445 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
9448 - name: neutron-network-id
9450 description: Neutron network id of the interface
9455 - CloudInfrastructure
9456 summary: create or update an existing sriov-vf
9458 Create or update an existing sriov-vf.
9460 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9461 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9470 description: Response codes found in [response codes](https://wiki.onap.org/).
9474 description: Value from executing hostname on the compute node.
9477 example: __HOSTNAME__
9478 - name: interface-name
9480 description: Name that identifies the physical interface
9483 example: __INTERFACE-NAME__
9484 - name: interface-name
9486 description: Name given to the interface
9489 example: __INTERFACE-NAME__
9492 description: PCI ID used to identify the sriov-vf
9498 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
9501 $ref: "#/definitions/sriov-vf"
9504 - CloudInfrastructure
9505 summary: update an existing sriov-vf
9507 Update an existing sriov-vf
9509 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9510 The PUT operation will entirely replace an existing object.
9511 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9513 Other differences between PUT and PATCH are:
9515 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9516 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9517 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9518 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9527 description: Response codes found in [response codes](https://wiki.onap.org/).
9531 description: Value from executing hostname on the compute node.
9534 example: __HOSTNAME__
9535 - name: interface-name
9537 description: Name that identifies the physical interface
9540 example: __INTERFACE-NAME__
9541 - name: interface-name
9543 description: Name given to the interface
9546 example: __INTERFACE-NAME__
9549 description: PCI ID used to identify the sriov-vf
9555 description: sriov-vf object that needs to be created or updated.
9558 $ref: "#/patchDefinitions/sriov-vf"
9561 - CloudInfrastructure
9562 summary: delete an existing sriov-vf
9563 description: delete an existing sriov-vf
9564 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9573 description: Response codes found in [response codes](https://wiki.onap.org/).
9577 description: Value from executing hostname on the compute node.
9580 example: __HOSTNAME__
9581 - name: interface-name
9583 description: Name that identifies the physical interface
9586 example: __INTERFACE-NAME__
9587 - name: interface-name
9589 description: Name given to the interface
9592 example: __INTERFACE-NAME__
9595 description: PCI ID used to identify the sriov-vf
9599 - name: resource-version
9601 description: resource-version for concurrency
9604 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
9607 - CloudInfrastructure
9608 summary: returns sriov-vfs
9609 description: returns sriov-vfs
9610 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
9616 description: successful operation
9618 $ref: "#/getDefinitions/sriov-vfs"
9620 description: Response codes found in [response codes](https://wiki.onap.org/).
9624 description: Value from executing hostname on the compute node.
9627 example: __HOSTNAME__
9628 - name: interface-name
9630 description: Name that identifies the physical interface
9633 example: __INTERFACE-NAME__
9634 - name: interface-name
9636 description: Name given to the interface
9639 example: __INTERFACE-NAME__
9642 description: ID of Pserver
9649 - name: pserver-name2
9651 description: alternative pserver name
9654 - name: interface-id
9656 description: ID of interface
9661 description: MAC address for the interface
9664 - name: network-name
9666 description: Name of the network
9669 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
9672 - CloudInfrastructure
9673 summary: see node definition for valid relationships
9674 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
9683 description: Response codes found in [response codes](https://wiki.onap.org/).
9687 description: Value from executing hostname on the compute node.
9690 example: __HOSTNAME__
9691 - name: interface-name
9693 description: Name that identifies the physical interface
9696 example: __INTERFACE-NAME__
9697 - name: interface-name
9699 description: Name given to the interface
9702 example: __INTERFACE-NAME__
9705 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
9708 $ref: "#/definitions/relationship"
9711 - CloudInfrastructure
9712 summary: delete an existing relationship
9713 description: delete an existing relationship
9714 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
9723 description: Response codes found in [response codes](https://wiki.onap.org/).
9727 description: Value from executing hostname on the compute node.
9730 example: __HOSTNAME__
9731 - name: interface-name
9733 description: Name that identifies the physical interface
9736 example: __INTERFACE-NAME__
9737 - name: interface-name
9739 description: Name given to the interface
9742 example: __INTERFACE-NAME__
9743 /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:
9746 - CloudInfrastructure
9747 summary: see node definition for valid relationships
9748 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
9757 description: Response codes found in [response codes](https://wiki.onap.org/).
9761 description: Value from executing hostname on the compute node.
9764 example: __HOSTNAME__
9765 - name: interface-name
9767 description: Name that identifies the physical interface
9770 example: __INTERFACE-NAME__
9771 - name: interface-name
9773 description: Name given to the interface
9776 example: __INTERFACE-NAME__
9777 - name: l3-interface-ipv4-address
9779 description: IP address
9782 example: __L3-INTERFACE-IPV4-ADDRESS__
9785 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
9788 $ref: "#/definitions/relationship"
9791 - CloudInfrastructure
9792 summary: delete an existing relationship
9793 description: delete an existing relationship
9794 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
9803 description: Response codes found in [response codes](https://wiki.onap.org/).
9807 description: Value from executing hostname on the compute node.
9810 example: __HOSTNAME__
9811 - name: interface-name
9813 description: Name that identifies the physical interface
9816 example: __INTERFACE-NAME__
9817 - name: interface-name
9819 description: Name given to the interface
9822 example: __INTERFACE-NAME__
9823 - name: l3-interface-ipv4-address
9825 description: IP address
9828 example: __L3-INTERFACE-IPV4-ADDRESS__
9829 /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}:
9832 - CloudInfrastructure
9833 summary: returns l3-interface-ipv4-address-list
9834 description: returns l3-interface-ipv4-address-list
9835 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
9841 description: successful operation
9843 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
9845 description: Response codes found in [response codes](https://wiki.onap.org/).
9849 description: Value from executing hostname on the compute node.
9852 example: __HOSTNAME__
9853 - name: interface-name
9855 description: Name that identifies the physical interface
9858 example: __INTERFACE-NAME__
9859 - name: interface-name
9861 description: Name given to the interface
9864 example: __INTERFACE-NAME__
9865 - name: l3-interface-ipv4-address
9867 description: IP address
9870 example: __L3-INTERFACE-IPV4-ADDRESS__
9873 description: ID of Pserver
9880 - name: pserver-name2
9882 description: alternative pserver name
9885 - name: interface-id
9887 description: ID of interface
9892 description: MAC address for the interface
9895 - name: network-name
9897 description: Name of the network
9900 - name: vlan-id-inner
9902 description: Inner VLAN tag
9906 - name: neutron-network-id
9908 description: Neutron network id of the interface that address belongs to
9911 - name: neutron-subnet-id
9913 description: Neutron id of subnet that address belongs to
9918 - CloudInfrastructure
9919 summary: create or update an existing l3-interface-ipv4-address-list
9921 Create or update an existing l3-interface-ipv4-address-list.
9923 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9924 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
9933 description: Response codes found in [response codes](https://wiki.onap.org/).
9937 description: Value from executing hostname on the compute node.
9940 example: __HOSTNAME__
9941 - name: interface-name
9943 description: Name that identifies the physical interface
9946 example: __INTERFACE-NAME__
9947 - name: interface-name
9949 description: Name given to the interface
9952 example: __INTERFACE-NAME__
9953 - name: l3-interface-ipv4-address
9955 description: IP address
9958 example: __L3-INTERFACE-IPV4-ADDRESS__
9961 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
9964 $ref: "#/definitions/l3-interface-ipv4-address-list"
9967 - CloudInfrastructure
9968 summary: update an existing l3-interface-ipv4-address-list
9970 Update an existing l3-interface-ipv4-address-list
9972 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9973 The PUT operation will entirely replace an existing object.
9974 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9976 Other differences between PUT and PATCH are:
9978 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9979 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9980 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9981 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
9990 description: Response codes found in [response codes](https://wiki.onap.org/).
9994 description: Value from executing hostname on the compute node.
9997 example: __HOSTNAME__
9998 - name: interface-name
10000 description: Name that identifies the physical interface
10003 example: __INTERFACE-NAME__
10004 - name: interface-name
10006 description: Name given to the interface
10009 example: __INTERFACE-NAME__
10010 - name: l3-interface-ipv4-address
10012 description: IP address
10015 example: __L3-INTERFACE-IPV4-ADDRESS__
10018 description: l3-interface-ipv4-address-list object that needs to be created or updated.
10021 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
10024 - CloudInfrastructure
10025 summary: delete an existing l3-interface-ipv4-address-list
10026 description: delete an existing l3-interface-ipv4-address-list
10027 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
10036 description: Response codes found in [response codes](https://wiki.onap.org/).
10040 description: Value from executing hostname on the compute node.
10043 example: __HOSTNAME__
10044 - name: interface-name
10046 description: Name that identifies the physical interface
10049 example: __INTERFACE-NAME__
10050 - name: interface-name
10052 description: Name given to the interface
10055 example: __INTERFACE-NAME__
10056 - name: l3-interface-ipv4-address
10058 description: IP address
10061 example: __L3-INTERFACE-IPV4-ADDRESS__
10062 - name: resource-version
10064 description: resource-version for concurrency
10067 /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:
10070 - CloudInfrastructure
10071 summary: see node definition for valid relationships
10072 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
10081 description: Response codes found in [response codes](https://wiki.onap.org/).
10085 description: Value from executing hostname on the compute node.
10088 example: __HOSTNAME__
10089 - name: interface-name
10091 description: Name that identifies the physical interface
10094 example: __INTERFACE-NAME__
10095 - name: interface-name
10097 description: Name given to the interface
10100 example: __INTERFACE-NAME__
10101 - name: l3-interface-ipv6-address
10103 description: IP address
10106 example: __L3-INTERFACE-IPV6-ADDRESS__
10109 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
10112 $ref: "#/definitions/relationship"
10115 - CloudInfrastructure
10116 summary: delete an existing relationship
10117 description: delete an existing relationship
10118 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
10127 description: Response codes found in [response codes](https://wiki.onap.org/).
10131 description: Value from executing hostname on the compute node.
10134 example: __HOSTNAME__
10135 - name: interface-name
10137 description: Name that identifies the physical interface
10140 example: __INTERFACE-NAME__
10141 - name: interface-name
10143 description: Name given to the interface
10146 example: __INTERFACE-NAME__
10147 - name: l3-interface-ipv6-address
10149 description: IP address
10152 example: __L3-INTERFACE-IPV6-ADDRESS__
10153 /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}:
10156 - CloudInfrastructure
10157 summary: returns l3-interface-ipv6-address-list
10158 description: returns l3-interface-ipv6-address-list
10159 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10165 description: successful operation
10167 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
10169 description: Response codes found in [response codes](https://wiki.onap.org/).
10173 description: Value from executing hostname on the compute node.
10176 example: __HOSTNAME__
10177 - name: interface-name
10179 description: Name that identifies the physical interface
10182 example: __INTERFACE-NAME__
10183 - name: interface-name
10185 description: Name given to the interface
10188 example: __INTERFACE-NAME__
10189 - name: l3-interface-ipv6-address
10191 description: IP address
10194 example: __L3-INTERFACE-IPV6-ADDRESS__
10197 description: ID of Pserver
10204 - name: pserver-name2
10206 description: alternative pserver name
10209 - name: interface-id
10211 description: ID of interface
10216 description: MAC address for the interface
10219 - name: network-name
10221 description: Name of the network
10224 - name: vlan-id-inner
10226 description: Inner VLAN tag
10230 - name: neutron-network-id
10232 description: Neutron network id of the interface that address belongs to
10235 - name: neutron-subnet-id
10237 description: Neutron id of subnet that address belongs to
10242 - CloudInfrastructure
10243 summary: create or update an existing l3-interface-ipv6-address-list
10245 Create or update an existing l3-interface-ipv6-address-list.
10247 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10248 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10257 description: Response codes found in [response codes](https://wiki.onap.org/).
10261 description: Value from executing hostname on the compute node.
10264 example: __HOSTNAME__
10265 - name: interface-name
10267 description: Name that identifies the physical interface
10270 example: __INTERFACE-NAME__
10271 - name: interface-name
10273 description: Name given to the interface
10276 example: __INTERFACE-NAME__
10277 - name: l3-interface-ipv6-address
10279 description: IP address
10282 example: __L3-INTERFACE-IPV6-ADDRESS__
10285 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
10288 $ref: "#/definitions/l3-interface-ipv6-address-list"
10291 - CloudInfrastructure
10292 summary: update an existing l3-interface-ipv6-address-list
10294 Update an existing l3-interface-ipv6-address-list
10296 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10297 The PUT operation will entirely replace an existing object.
10298 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10300 Other differences between PUT and PATCH are:
10302 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10303 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10304 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10305 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10314 description: Response codes found in [response codes](https://wiki.onap.org/).
10318 description: Value from executing hostname on the compute node.
10321 example: __HOSTNAME__
10322 - name: interface-name
10324 description: Name that identifies the physical interface
10327 example: __INTERFACE-NAME__
10328 - name: interface-name
10330 description: Name given to the interface
10333 example: __INTERFACE-NAME__
10334 - name: l3-interface-ipv6-address
10336 description: IP address
10339 example: __L3-INTERFACE-IPV6-ADDRESS__
10342 description: l3-interface-ipv6-address-list object that needs to be created or updated.
10345 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
10348 - CloudInfrastructure
10349 summary: delete an existing l3-interface-ipv6-address-list
10350 description: delete an existing l3-interface-ipv6-address-list
10351 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10360 description: Response codes found in [response codes](https://wiki.onap.org/).
10364 description: Value from executing hostname on the compute node.
10367 example: __HOSTNAME__
10368 - name: interface-name
10370 description: Name that identifies the physical interface
10373 example: __INTERFACE-NAME__
10374 - name: interface-name
10376 description: Name given to the interface
10379 example: __INTERFACE-NAME__
10380 - name: l3-interface-ipv6-address
10382 description: IP address
10385 example: __L3-INTERFACE-IPV6-ADDRESS__
10386 - name: resource-version
10388 description: resource-version for concurrency
10391 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
10394 - CloudInfrastructure
10395 summary: returns l-interface
10396 description: returns l-interface
10397 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10403 description: successful operation
10405 $ref: "#/getDefinitions/l-interface"
10407 description: Response codes found in [response codes](https://wiki.onap.org/).
10411 description: Value from executing hostname on the compute node.
10414 example: __HOSTNAME__
10415 - name: interface-name
10417 description: Name that identifies the physical interface
10420 example: __INTERFACE-NAME__
10421 - name: interface-name
10423 description: Name given to the interface
10426 example: __INTERFACE-NAME__
10429 description: ID of Pserver
10436 - name: pserver-name2
10438 description: alternative pserver name
10441 - name: interface-id
10443 description: ID of interface
10448 description: MAC address for the interface
10451 - name: network-name
10453 description: Name of the network
10458 - CloudInfrastructure
10459 summary: create or update an existing l-interface
10461 Create or update an existing l-interface.
10463 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10464 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10473 description: Response codes found in [response codes](https://wiki.onap.org/).
10477 description: Value from executing hostname on the compute node.
10480 example: __HOSTNAME__
10481 - name: interface-name
10483 description: Name that identifies the physical interface
10486 example: __INTERFACE-NAME__
10487 - name: interface-name
10489 description: Name given to the interface
10492 example: __INTERFACE-NAME__
10495 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
10498 $ref: "#/definitions/l-interface"
10501 - CloudInfrastructure
10502 summary: update an existing l-interface
10504 Update an existing l-interface
10506 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10507 The PUT operation will entirely replace an existing object.
10508 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10510 Other differences between PUT and PATCH are:
10512 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10513 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10514 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10515 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10524 description: Response codes found in [response codes](https://wiki.onap.org/).
10528 description: Value from executing hostname on the compute node.
10531 example: __HOSTNAME__
10532 - name: interface-name
10534 description: Name that identifies the physical interface
10537 example: __INTERFACE-NAME__
10538 - name: interface-name
10540 description: Name given to the interface
10543 example: __INTERFACE-NAME__
10546 description: l-interface object that needs to be created or updated.
10549 $ref: "#/patchDefinitions/l-interface"
10552 - CloudInfrastructure
10553 summary: delete an existing l-interface
10554 description: delete an existing l-interface
10555 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10564 description: Response codes found in [response codes](https://wiki.onap.org/).
10568 description: Value from executing hostname on the compute node.
10571 example: __HOSTNAME__
10572 - name: interface-name
10574 description: Name that identifies the physical interface
10577 example: __INTERFACE-NAME__
10578 - name: interface-name
10580 description: Name given to the interface
10583 example: __INTERFACE-NAME__
10584 - name: resource-version
10586 description: resource-version for concurrency
10589 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces:
10592 - CloudInfrastructure
10593 summary: returns l-interfaces
10594 description: returns l-interfaces
10595 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces
10601 description: successful operation
10603 $ref: "#/getDefinitions/l-interfaces"
10605 description: Response codes found in [response codes](https://wiki.onap.org/).
10609 description: Value from executing hostname on the compute node.
10612 example: __HOSTNAME__
10613 - name: interface-name
10615 description: Name that identifies the physical interface
10618 example: __INTERFACE-NAME__
10621 description: ID of Pserver
10628 - name: pserver-name2
10630 description: alternative pserver name
10633 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}:
10636 - CloudInfrastructure
10637 summary: returns p-interface
10638 description: returns p-interface
10639 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface
10645 description: successful operation
10647 $ref: "#/getDefinitions/p-interface"
10649 description: Response codes found in [response codes](https://wiki.onap.org/).
10653 description: Value from executing hostname on the compute node.
10656 example: __HOSTNAME__
10657 - name: interface-name
10659 description: Name that identifies the physical interface
10662 example: __INTERFACE-NAME__
10665 description: ID of Pserver
10672 - name: pserver-name2
10674 description: alternative pserver name
10679 - CloudInfrastructure
10680 summary: create or update an existing p-interface
10682 Create or update an existing p-interface.
10684 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10685 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface
10694 description: Response codes found in [response codes](https://wiki.onap.org/).
10698 description: Value from executing hostname on the compute node.
10701 example: __HOSTNAME__
10702 - name: interface-name
10704 description: Name that identifies the physical interface
10707 example: __INTERFACE-NAME__
10710 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
10713 $ref: "#/definitions/p-interface"
10716 - CloudInfrastructure
10717 summary: update an existing p-interface
10719 Update an existing p-interface
10721 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10722 The PUT operation will entirely replace an existing object.
10723 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10725 Other differences between PUT and PATCH are:
10727 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10728 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10729 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10730 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterface
10739 description: Response codes found in [response codes](https://wiki.onap.org/).
10743 description: Value from executing hostname on the compute node.
10746 example: __HOSTNAME__
10747 - name: interface-name
10749 description: Name that identifies the physical interface
10752 example: __INTERFACE-NAME__
10755 description: p-interface object that needs to be created or updated.
10758 $ref: "#/patchDefinitions/p-interface"
10761 - CloudInfrastructure
10762 summary: delete an existing p-interface
10763 description: delete an existing p-interface
10764 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface
10773 description: Response codes found in [response codes](https://wiki.onap.org/).
10777 description: Value from executing hostname on the compute node.
10780 example: __HOSTNAME__
10781 - name: interface-name
10783 description: Name that identifies the physical interface
10786 example: __INTERFACE-NAME__
10787 - name: resource-version
10789 description: resource-version for concurrency
10792 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces:
10795 - CloudInfrastructure
10796 summary: returns p-interfaces
10797 description: returns p-interfaces
10798 operationId: getCloudInfrastructurePserversPserverPInterfaces
10804 description: successful operation
10806 $ref: "#/getDefinitions/p-interfaces"
10808 description: Response codes found in [response codes](https://wiki.onap.org/).
10812 description: Value from executing hostname on the compute node.
10815 example: __HOSTNAME__
10818 description: ID of Pserver
10825 - name: pserver-name2
10827 description: alternative pserver name
10830 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
10833 - CloudInfrastructure
10834 summary: see node definition for valid relationships
10835 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
10844 description: Response codes found in [response codes](https://wiki.onap.org/).
10848 description: Value from executing hostname on the compute node.
10851 example: __HOSTNAME__
10852 - name: interface-name
10854 description: Name that identifies the link aggregate interface
10857 example: __INTERFACE-NAME__
10860 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
10863 $ref: "#/definitions/relationship"
10866 - CloudInfrastructure
10867 summary: delete an existing relationship
10868 description: delete an existing relationship
10869 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
10878 description: Response codes found in [response codes](https://wiki.onap.org/).
10882 description: Value from executing hostname on the compute node.
10885 example: __HOSTNAME__
10886 - name: interface-name
10888 description: Name that identifies the link aggregate interface
10891 example: __INTERFACE-NAME__
10892 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
10895 - CloudInfrastructure
10896 summary: see node definition for valid relationships
10897 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
10906 description: Response codes found in [response codes](https://wiki.onap.org/).
10910 description: Value from executing hostname on the compute node.
10913 example: __HOSTNAME__
10914 - name: interface-name
10916 description: Name that identifies the link aggregate interface
10919 example: __INTERFACE-NAME__
10920 - name: interface-name
10922 description: Name given to the interface
10925 example: __INTERFACE-NAME__
10926 - name: vlan-interface
10928 description: String that identifies the interface
10931 example: __VLAN-INTERFACE__
10934 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
10937 $ref: "#/definitions/relationship"
10940 - CloudInfrastructure
10941 summary: delete an existing relationship
10942 description: delete an existing relationship
10943 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
10952 description: Response codes found in [response codes](https://wiki.onap.org/).
10956 description: Value from executing hostname on the compute node.
10959 example: __HOSTNAME__
10960 - name: interface-name
10962 description: Name that identifies the link aggregate interface
10965 example: __INTERFACE-NAME__
10966 - name: interface-name
10968 description: Name given to the interface
10971 example: __INTERFACE-NAME__
10972 - name: vlan-interface
10974 description: String that identifies the interface
10977 example: __VLAN-INTERFACE__
10978 /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:
10981 - CloudInfrastructure
10982 summary: see node definition for valid relationships
10983 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
10992 description: Response codes found in [response codes](https://wiki.onap.org/).
10996 description: Value from executing hostname on the compute node.
10999 example: __HOSTNAME__
11000 - name: interface-name
11002 description: Name that identifies the link aggregate interface
11005 example: __INTERFACE-NAME__
11006 - name: interface-name
11008 description: Name given to the interface
11011 example: __INTERFACE-NAME__
11012 - name: vlan-interface
11014 description: String that identifies the interface
11017 example: __VLAN-INTERFACE__
11018 - name: l3-interface-ipv4-address
11020 description: IP address
11023 example: __L3-INTERFACE-IPV4-ADDRESS__
11026 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
11029 $ref: "#/definitions/relationship"
11032 - CloudInfrastructure
11033 summary: delete an existing relationship
11034 description: delete an existing relationship
11035 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
11044 description: Response codes found in [response codes](https://wiki.onap.org/).
11048 description: Value from executing hostname on the compute node.
11051 example: __HOSTNAME__
11052 - name: interface-name
11054 description: Name that identifies the link aggregate interface
11057 example: __INTERFACE-NAME__
11058 - name: interface-name
11060 description: Name given to the interface
11063 example: __INTERFACE-NAME__
11064 - name: vlan-interface
11066 description: String that identifies the interface
11069 example: __VLAN-INTERFACE__
11070 - name: l3-interface-ipv4-address
11072 description: IP address
11075 example: __L3-INTERFACE-IPV4-ADDRESS__
11076 /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}:
11079 - CloudInfrastructure
11080 summary: returns l3-interface-ipv4-address-list
11081 description: returns l3-interface-ipv4-address-list
11082 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11088 description: successful operation
11090 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
11092 description: Response codes found in [response codes](https://wiki.onap.org/).
11096 description: Value from executing hostname on the compute node.
11099 example: __HOSTNAME__
11100 - name: interface-name
11102 description: Name that identifies the link aggregate interface
11105 example: __INTERFACE-NAME__
11106 - name: interface-name
11108 description: Name given to the interface
11111 example: __INTERFACE-NAME__
11112 - name: vlan-interface
11114 description: String that identifies the interface
11117 example: __VLAN-INTERFACE__
11118 - name: l3-interface-ipv4-address
11120 description: IP address
11123 example: __L3-INTERFACE-IPV4-ADDRESS__
11126 description: ID of Pserver
11133 - name: pserver-name2
11135 description: alternative pserver name
11138 - name: interface-id
11140 description: ID of interface
11145 description: MAC address for the interface
11148 - name: network-name
11150 description: Name of the network
11153 - name: vlan-id-inner
11155 description: Inner VLAN tag
11161 description: This indicates the customers VPN ID associated with this vlan
11164 - name: vlan-id-inner
11166 description: Inner VLAN tag
11170 - name: neutron-network-id
11172 description: Neutron network id of the interface that address belongs to
11175 - name: neutron-subnet-id
11177 description: Neutron id of subnet that address belongs to
11182 - CloudInfrastructure
11183 summary: create or update an existing l3-interface-ipv4-address-list
11185 Create or update an existing l3-interface-ipv4-address-list.
11187 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11188 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11197 description: Response codes found in [response codes](https://wiki.onap.org/).
11201 description: Value from executing hostname on the compute node.
11204 example: __HOSTNAME__
11205 - name: interface-name
11207 description: Name that identifies the link aggregate interface
11210 example: __INTERFACE-NAME__
11211 - name: interface-name
11213 description: Name given to the interface
11216 example: __INTERFACE-NAME__
11217 - name: vlan-interface
11219 description: String that identifies the interface
11222 example: __VLAN-INTERFACE__
11223 - name: l3-interface-ipv4-address
11225 description: IP address
11228 example: __L3-INTERFACE-IPV4-ADDRESS__
11231 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
11234 $ref: "#/definitions/l3-interface-ipv4-address-list"
11237 - CloudInfrastructure
11238 summary: update an existing l3-interface-ipv4-address-list
11240 Update an existing l3-interface-ipv4-address-list
11242 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11243 The PUT operation will entirely replace an existing object.
11244 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11246 Other differences between PUT and PATCH are:
11248 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11249 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11250 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11251 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11260 description: Response codes found in [response codes](https://wiki.onap.org/).
11264 description: Value from executing hostname on the compute node.
11267 example: __HOSTNAME__
11268 - name: interface-name
11270 description: Name that identifies the link aggregate interface
11273 example: __INTERFACE-NAME__
11274 - name: interface-name
11276 description: Name given to the interface
11279 example: __INTERFACE-NAME__
11280 - name: vlan-interface
11282 description: String that identifies the interface
11285 example: __VLAN-INTERFACE__
11286 - name: l3-interface-ipv4-address
11288 description: IP address
11291 example: __L3-INTERFACE-IPV4-ADDRESS__
11294 description: l3-interface-ipv4-address-list object that needs to be created or updated.
11297 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
11300 - CloudInfrastructure
11301 summary: delete an existing l3-interface-ipv4-address-list
11302 description: delete an existing l3-interface-ipv4-address-list
11303 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11312 description: Response codes found in [response codes](https://wiki.onap.org/).
11316 description: Value from executing hostname on the compute node.
11319 example: __HOSTNAME__
11320 - name: interface-name
11322 description: Name that identifies the link aggregate interface
11325 example: __INTERFACE-NAME__
11326 - name: interface-name
11328 description: Name given to the interface
11331 example: __INTERFACE-NAME__
11332 - name: vlan-interface
11334 description: String that identifies the interface
11337 example: __VLAN-INTERFACE__
11338 - name: l3-interface-ipv4-address
11340 description: IP address
11343 example: __L3-INTERFACE-IPV4-ADDRESS__
11344 - name: resource-version
11346 description: resource-version for concurrency
11349 /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:
11352 - CloudInfrastructure
11353 summary: see node definition for valid relationships
11354 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
11363 description: Response codes found in [response codes](https://wiki.onap.org/).
11367 description: Value from executing hostname on the compute node.
11370 example: __HOSTNAME__
11371 - name: interface-name
11373 description: Name that identifies the link aggregate interface
11376 example: __INTERFACE-NAME__
11377 - name: interface-name
11379 description: Name given to the interface
11382 example: __INTERFACE-NAME__
11383 - name: vlan-interface
11385 description: String that identifies the interface
11388 example: __VLAN-INTERFACE__
11389 - name: l3-interface-ipv6-address
11391 description: IP address
11394 example: __L3-INTERFACE-IPV6-ADDRESS__
11397 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
11400 $ref: "#/definitions/relationship"
11403 - CloudInfrastructure
11404 summary: delete an existing relationship
11405 description: delete an existing relationship
11406 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
11415 description: Response codes found in [response codes](https://wiki.onap.org/).
11419 description: Value from executing hostname on the compute node.
11422 example: __HOSTNAME__
11423 - name: interface-name
11425 description: Name that identifies the link aggregate interface
11428 example: __INTERFACE-NAME__
11429 - name: interface-name
11431 description: Name given to the interface
11434 example: __INTERFACE-NAME__
11435 - name: vlan-interface
11437 description: String that identifies the interface
11440 example: __VLAN-INTERFACE__
11441 - name: l3-interface-ipv6-address
11443 description: IP address
11446 example: __L3-INTERFACE-IPV6-ADDRESS__
11447 /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}:
11450 - CloudInfrastructure
11451 summary: returns l3-interface-ipv6-address-list
11452 description: returns l3-interface-ipv6-address-list
11453 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11459 description: successful operation
11461 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
11463 description: Response codes found in [response codes](https://wiki.onap.org/).
11467 description: Value from executing hostname on the compute node.
11470 example: __HOSTNAME__
11471 - name: interface-name
11473 description: Name that identifies the link aggregate interface
11476 example: __INTERFACE-NAME__
11477 - name: interface-name
11479 description: Name given to the interface
11482 example: __INTERFACE-NAME__
11483 - name: vlan-interface
11485 description: String that identifies the interface
11488 example: __VLAN-INTERFACE__
11489 - name: l3-interface-ipv6-address
11491 description: IP address
11494 example: __L3-INTERFACE-IPV6-ADDRESS__
11497 description: ID of Pserver
11504 - name: pserver-name2
11506 description: alternative pserver name
11509 - name: interface-id
11511 description: ID of interface
11516 description: MAC address for the interface
11519 - name: network-name
11521 description: Name of the network
11524 - name: vlan-id-inner
11526 description: Inner VLAN tag
11532 description: This indicates the customers VPN ID associated with this vlan
11535 - name: vlan-id-inner
11537 description: Inner VLAN tag
11541 - name: neutron-network-id
11543 description: Neutron network id of the interface that address belongs to
11546 - name: neutron-subnet-id
11548 description: Neutron id of subnet that address belongs to
11553 - CloudInfrastructure
11554 summary: create or update an existing l3-interface-ipv6-address-list
11556 Create or update an existing l3-interface-ipv6-address-list.
11558 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11559 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11568 description: Response codes found in [response codes](https://wiki.onap.org/).
11572 description: Value from executing hostname on the compute node.
11575 example: __HOSTNAME__
11576 - name: interface-name
11578 description: Name that identifies the link aggregate interface
11581 example: __INTERFACE-NAME__
11582 - name: interface-name
11584 description: Name given to the interface
11587 example: __INTERFACE-NAME__
11588 - name: vlan-interface
11590 description: String that identifies the interface
11593 example: __VLAN-INTERFACE__
11594 - name: l3-interface-ipv6-address
11596 description: IP address
11599 example: __L3-INTERFACE-IPV6-ADDRESS__
11602 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
11605 $ref: "#/definitions/l3-interface-ipv6-address-list"
11608 - CloudInfrastructure
11609 summary: update an existing l3-interface-ipv6-address-list
11611 Update an existing l3-interface-ipv6-address-list
11613 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11614 The PUT operation will entirely replace an existing object.
11615 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11617 Other differences between PUT and PATCH are:
11619 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11620 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11621 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11622 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11631 description: Response codes found in [response codes](https://wiki.onap.org/).
11635 description: Value from executing hostname on the compute node.
11638 example: __HOSTNAME__
11639 - name: interface-name
11641 description: Name that identifies the link aggregate interface
11644 example: __INTERFACE-NAME__
11645 - name: interface-name
11647 description: Name given to the interface
11650 example: __INTERFACE-NAME__
11651 - name: vlan-interface
11653 description: String that identifies the interface
11656 example: __VLAN-INTERFACE__
11657 - name: l3-interface-ipv6-address
11659 description: IP address
11662 example: __L3-INTERFACE-IPV6-ADDRESS__
11665 description: l3-interface-ipv6-address-list object that needs to be created or updated.
11668 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
11671 - CloudInfrastructure
11672 summary: delete an existing l3-interface-ipv6-address-list
11673 description: delete an existing l3-interface-ipv6-address-list
11674 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11683 description: Response codes found in [response codes](https://wiki.onap.org/).
11687 description: Value from executing hostname on the compute node.
11690 example: __HOSTNAME__
11691 - name: interface-name
11693 description: Name that identifies the link aggregate interface
11696 example: __INTERFACE-NAME__
11697 - name: interface-name
11699 description: Name given to the interface
11702 example: __INTERFACE-NAME__
11703 - name: vlan-interface
11705 description: String that identifies the interface
11708 example: __VLAN-INTERFACE__
11709 - name: l3-interface-ipv6-address
11711 description: IP address
11714 example: __L3-INTERFACE-IPV6-ADDRESS__
11715 - name: resource-version
11717 description: resource-version for concurrency
11720 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
11723 - CloudInfrastructure
11724 summary: returns vlan
11725 description: returns vlan
11726 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
11732 description: successful operation
11734 $ref: "#/getDefinitions/vlan"
11736 description: Response codes found in [response codes](https://wiki.onap.org/).
11740 description: Value from executing hostname on the compute node.
11743 example: __HOSTNAME__
11744 - name: interface-name
11746 description: Name that identifies the link aggregate interface
11749 example: __INTERFACE-NAME__
11750 - name: interface-name
11752 description: Name given to the interface
11755 example: __INTERFACE-NAME__
11756 - name: vlan-interface
11758 description: String that identifies the interface
11761 example: __VLAN-INTERFACE__
11764 description: ID of Pserver
11771 - name: pserver-name2
11773 description: alternative pserver name
11776 - name: interface-id
11778 description: ID of interface
11783 description: MAC address for the interface
11786 - name: network-name
11788 description: Name of the network
11791 - name: vlan-id-inner
11793 description: Inner VLAN tag
11799 description: This indicates the customers VPN ID associated with this vlan
11804 - CloudInfrastructure
11805 summary: create or update an existing vlan
11807 Create or update an existing vlan.
11809 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11810 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
11819 description: Response codes found in [response codes](https://wiki.onap.org/).
11823 description: Value from executing hostname on the compute node.
11826 example: __HOSTNAME__
11827 - name: interface-name
11829 description: Name that identifies the link aggregate interface
11832 example: __INTERFACE-NAME__
11833 - name: interface-name
11835 description: Name given to the interface
11838 example: __INTERFACE-NAME__
11839 - name: vlan-interface
11841 description: String that identifies the interface
11844 example: __VLAN-INTERFACE__
11847 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
11850 $ref: "#/definitions/vlan"
11853 - CloudInfrastructure
11854 summary: update an existing vlan
11856 Update an existing vlan
11858 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11859 The PUT operation will entirely replace an existing object.
11860 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11862 Other differences between PUT and PATCH are:
11864 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11865 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11866 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11867 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
11876 description: Response codes found in [response codes](https://wiki.onap.org/).
11880 description: Value from executing hostname on the compute node.
11883 example: __HOSTNAME__
11884 - name: interface-name
11886 description: Name that identifies the link aggregate interface
11889 example: __INTERFACE-NAME__
11890 - name: interface-name
11892 description: Name given to the interface
11895 example: __INTERFACE-NAME__
11896 - name: vlan-interface
11898 description: String that identifies the interface
11901 example: __VLAN-INTERFACE__
11904 description: vlan object that needs to be created or updated.
11907 $ref: "#/patchDefinitions/vlan"
11910 - CloudInfrastructure
11911 summary: delete an existing vlan
11912 description: delete an existing vlan
11913 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
11922 description: Response codes found in [response codes](https://wiki.onap.org/).
11926 description: Value from executing hostname on the compute node.
11929 example: __HOSTNAME__
11930 - name: interface-name
11932 description: Name that identifies the link aggregate interface
11935 example: __INTERFACE-NAME__
11936 - name: interface-name
11938 description: Name given to the interface
11941 example: __INTERFACE-NAME__
11942 - name: vlan-interface
11944 description: String that identifies the interface
11947 example: __VLAN-INTERFACE__
11948 - name: resource-version
11950 description: resource-version for concurrency
11953 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
11956 - CloudInfrastructure
11957 summary: returns vlans
11958 description: returns vlans
11959 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
11965 description: successful operation
11967 $ref: "#/getDefinitions/vlans"
11969 description: Response codes found in [response codes](https://wiki.onap.org/).
11973 description: Value from executing hostname on the compute node.
11976 example: __HOSTNAME__
11977 - name: interface-name
11979 description: Name that identifies the link aggregate interface
11982 example: __INTERFACE-NAME__
11983 - name: interface-name
11985 description: Name given to the interface
11988 example: __INTERFACE-NAME__
11991 description: ID of Pserver
11998 - name: pserver-name2
12000 description: alternative pserver name
12003 - name: interface-id
12005 description: ID of interface
12010 description: MAC address for the interface
12013 - name: network-name
12015 description: Name of the network
12018 /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:
12021 - CloudInfrastructure
12022 summary: see node definition for valid relationships
12023 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
12032 description: Response codes found in [response codes](https://wiki.onap.org/).
12036 description: Value from executing hostname on the compute node.
12039 example: __HOSTNAME__
12040 - name: interface-name
12042 description: Name that identifies the link aggregate interface
12045 example: __INTERFACE-NAME__
12046 - name: interface-name
12048 description: Name given to the interface
12051 example: __INTERFACE-NAME__
12054 description: PCI ID used to identify the sriov-vf
12057 example: __PCI-ID__
12060 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
12063 $ref: "#/definitions/relationship"
12066 - CloudInfrastructure
12067 summary: delete an existing relationship
12068 description: delete an existing relationship
12069 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
12078 description: Response codes found in [response codes](https://wiki.onap.org/).
12082 description: Value from executing hostname on the compute node.
12085 example: __HOSTNAME__
12086 - name: interface-name
12088 description: Name that identifies the link aggregate interface
12091 example: __INTERFACE-NAME__
12092 - name: interface-name
12094 description: Name given to the interface
12097 example: __INTERFACE-NAME__
12100 description: PCI ID used to identify the sriov-vf
12103 example: __PCI-ID__
12104 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
12107 - CloudInfrastructure
12108 summary: returns sriov-vf
12109 description: returns sriov-vf
12110 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12116 description: successful operation
12118 $ref: "#/getDefinitions/sriov-vf"
12120 description: Response codes found in [response codes](https://wiki.onap.org/).
12124 description: Value from executing hostname on the compute node.
12127 example: __HOSTNAME__
12128 - name: interface-name
12130 description: Name that identifies the link aggregate interface
12133 example: __INTERFACE-NAME__
12134 - name: interface-name
12136 description: Name given to the interface
12139 example: __INTERFACE-NAME__
12142 description: PCI ID used to identify the sriov-vf
12145 example: __PCI-ID__
12148 description: ID of Pserver
12155 - name: pserver-name2
12157 description: alternative pserver name
12160 - name: interface-id
12162 description: ID of interface
12167 description: MAC address for the interface
12170 - name: network-name
12172 description: Name of the network
12175 - name: vf-vlan-filter
12177 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
12180 - name: vf-mac-filter
12182 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
12185 - name: vf-vlan-strip
12187 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
12190 - name: neutron-network-id
12192 description: Neutron network id of the interface
12197 - CloudInfrastructure
12198 summary: create or update an existing sriov-vf
12200 Create or update an existing sriov-vf.
12202 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12203 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12212 description: Response codes found in [response codes](https://wiki.onap.org/).
12216 description: Value from executing hostname on the compute node.
12219 example: __HOSTNAME__
12220 - name: interface-name
12222 description: Name that identifies the link aggregate interface
12225 example: __INTERFACE-NAME__
12226 - name: interface-name
12228 description: Name given to the interface
12231 example: __INTERFACE-NAME__
12234 description: PCI ID used to identify the sriov-vf
12237 example: __PCI-ID__
12240 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
12243 $ref: "#/definitions/sriov-vf"
12246 - CloudInfrastructure
12247 summary: update an existing sriov-vf
12249 Update an existing sriov-vf
12251 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12252 The PUT operation will entirely replace an existing object.
12253 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12255 Other differences between PUT and PATCH are:
12257 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12258 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12259 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12260 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12269 description: Response codes found in [response codes](https://wiki.onap.org/).
12273 description: Value from executing hostname on the compute node.
12276 example: __HOSTNAME__
12277 - name: interface-name
12279 description: Name that identifies the link aggregate interface
12282 example: __INTERFACE-NAME__
12283 - name: interface-name
12285 description: Name given to the interface
12288 example: __INTERFACE-NAME__
12291 description: PCI ID used to identify the sriov-vf
12294 example: __PCI-ID__
12297 description: sriov-vf object that needs to be created or updated.
12300 $ref: "#/patchDefinitions/sriov-vf"
12303 - CloudInfrastructure
12304 summary: delete an existing sriov-vf
12305 description: delete an existing sriov-vf
12306 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12315 description: Response codes found in [response codes](https://wiki.onap.org/).
12319 description: Value from executing hostname on the compute node.
12322 example: __HOSTNAME__
12323 - name: interface-name
12325 description: Name that identifies the link aggregate interface
12328 example: __INTERFACE-NAME__
12329 - name: interface-name
12331 description: Name given to the interface
12334 example: __INTERFACE-NAME__
12337 description: PCI ID used to identify the sriov-vf
12340 example: __PCI-ID__
12341 - name: resource-version
12343 description: resource-version for concurrency
12346 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
12349 - CloudInfrastructure
12350 summary: returns sriov-vfs
12351 description: returns sriov-vfs
12352 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
12358 description: successful operation
12360 $ref: "#/getDefinitions/sriov-vfs"
12362 description: Response codes found in [response codes](https://wiki.onap.org/).
12366 description: Value from executing hostname on the compute node.
12369 example: __HOSTNAME__
12370 - name: interface-name
12372 description: Name that identifies the link aggregate interface
12375 example: __INTERFACE-NAME__
12376 - name: interface-name
12378 description: Name given to the interface
12381 example: __INTERFACE-NAME__
12384 description: ID of Pserver
12391 - name: pserver-name2
12393 description: alternative pserver name
12396 - name: interface-id
12398 description: ID of interface
12403 description: MAC address for the interface
12406 - name: network-name
12408 description: Name of the network
12411 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
12414 - CloudInfrastructure
12415 summary: see node definition for valid relationships
12416 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
12425 description: Response codes found in [response codes](https://wiki.onap.org/).
12429 description: Value from executing hostname on the compute node.
12432 example: __HOSTNAME__
12433 - name: interface-name
12435 description: Name that identifies the link aggregate interface
12438 example: __INTERFACE-NAME__
12439 - name: interface-name
12441 description: Name given to the interface
12444 example: __INTERFACE-NAME__
12447 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
12450 $ref: "#/definitions/relationship"
12453 - CloudInfrastructure
12454 summary: delete an existing relationship
12455 description: delete an existing relationship
12456 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
12465 description: Response codes found in [response codes](https://wiki.onap.org/).
12469 description: Value from executing hostname on the compute node.
12472 example: __HOSTNAME__
12473 - name: interface-name
12475 description: Name that identifies the link aggregate interface
12478 example: __INTERFACE-NAME__
12479 - name: interface-name
12481 description: Name given to the interface
12484 example: __INTERFACE-NAME__
12485 /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:
12488 - CloudInfrastructure
12489 summary: see node definition for valid relationships
12490 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
12499 description: Response codes found in [response codes](https://wiki.onap.org/).
12503 description: Value from executing hostname on the compute node.
12506 example: __HOSTNAME__
12507 - name: interface-name
12509 description: Name that identifies the link aggregate interface
12512 example: __INTERFACE-NAME__
12513 - name: interface-name
12515 description: Name given to the interface
12518 example: __INTERFACE-NAME__
12519 - name: l3-interface-ipv4-address
12521 description: IP address
12524 example: __L3-INTERFACE-IPV4-ADDRESS__
12527 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
12530 $ref: "#/definitions/relationship"
12533 - CloudInfrastructure
12534 summary: delete an existing relationship
12535 description: delete an existing relationship
12536 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
12545 description: Response codes found in [response codes](https://wiki.onap.org/).
12549 description: Value from executing hostname on the compute node.
12552 example: __HOSTNAME__
12553 - name: interface-name
12555 description: Name that identifies the link aggregate interface
12558 example: __INTERFACE-NAME__
12559 - name: interface-name
12561 description: Name given to the interface
12564 example: __INTERFACE-NAME__
12565 - name: l3-interface-ipv4-address
12567 description: IP address
12570 example: __L3-INTERFACE-IPV4-ADDRESS__
12571 /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}:
12574 - CloudInfrastructure
12575 summary: returns l3-interface-ipv4-address-list
12576 description: returns l3-interface-ipv4-address-list
12577 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12583 description: successful operation
12585 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
12587 description: Response codes found in [response codes](https://wiki.onap.org/).
12591 description: Value from executing hostname on the compute node.
12594 example: __HOSTNAME__
12595 - name: interface-name
12597 description: Name that identifies the link aggregate interface
12600 example: __INTERFACE-NAME__
12601 - name: interface-name
12603 description: Name given to the interface
12606 example: __INTERFACE-NAME__
12607 - name: l3-interface-ipv4-address
12609 description: IP address
12612 example: __L3-INTERFACE-IPV4-ADDRESS__
12615 description: ID of Pserver
12622 - name: pserver-name2
12624 description: alternative pserver name
12627 - name: interface-id
12629 description: ID of interface
12634 description: MAC address for the interface
12637 - name: network-name
12639 description: Name of the network
12642 - name: vlan-id-inner
12644 description: Inner VLAN tag
12648 - name: neutron-network-id
12650 description: Neutron network id of the interface that address belongs to
12653 - name: neutron-subnet-id
12655 description: Neutron id of subnet that address belongs to
12660 - CloudInfrastructure
12661 summary: create or update an existing l3-interface-ipv4-address-list
12663 Create or update an existing l3-interface-ipv4-address-list.
12665 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12666 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12675 description: Response codes found in [response codes](https://wiki.onap.org/).
12679 description: Value from executing hostname on the compute node.
12682 example: __HOSTNAME__
12683 - name: interface-name
12685 description: Name that identifies the link aggregate interface
12688 example: __INTERFACE-NAME__
12689 - name: interface-name
12691 description: Name given to the interface
12694 example: __INTERFACE-NAME__
12695 - name: l3-interface-ipv4-address
12697 description: IP address
12700 example: __L3-INTERFACE-IPV4-ADDRESS__
12703 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
12706 $ref: "#/definitions/l3-interface-ipv4-address-list"
12709 - CloudInfrastructure
12710 summary: update an existing l3-interface-ipv4-address-list
12712 Update an existing l3-interface-ipv4-address-list
12714 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12715 The PUT operation will entirely replace an existing object.
12716 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12718 Other differences between PUT and PATCH are:
12720 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12721 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12722 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12723 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12732 description: Response codes found in [response codes](https://wiki.onap.org/).
12736 description: Value from executing hostname on the compute node.
12739 example: __HOSTNAME__
12740 - name: interface-name
12742 description: Name that identifies the link aggregate interface
12745 example: __INTERFACE-NAME__
12746 - name: interface-name
12748 description: Name given to the interface
12751 example: __INTERFACE-NAME__
12752 - name: l3-interface-ipv4-address
12754 description: IP address
12757 example: __L3-INTERFACE-IPV4-ADDRESS__
12760 description: l3-interface-ipv4-address-list object that needs to be created or updated.
12763 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
12766 - CloudInfrastructure
12767 summary: delete an existing l3-interface-ipv4-address-list
12768 description: delete an existing l3-interface-ipv4-address-list
12769 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12778 description: Response codes found in [response codes](https://wiki.onap.org/).
12782 description: Value from executing hostname on the compute node.
12785 example: __HOSTNAME__
12786 - name: interface-name
12788 description: Name that identifies the link aggregate interface
12791 example: __INTERFACE-NAME__
12792 - name: interface-name
12794 description: Name given to the interface
12797 example: __INTERFACE-NAME__
12798 - name: l3-interface-ipv4-address
12800 description: IP address
12803 example: __L3-INTERFACE-IPV4-ADDRESS__
12804 - name: resource-version
12806 description: resource-version for concurrency
12809 /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:
12812 - CloudInfrastructure
12813 summary: see node definition for valid relationships
12814 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
12823 description: Response codes found in [response codes](https://wiki.onap.org/).
12827 description: Value from executing hostname on the compute node.
12830 example: __HOSTNAME__
12831 - name: interface-name
12833 description: Name that identifies the link aggregate interface
12836 example: __INTERFACE-NAME__
12837 - name: interface-name
12839 description: Name given to the interface
12842 example: __INTERFACE-NAME__
12843 - name: l3-interface-ipv6-address
12845 description: IP address
12848 example: __L3-INTERFACE-IPV6-ADDRESS__
12851 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
12854 $ref: "#/definitions/relationship"
12857 - CloudInfrastructure
12858 summary: delete an existing relationship
12859 description: delete an existing relationship
12860 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
12869 description: Response codes found in [response codes](https://wiki.onap.org/).
12873 description: Value from executing hostname on the compute node.
12876 example: __HOSTNAME__
12877 - name: interface-name
12879 description: Name that identifies the link aggregate interface
12882 example: __INTERFACE-NAME__
12883 - name: interface-name
12885 description: Name given to the interface
12888 example: __INTERFACE-NAME__
12889 - name: l3-interface-ipv6-address
12891 description: IP address
12894 example: __L3-INTERFACE-IPV6-ADDRESS__
12895 /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}:
12898 - CloudInfrastructure
12899 summary: returns l3-interface-ipv6-address-list
12900 description: returns l3-interface-ipv6-address-list
12901 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
12907 description: successful operation
12909 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
12911 description: Response codes found in [response codes](https://wiki.onap.org/).
12915 description: Value from executing hostname on the compute node.
12918 example: __HOSTNAME__
12919 - name: interface-name
12921 description: Name that identifies the link aggregate interface
12924 example: __INTERFACE-NAME__
12925 - name: interface-name
12927 description: Name given to the interface
12930 example: __INTERFACE-NAME__
12931 - name: l3-interface-ipv6-address
12933 description: IP address
12936 example: __L3-INTERFACE-IPV6-ADDRESS__
12939 description: ID of Pserver
12946 - name: pserver-name2
12948 description: alternative pserver name
12951 - name: interface-id
12953 description: ID of interface
12958 description: MAC address for the interface
12961 - name: network-name
12963 description: Name of the network
12966 - name: vlan-id-inner
12968 description: Inner VLAN tag
12972 - name: neutron-network-id
12974 description: Neutron network id of the interface that address belongs to
12977 - name: neutron-subnet-id
12979 description: Neutron id of subnet that address belongs to
12984 - CloudInfrastructure
12985 summary: create or update an existing l3-interface-ipv6-address-list
12987 Create or update an existing l3-interface-ipv6-address-list.
12989 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12990 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
12999 description: Response codes found in [response codes](https://wiki.onap.org/).
13003 description: Value from executing hostname on the compute node.
13006 example: __HOSTNAME__
13007 - name: interface-name
13009 description: Name that identifies the link aggregate interface
13012 example: __INTERFACE-NAME__
13013 - name: interface-name
13015 description: Name given to the interface
13018 example: __INTERFACE-NAME__
13019 - name: l3-interface-ipv6-address
13021 description: IP address
13024 example: __L3-INTERFACE-IPV6-ADDRESS__
13027 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
13030 $ref: "#/definitions/l3-interface-ipv6-address-list"
13033 - CloudInfrastructure
13034 summary: update an existing l3-interface-ipv6-address-list
13036 Update an existing l3-interface-ipv6-address-list
13038 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13039 The PUT operation will entirely replace an existing object.
13040 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13042 Other differences between PUT and PATCH are:
13044 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13045 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13046 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13047 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13056 description: Response codes found in [response codes](https://wiki.onap.org/).
13060 description: Value from executing hostname on the compute node.
13063 example: __HOSTNAME__
13064 - name: interface-name
13066 description: Name that identifies the link aggregate interface
13069 example: __INTERFACE-NAME__
13070 - name: interface-name
13072 description: Name given to the interface
13075 example: __INTERFACE-NAME__
13076 - name: l3-interface-ipv6-address
13078 description: IP address
13081 example: __L3-INTERFACE-IPV6-ADDRESS__
13084 description: l3-interface-ipv6-address-list object that needs to be created or updated.
13087 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
13090 - CloudInfrastructure
13091 summary: delete an existing l3-interface-ipv6-address-list
13092 description: delete an existing l3-interface-ipv6-address-list
13093 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13102 description: Response codes found in [response codes](https://wiki.onap.org/).
13106 description: Value from executing hostname on the compute node.
13109 example: __HOSTNAME__
13110 - name: interface-name
13112 description: Name that identifies the link aggregate interface
13115 example: __INTERFACE-NAME__
13116 - name: interface-name
13118 description: Name given to the interface
13121 example: __INTERFACE-NAME__
13122 - name: l3-interface-ipv6-address
13124 description: IP address
13127 example: __L3-INTERFACE-IPV6-ADDRESS__
13128 - name: resource-version
13130 description: resource-version for concurrency
13133 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
13136 - CloudInfrastructure
13137 summary: returns l-interface
13138 description: returns l-interface
13139 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13145 description: successful operation
13147 $ref: "#/getDefinitions/l-interface"
13149 description: Response codes found in [response codes](https://wiki.onap.org/).
13153 description: Value from executing hostname on the compute node.
13156 example: __HOSTNAME__
13157 - name: interface-name
13159 description: Name that identifies the link aggregate interface
13162 example: __INTERFACE-NAME__
13163 - name: interface-name
13165 description: Name given to the interface
13168 example: __INTERFACE-NAME__
13171 description: ID of Pserver
13178 - name: pserver-name2
13180 description: alternative pserver name
13183 - name: interface-id
13185 description: ID of interface
13190 description: MAC address for the interface
13193 - name: network-name
13195 description: Name of the network
13200 - CloudInfrastructure
13201 summary: create or update an existing l-interface
13203 Create or update an existing l-interface.
13205 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13206 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13215 description: Response codes found in [response codes](https://wiki.onap.org/).
13219 description: Value from executing hostname on the compute node.
13222 example: __HOSTNAME__
13223 - name: interface-name
13225 description: Name that identifies the link aggregate interface
13228 example: __INTERFACE-NAME__
13229 - name: interface-name
13231 description: Name given to the interface
13234 example: __INTERFACE-NAME__
13237 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
13240 $ref: "#/definitions/l-interface"
13243 - CloudInfrastructure
13244 summary: update an existing l-interface
13246 Update an existing l-interface
13248 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13249 The PUT operation will entirely replace an existing object.
13250 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13252 Other differences between PUT and PATCH are:
13254 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13255 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13256 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13257 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13266 description: Response codes found in [response codes](https://wiki.onap.org/).
13270 description: Value from executing hostname on the compute node.
13273 example: __HOSTNAME__
13274 - name: interface-name
13276 description: Name that identifies the link aggregate interface
13279 example: __INTERFACE-NAME__
13280 - name: interface-name
13282 description: Name given to the interface
13285 example: __INTERFACE-NAME__
13288 description: l-interface object that needs to be created or updated.
13291 $ref: "#/patchDefinitions/l-interface"
13294 - CloudInfrastructure
13295 summary: delete an existing l-interface
13296 description: delete an existing l-interface
13297 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13306 description: Response codes found in [response codes](https://wiki.onap.org/).
13310 description: Value from executing hostname on the compute node.
13313 example: __HOSTNAME__
13314 - name: interface-name
13316 description: Name that identifies the link aggregate interface
13319 example: __INTERFACE-NAME__
13320 - name: interface-name
13322 description: Name given to the interface
13325 example: __INTERFACE-NAME__
13326 - name: resource-version
13328 description: resource-version for concurrency
13331 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
13334 - CloudInfrastructure
13335 summary: returns l-interfaces
13336 description: returns l-interfaces
13337 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces
13343 description: successful operation
13345 $ref: "#/getDefinitions/l-interfaces"
13347 description: Response codes found in [response codes](https://wiki.onap.org/).
13351 description: Value from executing hostname on the compute node.
13354 example: __HOSTNAME__
13355 - name: interface-name
13357 description: Name that identifies the link aggregate interface
13360 example: __INTERFACE-NAME__
13363 description: ID of Pserver
13370 - name: pserver-name2
13372 description: alternative pserver name
13375 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}:
13378 - CloudInfrastructure
13379 summary: returns lag-interface
13380 description: returns lag-interface
13381 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface
13387 description: successful operation
13389 $ref: "#/getDefinitions/lag-interface"
13391 description: Response codes found in [response codes](https://wiki.onap.org/).
13395 description: Value from executing hostname on the compute node.
13398 example: __HOSTNAME__
13399 - name: interface-name
13401 description: Name that identifies the link aggregate interface
13404 example: __INTERFACE-NAME__
13407 description: ID of Pserver
13414 - name: pserver-name2
13416 description: alternative pserver name
13421 - CloudInfrastructure
13422 summary: create or update an existing lag-interface
13424 Create or update an existing lag-interface.
13426 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13427 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
13436 description: Response codes found in [response codes](https://wiki.onap.org/).
13440 description: Value from executing hostname on the compute node.
13443 example: __HOSTNAME__
13444 - name: interface-name
13446 description: Name that identifies the link aggregate interface
13449 example: __INTERFACE-NAME__
13452 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
13455 $ref: "#/definitions/lag-interface"
13458 - CloudInfrastructure
13459 summary: update an existing lag-interface
13461 Update an existing lag-interface
13463 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13464 The PUT operation will entirely replace an existing object.
13465 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13467 Other differences between PUT and PATCH are:
13469 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13470 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13471 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13472 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
13481 description: Response codes found in [response codes](https://wiki.onap.org/).
13485 description: Value from executing hostname on the compute node.
13488 example: __HOSTNAME__
13489 - name: interface-name
13491 description: Name that identifies the link aggregate interface
13494 example: __INTERFACE-NAME__
13497 description: lag-interface object that needs to be created or updated.
13500 $ref: "#/patchDefinitions/lag-interface"
13503 - CloudInfrastructure
13504 summary: delete an existing lag-interface
13505 description: delete an existing lag-interface
13506 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface
13515 description: Response codes found in [response codes](https://wiki.onap.org/).
13519 description: Value from executing hostname on the compute node.
13522 example: __HOSTNAME__
13523 - name: interface-name
13525 description: Name that identifies the link aggregate interface
13528 example: __INTERFACE-NAME__
13529 - name: resource-version
13531 description: resource-version for concurrency
13534 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces:
13537 - CloudInfrastructure
13538 summary: returns lag-interfaces
13539 description: returns lag-interfaces
13540 operationId: getCloudInfrastructurePserversPserverLagInterfaces
13546 description: successful operation
13548 $ref: "#/getDefinitions/lag-interfaces"
13550 description: Response codes found in [response codes](https://wiki.onap.org/).
13554 description: Value from executing hostname on the compute node.
13557 example: __HOSTNAME__
13560 description: ID of Pserver
13567 - name: pserver-name2
13569 description: alternative pserver name
13572 /cloud-infrastructure/pservers/pserver/{hostname}:
13575 - CloudInfrastructure
13576 summary: returns pserver
13577 description: returns pserver
13578 operationId: getCloudInfrastructurePserversPserver
13584 description: successful operation
13586 $ref: "#/getDefinitions/pserver"
13588 description: Response codes found in [response codes](https://wiki.onap.org/).
13592 description: Value from executing hostname on the compute node.
13595 example: __HOSTNAME__
13598 description: ID of Pserver
13605 - name: pserver-name2
13607 description: alternative pserver name
13612 - CloudInfrastructure
13613 summary: create or update an existing pserver
13615 Create or update an existing pserver.
13617 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13618 operationId: createOrUpdateCloudInfrastructurePserversPserver
13627 description: Response codes found in [response codes](https://wiki.onap.org/).
13631 description: Value from executing hostname on the compute node.
13634 example: __HOSTNAME__
13637 description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserver.json)
13640 $ref: "#/definitions/pserver"
13643 - CloudInfrastructure
13644 summary: update an existing pserver
13646 Update an existing pserver
13648 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13649 The PUT operation will entirely replace an existing object.
13650 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13652 Other differences between PUT and PATCH are:
13654 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13655 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13656 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13657 operationId: UpdateCloudInfrastructurePserversPserver
13666 description: Response codes found in [response codes](https://wiki.onap.org/).
13670 description: Value from executing hostname on the compute node.
13673 example: __HOSTNAME__
13676 description: pserver object that needs to be created or updated.
13679 $ref: "#/patchDefinitions/pserver"
13682 - CloudInfrastructure
13683 summary: delete an existing pserver
13684 description: delete an existing pserver
13685 operationId: deleteCloudInfrastructurePserversPserver
13694 description: Response codes found in [response codes](https://wiki.onap.org/).
13698 description: Value from executing hostname on the compute node.
13701 example: __HOSTNAME__
13702 - name: resource-version
13704 description: resource-version for concurrency
13707 /cloud-infrastructure/pservers:
13710 - CloudInfrastructure
13711 summary: returns pservers
13712 description: returns pservers
13713 operationId: getCloudInfrastructurePservers
13719 description: successful operation
13721 $ref: "#/getDefinitions/pservers"
13723 description: Response codes found in [response codes](https://wiki.onap.org/).
13724 /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship:
13727 - CloudInfrastructure
13728 summary: see node definition for valid relationships
13729 operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
13738 description: Response codes found in [response codes](https://wiki.onap.org/).
13742 description: Unique ID of the vdc
13745 example: __VDC-ID__
13748 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
13751 $ref: "#/definitions/relationship"
13754 - CloudInfrastructure
13755 summary: delete an existing relationship
13756 description: delete an existing relationship
13757 operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
13766 description: Response codes found in [response codes](https://wiki.onap.org/).
13770 description: Unique ID of the vdc
13773 example: __VDC-ID__
13774 /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}:
13777 - CloudInfrastructure
13778 summary: returns virtual-data-center
13779 description: returns virtual-data-center
13780 operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter
13786 description: successful operation
13788 $ref: "#/getDefinitions/virtual-data-center"
13790 description: Response codes found in [response codes](https://wiki.onap.org/).
13794 description: Unique ID of the vdc
13797 example: __VDC-ID__
13800 description: Name of the virtual data center
13805 - CloudInfrastructure
13806 summary: create or update an existing virtual-data-center
13808 Create or update an existing virtual-data-center.
13810 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13811 operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
13820 description: Response codes found in [response codes](https://wiki.onap.org/).
13824 description: Unique ID of the vdc
13827 example: __VDC-ID__
13830 description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
13833 $ref: "#/definitions/virtual-data-center"
13836 - CloudInfrastructure
13837 summary: update an existing virtual-data-center
13839 Update an existing virtual-data-center
13841 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13842 The PUT operation will entirely replace an existing object.
13843 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13845 Other differences between PUT and PATCH are:
13847 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13848 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13849 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13850 operationId: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
13859 description: Response codes found in [response codes](https://wiki.onap.org/).
13863 description: Unique ID of the vdc
13866 example: __VDC-ID__
13869 description: virtual-data-center object that needs to be created or updated.
13872 $ref: "#/patchDefinitions/virtual-data-center"
13875 - CloudInfrastructure
13876 summary: delete an existing virtual-data-center
13877 description: delete an existing virtual-data-center
13878 operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter
13887 description: Response codes found in [response codes](https://wiki.onap.org/).
13891 description: Unique ID of the vdc
13894 example: __VDC-ID__
13895 - name: resource-version
13897 description: resource-version for concurrency
13900 /cloud-infrastructure/virtual-data-centers:
13903 - CloudInfrastructure
13904 summary: returns virtual-data-centers
13905 description: returns virtual-data-centers
13906 operationId: getCloudInfrastructureVirtualDataCenters
13912 description: successful operation
13914 $ref: "#/getDefinitions/virtual-data-centers"
13916 description: Response codes found in [response codes](https://wiki.onap.org/).
13917 /business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
13921 summary: see node definition for valid relationships
13922 operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship
13931 description: Response codes found in [response codes](https://wiki.onap.org/).
13933 - name: resource-instance-id
13935 description: Unique id of resource instance.
13938 example: __RESOURCE-INSTANCE-ID__
13941 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessConnectorsConnector.json)
13944 $ref: "#/definitions/relationship"
13948 summary: delete an existing relationship
13949 description: delete an existing relationship
13950 operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship
13959 description: Response codes found in [response codes](https://wiki.onap.org/).
13961 - name: resource-instance-id
13963 description: Unique id of resource instance.
13966 example: __RESOURCE-INSTANCE-ID__
13967 /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
13971 summary: returns metadatum
13972 description: returns metadatum
13973 operationId: getBusinessConnectorsConnectorMetadataMetadatum
13979 description: successful operation
13981 $ref: "#/getDefinitions/metadatum"
13983 description: Response codes found in [response codes](https://wiki.onap.org/).
13985 - name: resource-instance-id
13987 description: Unique id of resource instance.
13990 example: __RESOURCE-INSTANCE-ID__
13995 example: __METANAME__
13996 - name: persona-model-id
13998 description: the ASDC model id for this resource or service model.
14001 - name: persona-model-version
14003 description: the ASDC model version for this resource or service model.
14006 - name: widget-model-id
14008 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14011 - name: widget-model-version
14013 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14019 summary: create or update an existing metadatum
14021 Create or update an existing metadatum.
14023 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14024 operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum
14033 description: Response codes found in [response codes](https://wiki.onap.org/).
14035 - name: resource-instance-id
14037 description: Unique id of resource instance.
14040 example: __RESOURCE-INSTANCE-ID__
14045 example: __METANAME__
14048 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessConnectorsConnectorMetadataMetadatum.json)
14051 $ref: "#/definitions/metadatum"
14055 summary: update an existing metadatum
14057 Update an existing metadatum
14059 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14060 The PUT operation will entirely replace an existing object.
14061 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14063 Other differences between PUT and PATCH are:
14065 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14066 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14067 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14068 operationId: UpdateBusinessConnectorsConnectorMetadataMetadatum
14077 description: Response codes found in [response codes](https://wiki.onap.org/).
14079 - name: resource-instance-id
14081 description: Unique id of resource instance.
14084 example: __RESOURCE-INSTANCE-ID__
14089 example: __METANAME__
14092 description: metadatum object that needs to be created or updated.
14095 $ref: "#/patchDefinitions/metadatum"
14099 summary: delete an existing metadatum
14100 description: delete an existing metadatum
14101 operationId: deleteBusinessConnectorsConnectorMetadataMetadatum
14110 description: Response codes found in [response codes](https://wiki.onap.org/).
14112 - name: resource-instance-id
14114 description: Unique id of resource instance.
14117 example: __RESOURCE-INSTANCE-ID__
14122 example: __METANAME__
14123 - name: resource-version
14125 description: resource-version for concurrency
14128 /business/connectors/connector/{resource-instance-id}/metadata:
14132 summary: returns metadata
14133 description: returns metadata
14134 operationId: getBusinessConnectorsConnectorMetadata
14140 description: successful operation
14142 $ref: "#/getDefinitions/metadata"
14144 description: Response codes found in [response codes](https://wiki.onap.org/).
14146 - name: resource-instance-id
14148 description: Unique id of resource instance.
14151 example: __RESOURCE-INSTANCE-ID__
14152 - name: persona-model-id
14154 description: the ASDC model id for this resource or service model.
14157 - name: persona-model-version
14159 description: the ASDC model version for this resource or service model.
14162 - name: widget-model-id
14164 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14167 - name: widget-model-version
14169 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14172 /business/connectors/connector/{resource-instance-id}:
14176 summary: returns connector
14177 description: returns connector
14178 operationId: getBusinessConnectorsConnector
14184 description: successful operation
14186 $ref: "#/getDefinitions/connector"
14188 description: Response codes found in [response codes](https://wiki.onap.org/).
14190 - name: resource-instance-id
14192 description: Unique id of resource instance.
14195 example: __RESOURCE-INSTANCE-ID__
14196 - name: persona-model-id
14198 description: the ASDC model id for this resource or service model.
14201 - name: persona-model-version
14203 description: the ASDC model version for this resource or service model.
14206 - name: widget-model-id
14208 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14211 - name: widget-model-version
14213 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14219 summary: create or update an existing connector
14221 Create or update an existing connector.
14223 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14224 operationId: createOrUpdateBusinessConnectorsConnector
14233 description: Response codes found in [response codes](https://wiki.onap.org/).
14235 - name: resource-instance-id
14237 description: Unique id of resource instance.
14240 example: __RESOURCE-INSTANCE-ID__
14243 description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessConnectorsConnector.json)
14246 $ref: "#/definitions/connector"
14250 summary: update an existing connector
14252 Update an existing connector
14254 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14255 The PUT operation will entirely replace an existing object.
14256 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14258 Other differences between PUT and PATCH are:
14260 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14261 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14262 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14263 operationId: UpdateBusinessConnectorsConnector
14272 description: Response codes found in [response codes](https://wiki.onap.org/).
14274 - name: resource-instance-id
14276 description: Unique id of resource instance.
14279 example: __RESOURCE-INSTANCE-ID__
14282 description: connector object that needs to be created or updated.
14285 $ref: "#/patchDefinitions/connector"
14289 summary: delete an existing connector
14290 description: delete an existing connector
14291 operationId: deleteBusinessConnectorsConnector
14300 description: Response codes found in [response codes](https://wiki.onap.org/).
14302 - name: resource-instance-id
14304 description: Unique id of resource instance.
14307 example: __RESOURCE-INSTANCE-ID__
14308 - name: resource-version
14310 description: resource-version for concurrency
14313 /business/connectors:
14317 summary: returns connectors
14318 description: returns connectors
14319 operationId: getBusinessConnectors
14325 description: successful operation
14327 $ref: "#/getDefinitions/connectors"
14329 description: Response codes found in [response codes](https://wiki.onap.org/).
14330 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
14334 summary: see node definition for valid relationships
14335 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
14344 description: Response codes found in [response codes](https://wiki.onap.org/).
14346 - name: global-customer-id
14348 description: Global customer id used across ECOMP to uniquely identify customer.
14351 example: __GLOBAL-CUSTOMER-ID__
14352 - name: service-type
14354 description: Value defined by orchestration to identify this service across ECOMP.
14357 example: __SERVICE-TYPE__
14358 - name: service-instance-id
14360 description: Uniquely identifies this instance of a service
14363 example: __SERVICE-INSTANCE-ID__
14366 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
14369 $ref: "#/definitions/relationship"
14373 summary: delete an existing relationship
14374 description: delete an existing relationship
14375 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
14384 description: Response codes found in [response codes](https://wiki.onap.org/).
14386 - name: global-customer-id
14388 description: Global customer id used across ECOMP to uniquely identify customer.
14391 example: __GLOBAL-CUSTOMER-ID__
14392 - name: service-type
14394 description: Value defined by orchestration to identify this service across ECOMP.
14397 example: __SERVICE-TYPE__
14398 - name: service-instance-id
14400 description: Uniquely identifies this instance of a service
14403 example: __SERVICE-INSTANCE-ID__
14404 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
14408 summary: returns metadatum
14409 description: returns metadatum
14410 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
14416 description: successful operation
14418 $ref: "#/getDefinitions/metadatum"
14420 description: Response codes found in [response codes](https://wiki.onap.org/).
14422 - name: global-customer-id
14424 description: Global customer id used across ECOMP to uniquely identify customer.
14427 example: __GLOBAL-CUSTOMER-ID__
14428 - name: service-type
14430 description: Value defined by orchestration to identify this service across ECOMP.
14433 example: __SERVICE-TYPE__
14434 - name: service-instance-id
14436 description: Uniquely identifies this instance of a service
14439 example: __SERVICE-INSTANCE-ID__
14444 example: __METANAME__
14445 - name: subscriber-name
14447 description: Subscriber name, an alternate way to retrieve a customer.
14450 - name: subscriber-type
14452 description: Subscriber type, a way to provide VID with only the INFRA customers.
14455 - name: service-instance-name
14457 description: This field will store a name assigned to the service-instance.
14460 - name: persona-model-id
14462 description: the ASDC model id for this resource or service model.
14465 - name: persona-model-version
14467 description: the ASDC model version for this resource or service model.
14470 - name: widget-model-id
14472 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14475 - name: widget-model-version
14477 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14480 - name: service-instance-location-id
14482 description: An identifier that customers assign to the location where this service is being used.
14488 summary: create or update an existing metadatum
14490 Create or update an existing metadatum.
14492 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14493 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
14502 description: Response codes found in [response codes](https://wiki.onap.org/).
14504 - name: global-customer-id
14506 description: Global customer id used across ECOMP to uniquely identify customer.
14509 example: __GLOBAL-CUSTOMER-ID__
14510 - name: service-type
14512 description: Value defined by orchestration to identify this service across ECOMP.
14515 example: __SERVICE-TYPE__
14516 - name: service-instance-id
14518 description: Uniquely identifies this instance of a service
14521 example: __SERVICE-INSTANCE-ID__
14526 example: __METANAME__
14529 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)
14532 $ref: "#/definitions/metadatum"
14536 summary: update an existing metadatum
14538 Update an existing metadatum
14540 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14541 The PUT operation will entirely replace an existing object.
14542 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14544 Other differences between PUT and PATCH are:
14546 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14547 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14548 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14549 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
14558 description: Response codes found in [response codes](https://wiki.onap.org/).
14560 - name: global-customer-id
14562 description: Global customer id used across ECOMP to uniquely identify customer.
14565 example: __GLOBAL-CUSTOMER-ID__
14566 - name: service-type
14568 description: Value defined by orchestration to identify this service across ECOMP.
14571 example: __SERVICE-TYPE__
14572 - name: service-instance-id
14574 description: Uniquely identifies this instance of a service
14577 example: __SERVICE-INSTANCE-ID__
14582 example: __METANAME__
14585 description: metadatum object that needs to be created or updated.
14588 $ref: "#/patchDefinitions/metadatum"
14592 summary: delete an existing metadatum
14593 description: delete an existing metadatum
14594 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
14603 description: Response codes found in [response codes](https://wiki.onap.org/).
14605 - name: global-customer-id
14607 description: Global customer id used across ECOMP to uniquely identify customer.
14610 example: __GLOBAL-CUSTOMER-ID__
14611 - name: service-type
14613 description: Value defined by orchestration to identify this service across ECOMP.
14616 example: __SERVICE-TYPE__
14617 - name: service-instance-id
14619 description: Uniquely identifies this instance of a service
14622 example: __SERVICE-INSTANCE-ID__
14627 example: __METANAME__
14628 - name: resource-version
14630 description: resource-version for concurrency
14633 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
14637 summary: returns metadata
14638 description: returns metadata
14639 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
14645 description: successful operation
14647 $ref: "#/getDefinitions/metadata"
14649 description: Response codes found in [response codes](https://wiki.onap.org/).
14651 - name: global-customer-id
14653 description: Global customer id used across ECOMP to uniquely identify customer.
14656 example: __GLOBAL-CUSTOMER-ID__
14657 - name: service-type
14659 description: Value defined by orchestration to identify this service across ECOMP.
14662 example: __SERVICE-TYPE__
14663 - name: service-instance-id
14665 description: Uniquely identifies this instance of a service
14668 example: __SERVICE-INSTANCE-ID__
14669 - name: subscriber-name
14671 description: Subscriber name, an alternate way to retrieve a customer.
14674 - name: subscriber-type
14676 description: Subscriber type, a way to provide VID with only the INFRA customers.
14679 - name: service-instance-name
14681 description: This field will store a name assigned to the service-instance.
14684 - name: persona-model-id
14686 description: the ASDC model id for this resource or service model.
14689 - name: persona-model-version
14691 description: the ASDC model version for this resource or service model.
14694 - name: widget-model-id
14696 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14699 - name: widget-model-version
14701 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14704 - name: service-instance-location-id
14706 description: An identifier that customers assign to the location where this service is being used.
14709 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
14713 summary: returns service-instance
14714 description: returns service-instance
14715 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
14721 description: successful operation
14723 $ref: "#/getDefinitions/service-instance"
14725 description: Response codes found in [response codes](https://wiki.onap.org/).
14727 - name: global-customer-id
14729 description: Global customer id used across ECOMP to uniquely identify customer.
14732 example: __GLOBAL-CUSTOMER-ID__
14733 - name: service-type
14735 description: Value defined by orchestration to identify this service across ECOMP.
14738 example: __SERVICE-TYPE__
14739 - name: service-instance-id
14741 description: Uniquely identifies this instance of a service
14744 example: __SERVICE-INSTANCE-ID__
14745 - name: subscriber-name
14747 description: Subscriber name, an alternate way to retrieve a customer.
14750 - name: subscriber-type
14752 description: Subscriber type, a way to provide VID with only the INFRA customers.
14755 - name: service-instance-name
14757 description: This field will store a name assigned to the service-instance.
14760 - name: persona-model-id
14762 description: the ASDC model id for this resource or service model.
14765 - name: persona-model-version
14767 description: the ASDC model version for this resource or service model.
14770 - name: widget-model-id
14772 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14775 - name: widget-model-version
14777 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14780 - name: service-instance-location-id
14782 description: An identifier that customers assign to the location where this service is being used.
14788 summary: create or update an existing service-instance
14790 Create or update an existing service-instance.
14792 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14793 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
14802 description: Response codes found in [response codes](https://wiki.onap.org/).
14804 - name: global-customer-id
14806 description: Global customer id used across ECOMP to uniquely identify customer.
14809 example: __GLOBAL-CUSTOMER-ID__
14810 - name: service-type
14812 description: Value defined by orchestration to identify this service across ECOMP.
14815 example: __SERVICE-TYPE__
14816 - name: service-instance-id
14818 description: Uniquely identifies this instance of a service
14821 example: __SERVICE-INSTANCE-ID__
14824 description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
14827 $ref: "#/definitions/service-instance"
14831 summary: update an existing service-instance
14833 Update an existing service-instance
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: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
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__
14875 description: service-instance object that needs to be created or updated.
14878 $ref: "#/patchDefinitions/service-instance"
14882 summary: delete an existing service-instance
14883 description: delete an existing service-instance
14884 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
14893 description: Response codes found in [response codes](https://wiki.onap.org/).
14895 - name: global-customer-id
14897 description: Global customer id used across ECOMP to uniquely identify customer.
14900 example: __GLOBAL-CUSTOMER-ID__
14901 - name: service-type
14903 description: Value defined by orchestration to identify this service across ECOMP.
14906 example: __SERVICE-TYPE__
14907 - name: service-instance-id
14909 description: Uniquely identifies this instance of a service
14912 example: __SERVICE-INSTANCE-ID__
14913 - name: resource-version
14915 description: resource-version for concurrency
14918 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances:
14922 summary: returns service-instances
14923 description: returns service-instances
14924 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances
14930 description: successful operation
14932 $ref: "#/getDefinitions/service-instances"
14934 description: Response codes found in [response codes](https://wiki.onap.org/).
14936 - name: global-customer-id
14938 description: Global customer id used across ECOMP to uniquely identify customer.
14941 example: __GLOBAL-CUSTOMER-ID__
14942 - name: service-type
14944 description: Value defined by orchestration to identify this service across ECOMP.
14947 example: __SERVICE-TYPE__
14948 - name: subscriber-name
14950 description: Subscriber name, an alternate way to retrieve a customer.
14953 - name: subscriber-type
14955 description: Subscriber type, a way to provide VID with only the INFRA customers.
14958 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship:
14962 summary: see node definition for valid relationships
14963 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
14972 description: Response codes found in [response codes](https://wiki.onap.org/).
14974 - name: global-customer-id
14976 description: Global customer id used across ECOMP to uniquely identify customer.
14979 example: __GLOBAL-CUSTOMER-ID__
14980 - name: service-type
14982 description: Value defined by orchestration to identify this service across ECOMP.
14985 example: __SERVICE-TYPE__
14988 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
14991 $ref: "#/definitions/relationship"
14995 summary: delete an existing relationship
14996 description: delete an existing relationship
14997 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
15006 description: Response codes found in [response codes](https://wiki.onap.org/).
15008 - name: global-customer-id
15010 description: Global customer id used across ECOMP to uniquely identify customer.
15013 example: __GLOBAL-CUSTOMER-ID__
15014 - name: service-type
15016 description: Value defined by orchestration to identify this service across ECOMP.
15019 example: __SERVICE-TYPE__
15020 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}:
15024 summary: returns service-subscription
15025 description: returns service-subscription
15026 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
15032 description: successful operation
15034 $ref: "#/getDefinitions/service-subscription"
15036 description: Response codes found in [response codes](https://wiki.onap.org/).
15038 - name: global-customer-id
15040 description: Global customer id used across ECOMP to uniquely identify customer.
15043 example: __GLOBAL-CUSTOMER-ID__
15044 - name: service-type
15046 description: Value defined by orchestration to identify this service across ECOMP.
15049 example: __SERVICE-TYPE__
15050 - name: subscriber-name
15052 description: Subscriber name, an alternate way to retrieve a customer.
15055 - name: subscriber-type
15057 description: Subscriber type, a way to provide VID with only the INFRA customers.
15063 summary: create or update an existing service-subscription
15065 Create or update an existing service-subscription.
15067 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15068 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
15077 description: Response codes found in [response codes](https://wiki.onap.org/).
15079 - name: global-customer-id
15081 description: Global customer id used across ECOMP to uniquely identify customer.
15084 example: __GLOBAL-CUSTOMER-ID__
15085 - name: service-type
15087 description: Value defined by orchestration to identify this service across ECOMP.
15090 example: __SERVICE-TYPE__
15093 description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
15096 $ref: "#/definitions/service-subscription"
15100 summary: update an existing service-subscription
15102 Update an existing service-subscription
15104 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15105 The PUT operation will entirely replace an existing object.
15106 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15108 Other differences between PUT and PATCH are:
15110 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15111 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15112 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15113 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
15122 description: Response codes found in [response codes](https://wiki.onap.org/).
15124 - name: global-customer-id
15126 description: Global customer id used across ECOMP to uniquely identify customer.
15129 example: __GLOBAL-CUSTOMER-ID__
15130 - name: service-type
15132 description: Value defined by orchestration to identify this service across ECOMP.
15135 example: __SERVICE-TYPE__
15138 description: service-subscription object that needs to be created or updated.
15141 $ref: "#/patchDefinitions/service-subscription"
15145 summary: delete an existing service-subscription
15146 description: delete an existing service-subscription
15147 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
15156 description: Response codes found in [response codes](https://wiki.onap.org/).
15158 - name: global-customer-id
15160 description: Global customer id used across ECOMP to uniquely identify customer.
15163 example: __GLOBAL-CUSTOMER-ID__
15164 - name: service-type
15166 description: Value defined by orchestration to identify this service across ECOMP.
15169 example: __SERVICE-TYPE__
15170 - name: resource-version
15172 description: resource-version for concurrency
15175 /business/customers/customer/{global-customer-id}/service-subscriptions:
15179 summary: returns service-subscriptions
15180 description: returns service-subscriptions
15181 operationId: getBusinessCustomersCustomerServiceSubscriptions
15187 description: successful operation
15189 $ref: "#/getDefinitions/service-subscriptions"
15191 description: Response codes found in [response codes](https://wiki.onap.org/).
15193 - name: global-customer-id
15195 description: Global customer id used across ECOMP to uniquely identify customer.
15198 example: __GLOBAL-CUSTOMER-ID__
15199 - name: subscriber-name
15201 description: Subscriber name, an alternate way to retrieve a customer.
15204 - name: subscriber-type
15206 description: Subscriber type, a way to provide VID with only the INFRA customers.
15209 /business/customers/customer/{global-customer-id}/relationship-list/relationship:
15213 summary: see node definition for valid relationships
15214 operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship
15223 description: Response codes found in [response codes](https://wiki.onap.org/).
15225 - name: global-customer-id
15227 description: Global customer id used across ECOMP to uniquely identify customer.
15230 example: __GLOBAL-CUSTOMER-ID__
15233 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomer.json)
15236 $ref: "#/definitions/relationship"
15240 summary: delete an existing relationship
15241 description: delete an existing relationship
15242 operationId: deleteBusinessCustomersCustomerRelationshipListRelationship
15251 description: Response codes found in [response codes](https://wiki.onap.org/).
15253 - name: global-customer-id
15255 description: Global customer id used across ECOMP to uniquely identify customer.
15258 example: __GLOBAL-CUSTOMER-ID__
15259 /business/customers/customer/{global-customer-id}:
15263 summary: returns customer
15264 description: returns customer
15265 operationId: getBusinessCustomersCustomer
15271 description: successful operation
15273 $ref: "#/getDefinitions/customer"
15275 description: Response codes found in [response codes](https://wiki.onap.org/).
15277 - name: global-customer-id
15279 description: Global customer id used across ECOMP to uniquely identify customer.
15282 example: __GLOBAL-CUSTOMER-ID__
15283 - name: subscriber-name
15285 description: Subscriber name, an alternate way to retrieve a customer.
15288 - name: subscriber-type
15290 description: Subscriber type, a way to provide VID with only the INFRA customers.
15296 summary: create or update an existing customer
15298 Create or update an existing customer.
15300 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15301 operationId: createOrUpdateBusinessCustomersCustomer
15310 description: Response codes found in [response codes](https://wiki.onap.org/).
15312 - name: global-customer-id
15314 description: Global customer id used across ECOMP to uniquely identify customer.
15317 example: __GLOBAL-CUSTOMER-ID__
15320 description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomer.json)
15323 $ref: "#/definitions/customer"
15327 summary: update an existing customer
15329 Update an existing customer
15331 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15332 The PUT operation will entirely replace an existing object.
15333 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15335 Other differences between PUT and PATCH are:
15337 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15338 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15339 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15340 operationId: UpdateBusinessCustomersCustomer
15349 description: Response codes found in [response codes](https://wiki.onap.org/).
15351 - name: global-customer-id
15353 description: Global customer id used across ECOMP to uniquely identify customer.
15356 example: __GLOBAL-CUSTOMER-ID__
15359 description: customer object that needs to be created or updated.
15362 $ref: "#/patchDefinitions/customer"
15366 summary: delete an existing customer
15367 description: delete an existing customer
15368 operationId: deleteBusinessCustomersCustomer
15377 description: Response codes found in [response codes](https://wiki.onap.org/).
15379 - name: global-customer-id
15381 description: Global customer id used across ECOMP to uniquely identify customer.
15384 example: __GLOBAL-CUSTOMER-ID__
15385 - name: resource-version
15387 description: resource-version for concurrency
15390 /business/customers:
15394 summary: returns customers
15395 description: returns customers
15396 operationId: getBusinessCustomers
15402 description: successful operation
15404 $ref: "#/getDefinitions/customers"
15406 description: Response codes found in [response codes](https://wiki.onap.org/).
15407 /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
15410 - ServiceDesignAndCreation
15411 summary: see node definition for valid relationships
15412 operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
15421 description: Response codes found in [response codes](https://wiki.onap.org/).
15423 - name: vnf-image-uuid
15425 description: Unique ID of this asset
15428 example: __VNF-IMAGE-UUID__
15431 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationVnfImagesVnfImage.json)
15434 $ref: "#/definitions/relationship"
15437 - ServiceDesignAndCreation
15438 summary: delete an existing relationship
15439 description: delete an existing relationship
15440 operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
15449 description: Response codes found in [response codes](https://wiki.onap.org/).
15451 - name: vnf-image-uuid
15453 description: Unique ID of this asset
15456 example: __VNF-IMAGE-UUID__
15457 /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}:
15460 - ServiceDesignAndCreation
15461 summary: returns vnf-image
15462 description: returns vnf-image
15463 operationId: getServiceDesignAndCreationVnfImagesVnfImage
15469 description: successful operation
15471 $ref: "#/getDefinitions/vnf-image"
15473 description: Response codes found in [response codes](https://wiki.onap.org/).
15475 - name: vnf-image-uuid
15477 description: Unique ID of this asset
15480 example: __VNF-IMAGE-UUID__
15481 - name: application
15483 description: The application that the image instantiates.
15486 - name: application-vendor
15488 description: The vendor of the application.
15491 - name: application-version
15493 description: The version of the application.
15498 - ServiceDesignAndCreation
15499 summary: create or update an existing vnf-image
15501 Create or update an existing vnf-image.
15503 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15504 operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage
15513 description: Response codes found in [response codes](https://wiki.onap.org/).
15515 - name: vnf-image-uuid
15517 description: Unique ID of this asset
15520 example: __VNF-IMAGE-UUID__
15523 description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationVnfImagesVnfImage.json)
15526 $ref: "#/definitions/vnf-image"
15529 - ServiceDesignAndCreation
15530 summary: update an existing vnf-image
15532 Update an existing vnf-image
15534 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15535 The PUT operation will entirely replace an existing object.
15536 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15538 Other differences between PUT and PATCH are:
15540 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15541 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15542 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15543 operationId: UpdateServiceDesignAndCreationVnfImagesVnfImage
15552 description: Response codes found in [response codes](https://wiki.onap.org/).
15554 - name: vnf-image-uuid
15556 description: Unique ID of this asset
15559 example: __VNF-IMAGE-UUID__
15562 description: vnf-image object that needs to be created or updated.
15565 $ref: "#/patchDefinitions/vnf-image"
15568 - ServiceDesignAndCreation
15569 summary: delete an existing vnf-image
15570 description: delete an existing vnf-image
15571 operationId: deleteServiceDesignAndCreationVnfImagesVnfImage
15580 description: Response codes found in [response codes](https://wiki.onap.org/).
15582 - name: vnf-image-uuid
15584 description: Unique ID of this asset
15587 example: __VNF-IMAGE-UUID__
15588 - name: resource-version
15590 description: resource-version for concurrency
15593 /service-design-and-creation/vnf-images:
15596 - ServiceDesignAndCreation
15597 summary: returns vnf-images
15598 description: returns vnf-images
15599 operationId: getServiceDesignAndCreationVnfImages
15605 description: successful operation
15607 $ref: "#/getDefinitions/vnf-images"
15609 description: Response codes found in [response codes](https://wiki.onap.org/).
15610 /service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
15613 - ServiceDesignAndCreation
15614 summary: see node definition for valid relationships
15615 operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship
15624 description: Response codes found in [response codes](https://wiki.onap.org/).
15628 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15631 example: __SERVICE-ID__
15634 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationServicesService.json)
15637 $ref: "#/definitions/relationship"
15640 - ServiceDesignAndCreation
15641 summary: delete an existing relationship
15642 description: delete an existing relationship
15643 operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship
15652 description: Response codes found in [response codes](https://wiki.onap.org/).
15656 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15659 example: __SERVICE-ID__
15660 /service-design-and-creation/services/service/{service-id}:
15663 - ServiceDesignAndCreation
15664 summary: returns service
15665 description: returns service
15666 operationId: getServiceDesignAndCreationServicesService
15672 description: successful operation
15674 $ref: "#/getDefinitions/service"
15676 description: Response codes found in [response codes](https://wiki.onap.org/).
15680 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15683 example: __SERVICE-ID__
15684 - name: service-description
15686 description: Description of the service
15691 - ServiceDesignAndCreation
15692 summary: create or update an existing service
15694 Create or update an existing service.
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: createOrUpdateServiceDesignAndCreationServicesService
15706 description: Response codes found in [response codes](https://wiki.onap.org/).
15710 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15713 example: __SERVICE-ID__
15716 description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationServicesService.json)
15719 $ref: "#/definitions/service"
15722 - ServiceDesignAndCreation
15723 summary: update an existing service
15725 Update an existing service
15727 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15728 The PUT operation will entirely replace an existing object.
15729 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15731 Other differences between PUT and PATCH are:
15733 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15734 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15735 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15736 operationId: UpdateServiceDesignAndCreationServicesService
15745 description: Response codes found in [response codes](https://wiki.onap.org/).
15749 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15752 example: __SERVICE-ID__
15755 description: service object that needs to be created or updated.
15758 $ref: "#/patchDefinitions/service"
15761 - ServiceDesignAndCreation
15762 summary: delete an existing service
15763 description: delete an existing service
15764 operationId: deleteServiceDesignAndCreationServicesService
15773 description: Response codes found in [response codes](https://wiki.onap.org/).
15777 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15780 example: __SERVICE-ID__
15781 - name: resource-version
15783 description: resource-version for concurrency
15786 /service-design-and-creation/services:
15789 - ServiceDesignAndCreation
15790 summary: returns services
15791 description: returns services
15792 operationId: getServiceDesignAndCreationServices
15798 description: successful operation
15800 $ref: "#/getDefinitions/services"
15802 description: Response codes found in [response codes](https://wiki.onap.org/).
15803 /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
15806 - ServiceDesignAndCreation
15807 summary: see node definition for valid relationships
15808 operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
15817 description: Response codes found in [response codes](https://wiki.onap.org/).
15819 - name: service-type
15821 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15824 example: __SERVICE-TYPE__
15827 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
15830 example: __VNF-TYPE__
15833 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
15836 $ref: "#/definitions/relationship"
15839 - ServiceDesignAndCreation
15840 summary: delete an existing relationship
15841 description: delete an existing relationship
15842 operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
15851 description: Response codes found in [response codes](https://wiki.onap.org/).
15853 - name: service-type
15855 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15858 example: __SERVICE-TYPE__
15861 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
15864 example: __VNF-TYPE__
15865 /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
15868 - ServiceDesignAndCreation
15869 summary: returns service-capability
15870 description: returns service-capability
15871 operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability
15877 description: successful operation
15879 $ref: "#/getDefinitions/service-capability"
15881 description: Response codes found in [response codes](https://wiki.onap.org/).
15883 - name: service-type
15885 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15888 example: __SERVICE-TYPE__
15891 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
15894 example: __VNF-TYPE__
15897 - ServiceDesignAndCreation
15898 summary: create or update an existing service-capability
15900 Create or update an existing service-capability.
15902 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15903 operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
15912 description: Response codes found in [response codes](https://wiki.onap.org/).
15914 - name: service-type
15916 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15919 example: __SERVICE-TYPE__
15922 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
15925 example: __VNF-TYPE__
15928 description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
15931 $ref: "#/definitions/service-capability"
15934 - ServiceDesignAndCreation
15935 summary: update an existing service-capability
15937 Update an existing service-capability
15939 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15940 The PUT operation will entirely replace an existing object.
15941 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15943 Other differences between PUT and PATCH are:
15945 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15946 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15947 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15948 operationId: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
15957 description: Response codes found in [response codes](https://wiki.onap.org/).
15959 - name: service-type
15961 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15964 example: __SERVICE-TYPE__
15967 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
15970 example: __VNF-TYPE__
15973 description: service-capability object that needs to be created or updated.
15976 $ref: "#/patchDefinitions/service-capability"
15979 - ServiceDesignAndCreation
15980 summary: delete an existing service-capability
15981 description: delete an existing service-capability
15982 operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
15991 description: Response codes found in [response codes](https://wiki.onap.org/).
15993 - name: service-type
15995 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15998 example: __SERVICE-TYPE__
16001 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
16004 example: __VNF-TYPE__
16005 - name: resource-version
16007 description: resource-version for concurrency
16010 /service-design-and-creation/service-capabilities:
16013 - ServiceDesignAndCreation
16014 summary: returns service-capabilities
16015 description: returns service-capabilities
16016 operationId: getServiceDesignAndCreationServiceCapabilities
16022 description: successful operation
16024 $ref: "#/getDefinitions/service-capabilities"
16026 description: Response codes found in [response codes](https://wiki.onap.org/).
16027 /service-design-and-creation/models/model/{model-name-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:
16030 - ServiceDesignAndCreation
16031 summary: see node definition for valid relationships
16032 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
16041 description: Response codes found in [response codes](https://wiki.onap.org/).
16043 - name: model-name-version-id
16045 description: Unique identifier corresponding to one version of a model in ASDC
16048 example: __MODEL-NAME-VERSION-ID__
16049 - name: model-element-uuid
16053 example: __MODEL-ELEMENT-UUID__
16054 - name: model-constraint-uuid
16058 example: __MODEL-CONSTRAINT-UUID__
16059 - name: constrained-element-set-uuid
16063 example: __CONSTRAINED-ELEMENT-SET-UUID__
16064 - name: element-choice-set-uuid
16068 example: __ELEMENT-CHOICE-SET-UUID__
16071 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
16074 $ref: "#/definitions/relationship"
16077 - ServiceDesignAndCreation
16078 summary: delete an existing relationship
16079 description: delete an existing relationship
16080 operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
16089 description: Response codes found in [response codes](https://wiki.onap.org/).
16091 - name: model-name-version-id
16093 description: Unique identifier corresponding to one version of a model in ASDC
16096 example: __MODEL-NAME-VERSION-ID__
16097 - name: model-element-uuid
16101 example: __MODEL-ELEMENT-UUID__
16102 - name: model-constraint-uuid
16106 example: __MODEL-CONSTRAINT-UUID__
16107 - name: constrained-element-set-uuid
16111 example: __CONSTRAINED-ELEMENT-SET-UUID__
16112 - name: element-choice-set-uuid
16116 example: __ELEMENT-CHOICE-SET-UUID__
16117 /service-design-and-creation/models/model/{model-name-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}:
16120 - ServiceDesignAndCreation
16121 summary: returns element-choice-set
16122 description: returns element-choice-set
16123 operationId: getServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
16129 description: successful operation
16131 $ref: "#/getDefinitions/element-choice-set"
16133 description: Response codes found in [response codes](https://wiki.onap.org/).
16135 - name: model-name-version-id
16137 description: Unique identifier corresponding to one version of a model in ASDC
16140 example: __MODEL-NAME-VERSION-ID__
16141 - name: model-element-uuid
16145 example: __MODEL-ELEMENT-UUID__
16146 - name: model-constraint-uuid
16150 example: __MODEL-CONSTRAINT-UUID__
16151 - name: constrained-element-set-uuid
16155 example: __CONSTRAINED-ELEMENT-SET-UUID__
16156 - name: element-choice-set-uuid
16160 example: __ELEMENT-CHOICE-SET-UUID__
16163 description: Type of the model, e.g., service, resource, widget, etc.
16168 description: Name of the model, which can change from version to version.
16173 description: Invariant unique ID which does not change from version to version
16176 - name: model-version
16178 description: Version
16183 - ServiceDesignAndCreation
16184 summary: create or update an existing element-choice-set
16186 Create or update an existing element-choice-set.
16188 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16189 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
16198 description: Response codes found in [response codes](https://wiki.onap.org/).
16200 - name: model-name-version-id
16202 description: Unique identifier corresponding to one version of a model in ASDC
16205 example: __MODEL-NAME-VERSION-ID__
16206 - name: model-element-uuid
16210 example: __MODEL-ELEMENT-UUID__
16211 - name: model-constraint-uuid
16215 example: __MODEL-CONSTRAINT-UUID__
16216 - name: constrained-element-set-uuid
16220 example: __CONSTRAINED-ELEMENT-SET-UUID__
16221 - name: element-choice-set-uuid
16225 example: __ELEMENT-CHOICE-SET-UUID__
16228 description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
16231 $ref: "#/definitions/element-choice-set"
16234 - ServiceDesignAndCreation
16235 summary: update an existing element-choice-set
16237 Update an existing element-choice-set
16239 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16240 The PUT operation will entirely replace an existing object.
16241 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16243 Other differences between PUT and PATCH are:
16245 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16246 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16247 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16248 operationId: UpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
16257 description: Response codes found in [response codes](https://wiki.onap.org/).
16259 - name: model-name-version-id
16261 description: Unique identifier corresponding to one version of a model in ASDC
16264 example: __MODEL-NAME-VERSION-ID__
16265 - name: model-element-uuid
16269 example: __MODEL-ELEMENT-UUID__
16270 - name: model-constraint-uuid
16274 example: __MODEL-CONSTRAINT-UUID__
16275 - name: constrained-element-set-uuid
16279 example: __CONSTRAINED-ELEMENT-SET-UUID__
16280 - name: element-choice-set-uuid
16284 example: __ELEMENT-CHOICE-SET-UUID__
16287 description: element-choice-set object that needs to be created or updated.
16290 $ref: "#/patchDefinitions/element-choice-set"
16293 - ServiceDesignAndCreation
16294 summary: delete an existing element-choice-set
16295 description: delete an existing element-choice-set
16296 operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
16305 description: Response codes found in [response codes](https://wiki.onap.org/).
16307 - name: model-name-version-id
16309 description: Unique identifier corresponding to one version of a model in ASDC
16312 example: __MODEL-NAME-VERSION-ID__
16313 - name: model-element-uuid
16317 example: __MODEL-ELEMENT-UUID__
16318 - name: model-constraint-uuid
16322 example: __MODEL-CONSTRAINT-UUID__
16323 - name: constrained-element-set-uuid
16327 example: __CONSTRAINED-ELEMENT-SET-UUID__
16328 - name: element-choice-set-uuid
16332 example: __ELEMENT-CHOICE-SET-UUID__
16333 - name: resource-version
16335 description: resource-version for concurrency
16338 /service-design-and-creation/models/model/{model-name-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:
16341 - ServiceDesignAndCreation
16342 summary: returns element-choice-sets
16343 description: returns element-choice-sets
16344 operationId: getServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
16350 description: successful operation
16352 $ref: "#/getDefinitions/element-choice-sets"
16354 description: Response codes found in [response codes](https://wiki.onap.org/).
16356 - name: model-name-version-id
16358 description: Unique identifier corresponding to one version of a model in ASDC
16361 example: __MODEL-NAME-VERSION-ID__
16362 - name: model-element-uuid
16366 example: __MODEL-ELEMENT-UUID__
16367 - name: model-constraint-uuid
16371 example: __MODEL-CONSTRAINT-UUID__
16372 - name: constrained-element-set-uuid
16376 example: __CONSTRAINED-ELEMENT-SET-UUID__
16379 description: Type of the model, e.g., service, resource, widget, etc.
16384 description: Name of the model, which can change from version to version.
16389 description: Invariant unique ID which does not change from version to version
16392 - name: model-version
16394 description: Version
16397 /service-design-and-creation/models/model/{model-name-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:
16400 - ServiceDesignAndCreation
16401 summary: see node definition for valid relationships
16402 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
16411 description: Response codes found in [response codes](https://wiki.onap.org/).
16413 - name: model-name-version-id
16415 description: Unique identifier corresponding to one version of a model in ASDC
16418 example: __MODEL-NAME-VERSION-ID__
16419 - name: model-element-uuid
16423 example: __MODEL-ELEMENT-UUID__
16424 - name: model-constraint-uuid
16428 example: __MODEL-CONSTRAINT-UUID__
16429 - name: constrained-element-set-uuid
16433 example: __CONSTRAINED-ELEMENT-SET-UUID__
16436 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
16439 $ref: "#/definitions/relationship"
16442 - ServiceDesignAndCreation
16443 summary: delete an existing relationship
16444 description: delete an existing relationship
16445 operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
16454 description: Response codes found in [response codes](https://wiki.onap.org/).
16456 - name: model-name-version-id
16458 description: Unique identifier corresponding to one version of a model in ASDC
16461 example: __MODEL-NAME-VERSION-ID__
16462 - name: model-element-uuid
16466 example: __MODEL-ELEMENT-UUID__
16467 - name: model-constraint-uuid
16471 example: __MODEL-CONSTRAINT-UUID__
16472 - name: constrained-element-set-uuid
16476 example: __CONSTRAINED-ELEMENT-SET-UUID__
16477 /service-design-and-creation/models/model/{model-name-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}:
16480 - ServiceDesignAndCreation
16481 summary: returns constrained-element-set
16482 description: returns constrained-element-set
16483 operationId: getServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
16489 description: successful operation
16491 $ref: "#/getDefinitions/constrained-element-set"
16493 description: Response codes found in [response codes](https://wiki.onap.org/).
16495 - name: model-name-version-id
16497 description: Unique identifier corresponding to one version of a model in ASDC
16500 example: __MODEL-NAME-VERSION-ID__
16501 - name: model-element-uuid
16505 example: __MODEL-ELEMENT-UUID__
16506 - name: model-constraint-uuid
16510 example: __MODEL-CONSTRAINT-UUID__
16511 - name: constrained-element-set-uuid
16515 example: __CONSTRAINED-ELEMENT-SET-UUID__
16518 description: Type of the model, e.g., service, resource, widget, etc.
16523 description: Name of the model, which can change from version to version.
16528 description: Invariant unique ID which does not change from version to version
16531 - name: model-version
16533 description: Version
16538 - ServiceDesignAndCreation
16539 summary: create or update an existing constrained-element-set
16541 Create or update an existing constrained-element-set.
16543 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16544 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
16553 description: Response codes found in [response codes](https://wiki.onap.org/).
16555 - name: model-name-version-id
16557 description: Unique identifier corresponding to one version of a model in ASDC
16560 example: __MODEL-NAME-VERSION-ID__
16561 - name: model-element-uuid
16565 example: __MODEL-ELEMENT-UUID__
16566 - name: model-constraint-uuid
16570 example: __MODEL-CONSTRAINT-UUID__
16571 - name: constrained-element-set-uuid
16575 example: __CONSTRAINED-ELEMENT-SET-UUID__
16578 description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
16581 $ref: "#/definitions/constrained-element-set"
16584 - ServiceDesignAndCreation
16585 summary: update an existing constrained-element-set
16587 Update an existing constrained-element-set
16589 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16590 The PUT operation will entirely replace an existing object.
16591 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16593 Other differences between PUT and PATCH are:
16595 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16596 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16597 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16598 operationId: UpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
16607 description: Response codes found in [response codes](https://wiki.onap.org/).
16609 - name: model-name-version-id
16611 description: Unique identifier corresponding to one version of a model in ASDC
16614 example: __MODEL-NAME-VERSION-ID__
16615 - name: model-element-uuid
16619 example: __MODEL-ELEMENT-UUID__
16620 - name: model-constraint-uuid
16624 example: __MODEL-CONSTRAINT-UUID__
16625 - name: constrained-element-set-uuid
16629 example: __CONSTRAINED-ELEMENT-SET-UUID__
16632 description: constrained-element-set object that needs to be created or updated.
16635 $ref: "#/patchDefinitions/constrained-element-set"
16638 - ServiceDesignAndCreation
16639 summary: delete an existing constrained-element-set
16640 description: delete an existing constrained-element-set
16641 operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
16650 description: Response codes found in [response codes](https://wiki.onap.org/).
16652 - name: model-name-version-id
16654 description: Unique identifier corresponding to one version of a model in ASDC
16657 example: __MODEL-NAME-VERSION-ID__
16658 - name: model-element-uuid
16662 example: __MODEL-ELEMENT-UUID__
16663 - name: model-constraint-uuid
16667 example: __MODEL-CONSTRAINT-UUID__
16668 - name: constrained-element-set-uuid
16672 example: __CONSTRAINED-ELEMENT-SET-UUID__
16673 - name: resource-version
16675 description: resource-version for concurrency
16678 /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets:
16681 - ServiceDesignAndCreation
16682 summary: returns constrained-element-sets
16683 description: returns constrained-element-sets
16684 operationId: getServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
16690 description: successful operation
16692 $ref: "#/getDefinitions/constrained-element-sets"
16694 description: Response codes found in [response codes](https://wiki.onap.org/).
16696 - name: model-name-version-id
16698 description: Unique identifier corresponding to one version of a model in ASDC
16701 example: __MODEL-NAME-VERSION-ID__
16702 - name: model-element-uuid
16706 example: __MODEL-ELEMENT-UUID__
16707 - name: model-constraint-uuid
16711 example: __MODEL-CONSTRAINT-UUID__
16714 description: Type of the model, e.g., service, resource, widget, etc.
16719 description: Name of the model, which can change from version to version.
16724 description: Invariant unique ID which does not change from version to version
16727 - name: model-version
16729 description: Version
16732 /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}:
16735 - ServiceDesignAndCreation
16736 summary: returns model-constraint
16737 description: returns model-constraint
16738 operationId: getServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraint
16744 description: successful operation
16746 $ref: "#/getDefinitions/model-constraint"
16748 description: Response codes found in [response codes](https://wiki.onap.org/).
16750 - name: model-name-version-id
16752 description: Unique identifier corresponding to one version of a model in ASDC
16755 example: __MODEL-NAME-VERSION-ID__
16756 - name: model-element-uuid
16760 example: __MODEL-ELEMENT-UUID__
16761 - name: model-constraint-uuid
16765 example: __MODEL-CONSTRAINT-UUID__
16768 description: Type of the model, e.g., service, resource, widget, etc.
16773 description: Name of the model, which can change from version to version.
16778 description: Invariant unique ID which does not change from version to version
16781 - name: model-version
16783 description: Version
16788 - ServiceDesignAndCreation
16789 summary: create or update an existing model-constraint
16791 Create or update an existing model-constraint.
16793 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16794 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraint
16803 description: Response codes found in [response codes](https://wiki.onap.org/).
16805 - name: model-name-version-id
16807 description: Unique identifier corresponding to one version of a model in ASDC
16810 example: __MODEL-NAME-VERSION-ID__
16811 - name: model-element-uuid
16815 example: __MODEL-ELEMENT-UUID__
16816 - name: model-constraint-uuid
16820 example: __MODEL-CONSTRAINT-UUID__
16823 description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraint.json)
16826 $ref: "#/definitions/model-constraint"
16829 - ServiceDesignAndCreation
16830 summary: update an existing model-constraint
16832 Update an existing model-constraint
16834 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16835 The PUT operation will entirely replace an existing object.
16836 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16838 Other differences between PUT and PATCH are:
16840 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16841 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16842 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16843 operationId: UpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraint
16852 description: Response codes found in [response codes](https://wiki.onap.org/).
16854 - name: model-name-version-id
16856 description: Unique identifier corresponding to one version of a model in ASDC
16859 example: __MODEL-NAME-VERSION-ID__
16860 - name: model-element-uuid
16864 example: __MODEL-ELEMENT-UUID__
16865 - name: model-constraint-uuid
16869 example: __MODEL-CONSTRAINT-UUID__
16872 description: model-constraint object that needs to be created or updated.
16875 $ref: "#/patchDefinitions/model-constraint"
16878 - ServiceDesignAndCreation
16879 summary: delete an existing model-constraint
16880 description: delete an existing model-constraint
16881 operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraint
16890 description: Response codes found in [response codes](https://wiki.onap.org/).
16892 - name: model-name-version-id
16894 description: Unique identifier corresponding to one version of a model in ASDC
16897 example: __MODEL-NAME-VERSION-ID__
16898 - name: model-element-uuid
16902 example: __MODEL-ELEMENT-UUID__
16903 - name: model-constraint-uuid
16907 example: __MODEL-CONSTRAINT-UUID__
16908 - name: resource-version
16910 description: resource-version for concurrency
16913 /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints:
16916 - ServiceDesignAndCreation
16917 summary: returns model-constraints
16918 description: returns model-constraints
16919 operationId: getServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraints
16925 description: successful operation
16927 $ref: "#/getDefinitions/model-constraints"
16929 description: Response codes found in [response codes](https://wiki.onap.org/).
16931 - name: model-name-version-id
16933 description: Unique identifier corresponding to one version of a model in ASDC
16936 example: __MODEL-NAME-VERSION-ID__
16937 - name: model-element-uuid
16941 example: __MODEL-ELEMENT-UUID__
16944 description: Type of the model, e.g., service, resource, widget, etc.
16949 description: Name of the model, which can change from version to version.
16954 description: Invariant unique ID which does not change from version to version
16957 - name: model-version
16959 description: Version
16962 /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship:
16965 - ServiceDesignAndCreation
16966 summary: see node definition for valid relationships
16967 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementRelationshipListRelationship
16976 description: Response codes found in [response codes](https://wiki.onap.org/).
16978 - name: model-name-version-id
16980 description: Unique identifier corresponding to one version of a model in ASDC
16983 example: __MODEL-NAME-VERSION-ID__
16984 - name: model-element-uuid
16988 example: __MODEL-ELEMENT-UUID__
16991 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElement.json)
16994 $ref: "#/definitions/relationship"
16997 - ServiceDesignAndCreation
16998 summary: delete an existing relationship
16999 description: delete an existing relationship
17000 operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElementRelationshipListRelationship
17009 description: Response codes found in [response codes](https://wiki.onap.org/).
17011 - name: model-name-version-id
17013 description: Unique identifier corresponding to one version of a model in ASDC
17016 example: __MODEL-NAME-VERSION-ID__
17017 - name: model-element-uuid
17021 example: __MODEL-ELEMENT-UUID__
17022 /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}:
17025 - ServiceDesignAndCreation
17026 summary: returns model-element
17027 description: returns model-element
17028 operationId: getServiceDesignAndCreationModelsModelModelElementsModelElement
17034 description: successful operation
17036 $ref: "#/getDefinitions/model-element"
17038 description: Response codes found in [response codes](https://wiki.onap.org/).
17040 - name: model-name-version-id
17042 description: Unique identifier corresponding to one version of a model in ASDC
17045 example: __MODEL-NAME-VERSION-ID__
17046 - name: model-element-uuid
17050 example: __MODEL-ELEMENT-UUID__
17053 description: Type of the model, e.g., service, resource, widget, etc.
17058 description: Name of the model, which can change from version to version.
17063 description: Invariant unique ID which does not change from version to version
17066 - name: model-version
17068 description: Version
17073 - ServiceDesignAndCreation
17074 summary: create or update an existing model-element
17076 Create or update an existing model-element.
17078 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17079 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElement
17088 description: Response codes found in [response codes](https://wiki.onap.org/).
17090 - name: model-name-version-id
17092 description: Unique identifier corresponding to one version of a model in ASDC
17095 example: __MODEL-NAME-VERSION-ID__
17096 - name: model-element-uuid
17100 example: __MODEL-ELEMENT-UUID__
17103 description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElement.json)
17106 $ref: "#/definitions/model-element"
17109 - ServiceDesignAndCreation
17110 summary: update an existing model-element
17112 Update an existing model-element
17114 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17115 The PUT operation will entirely replace an existing object.
17116 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17118 Other differences between PUT and PATCH are:
17120 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17121 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17122 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17123 operationId: UpdateServiceDesignAndCreationModelsModelModelElementsModelElement
17132 description: Response codes found in [response codes](https://wiki.onap.org/).
17134 - name: model-name-version-id
17136 description: Unique identifier corresponding to one version of a model in ASDC
17139 example: __MODEL-NAME-VERSION-ID__
17140 - name: model-element-uuid
17144 example: __MODEL-ELEMENT-UUID__
17147 description: model-element object that needs to be created or updated.
17150 $ref: "#/patchDefinitions/model-element"
17153 - ServiceDesignAndCreation
17154 summary: delete an existing model-element
17155 description: delete an existing model-element
17156 operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElement
17165 description: Response codes found in [response codes](https://wiki.onap.org/).
17167 - name: model-name-version-id
17169 description: Unique identifier corresponding to one version of a model in ASDC
17172 example: __MODEL-NAME-VERSION-ID__
17173 - name: model-element-uuid
17177 example: __MODEL-ELEMENT-UUID__
17178 - name: resource-version
17180 description: resource-version for concurrency
17183 /service-design-and-creation/models/model/{model-name-version-id}/model-elements:
17186 - ServiceDesignAndCreation
17187 summary: returns model-elements
17188 description: returns model-elements
17189 operationId: getServiceDesignAndCreationModelsModelModelElements
17195 description: successful operation
17197 $ref: "#/getDefinitions/model-elements"
17199 description: Response codes found in [response codes](https://wiki.onap.org/).
17201 - name: model-name-version-id
17203 description: Unique identifier corresponding to one version of a model in ASDC
17206 example: __MODEL-NAME-VERSION-ID__
17209 description: Type of the model, e.g., service, resource, widget, etc.
17214 description: Name of the model, which can change from version to version.
17219 description: Invariant unique ID which does not change from version to version
17222 - name: model-version
17224 description: Version
17227 /service-design-and-creation/models/model/{model-name-version-id}/metadata/metadatum/{metaname}:
17230 - ServiceDesignAndCreation
17231 summary: returns metadatum
17232 description: returns metadatum
17233 operationId: getServiceDesignAndCreationModelsModelMetadataMetadatum
17239 description: successful operation
17241 $ref: "#/getDefinitions/metadatum"
17243 description: Response codes found in [response codes](https://wiki.onap.org/).
17245 - name: model-name-version-id
17247 description: Unique identifier corresponding to one version of a model in ASDC
17250 example: __MODEL-NAME-VERSION-ID__
17255 example: __METANAME__
17258 description: Type of the model, e.g., service, resource, widget, etc.
17263 description: Name of the model, which can change from version to version.
17268 description: Invariant unique ID which does not change from version to version
17271 - name: model-version
17273 description: Version
17278 - ServiceDesignAndCreation
17279 summary: create or update an existing metadatum
17281 Create or update an existing metadatum.
17283 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17284 operationId: createOrUpdateServiceDesignAndCreationModelsModelMetadataMetadatum
17293 description: Response codes found in [response codes](https://wiki.onap.org/).
17295 - name: model-name-version-id
17297 description: Unique identifier corresponding to one version of a model in ASDC
17300 example: __MODEL-NAME-VERSION-ID__
17305 example: __METANAME__
17308 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelMetadataMetadatum.json)
17311 $ref: "#/definitions/metadatum"
17314 - ServiceDesignAndCreation
17315 summary: update an existing metadatum
17317 Update an existing metadatum
17319 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17320 The PUT operation will entirely replace an existing object.
17321 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17323 Other differences between PUT and PATCH are:
17325 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17326 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17327 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17328 operationId: UpdateServiceDesignAndCreationModelsModelMetadataMetadatum
17337 description: Response codes found in [response codes](https://wiki.onap.org/).
17339 - name: model-name-version-id
17341 description: Unique identifier corresponding to one version of a model in ASDC
17344 example: __MODEL-NAME-VERSION-ID__
17349 example: __METANAME__
17352 description: metadatum object that needs to be created or updated.
17355 $ref: "#/patchDefinitions/metadatum"
17358 - ServiceDesignAndCreation
17359 summary: delete an existing metadatum
17360 description: delete an existing metadatum
17361 operationId: deleteServiceDesignAndCreationModelsModelMetadataMetadatum
17370 description: Response codes found in [response codes](https://wiki.onap.org/).
17372 - name: model-name-version-id
17374 description: Unique identifier corresponding to one version of a model in ASDC
17377 example: __MODEL-NAME-VERSION-ID__
17382 example: __METANAME__
17383 - name: resource-version
17385 description: resource-version for concurrency
17388 /service-design-and-creation/models/model/{model-name-version-id}/metadata:
17391 - ServiceDesignAndCreation
17392 summary: returns metadata
17393 description: returns metadata
17394 operationId: getServiceDesignAndCreationModelsModelMetadata
17400 description: successful operation
17402 $ref: "#/getDefinitions/metadata"
17404 description: Response codes found in [response codes](https://wiki.onap.org/).
17406 - name: model-name-version-id
17408 description: Unique identifier corresponding to one version of a model in ASDC
17411 example: __MODEL-NAME-VERSION-ID__
17414 description: Type of the model, e.g., service, resource, widget, etc.
17419 description: Name of the model, which can change from version to version.
17424 description: Invariant unique ID which does not change from version to version
17427 - name: model-version
17429 description: Version
17432 /service-design-and-creation/models/model/{model-name-version-id}/relationship-list/relationship:
17435 - ServiceDesignAndCreation
17436 summary: see node definition for valid relationships
17437 operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship
17446 description: Response codes found in [response codes](https://wiki.onap.org/).
17448 - name: model-name-version-id
17450 description: Unique identifier corresponding to one version of a model in ASDC
17453 example: __MODEL-NAME-VERSION-ID__
17456 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModel.json)
17459 $ref: "#/definitions/relationship"
17462 - ServiceDesignAndCreation
17463 summary: delete an existing relationship
17464 description: delete an existing relationship
17465 operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship
17474 description: Response codes found in [response codes](https://wiki.onap.org/).
17476 - name: model-name-version-id
17478 description: Unique identifier corresponding to one version of a model in ASDC
17481 example: __MODEL-NAME-VERSION-ID__
17482 /service-design-and-creation/models/model/{model-name-version-id}:
17485 - ServiceDesignAndCreation
17486 summary: returns model
17487 description: returns model
17488 operationId: getServiceDesignAndCreationModelsModel
17494 description: successful operation
17496 $ref: "#/getDefinitions/model"
17498 description: Response codes found in [response codes](https://wiki.onap.org/).
17500 - name: model-name-version-id
17502 description: Unique identifier corresponding to one version of a model in ASDC
17505 example: __MODEL-NAME-VERSION-ID__
17508 description: Type of the model, e.g., service, resource, widget, etc.
17513 description: Name of the model, which can change from version to version.
17518 description: Invariant unique ID which does not change from version to version
17521 - name: model-version
17523 description: Version
17528 - ServiceDesignAndCreation
17529 summary: create or update an existing model
17531 Create or update an existing model.
17533 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17534 operationId: createOrUpdateServiceDesignAndCreationModelsModel
17543 description: Response codes found in [response codes](https://wiki.onap.org/).
17545 - name: model-name-version-id
17547 description: Unique identifier corresponding to one version of a model in ASDC
17550 example: __MODEL-NAME-VERSION-ID__
17553 description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModel.json)
17556 $ref: "#/definitions/model"
17559 - ServiceDesignAndCreation
17560 summary: update an existing model
17562 Update an existing model
17564 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17565 The PUT operation will entirely replace an existing object.
17566 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17568 Other differences between PUT and PATCH are:
17570 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17571 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17572 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17573 operationId: UpdateServiceDesignAndCreationModelsModel
17582 description: Response codes found in [response codes](https://wiki.onap.org/).
17584 - name: model-name-version-id
17586 description: Unique identifier corresponding to one version of a model in ASDC
17589 example: __MODEL-NAME-VERSION-ID__
17592 description: model object that needs to be created or updated.
17595 $ref: "#/patchDefinitions/model"
17598 - ServiceDesignAndCreation
17599 summary: delete an existing model
17600 description: delete an existing model
17601 operationId: deleteServiceDesignAndCreationModelsModel
17610 description: Response codes found in [response codes](https://wiki.onap.org/).
17612 - name: model-name-version-id
17614 description: Unique identifier corresponding to one version of a model in ASDC
17617 example: __MODEL-NAME-VERSION-ID__
17618 - name: resource-version
17620 description: resource-version for concurrency
17623 /service-design-and-creation/models:
17626 - ServiceDesignAndCreation
17627 summary: returns models
17628 description: returns models
17629 operationId: getServiceDesignAndCreationModels
17635 description: successful operation
17637 $ref: "#/getDefinitions/models"
17639 description: Response codes found in [response codes](https://wiki.onap.org/).
17640 /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:
17643 - ServiceDesignAndCreation
17644 summary: see node definition for valid relationships
17645 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
17654 description: Response codes found in [response codes](https://wiki.onap.org/).
17656 - name: named-query-uuid
17660 example: __NAMED-QUERY-UUID__
17661 - name: named-query-element-uuid
17665 example: __NAMED-QUERY-ELEMENT-UUID__
17666 - name: related-lookup-uuid
17670 example: __RELATED-LOOKUP-UUID__
17673 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
17676 $ref: "#/definitions/relationship"
17679 - ServiceDesignAndCreation
17680 summary: delete an existing relationship
17681 description: delete an existing relationship
17682 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
17691 description: Response codes found in [response codes](https://wiki.onap.org/).
17693 - name: named-query-uuid
17697 example: __NAMED-QUERY-UUID__
17698 - name: named-query-element-uuid
17702 example: __NAMED-QUERY-ELEMENT-UUID__
17703 - name: related-lookup-uuid
17707 example: __RELATED-LOOKUP-UUID__
17708 /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}:
17711 - ServiceDesignAndCreation
17712 summary: returns related-lookup
17713 description: returns related-lookup
17714 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
17720 description: successful operation
17722 $ref: "#/getDefinitions/related-lookup"
17724 description: Response codes found in [response codes](https://wiki.onap.org/).
17726 - name: named-query-uuid
17730 example: __NAMED-QUERY-UUID__
17731 - name: named-query-element-uuid
17735 example: __NAMED-QUERY-ELEMENT-UUID__
17736 - name: related-lookup-uuid
17740 example: __RELATED-LOOKUP-UUID__
17741 - name: named-query-name
17747 - ServiceDesignAndCreation
17748 summary: create or update an existing related-lookup
17750 Create or update an existing related-lookup.
17752 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17753 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
17762 description: Response codes found in [response codes](https://wiki.onap.org/).
17764 - name: named-query-uuid
17768 example: __NAMED-QUERY-UUID__
17769 - name: named-query-element-uuid
17773 example: __NAMED-QUERY-ELEMENT-UUID__
17774 - name: related-lookup-uuid
17778 example: __RELATED-LOOKUP-UUID__
17781 description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
17784 $ref: "#/definitions/related-lookup"
17787 - ServiceDesignAndCreation
17788 summary: update an existing related-lookup
17790 Update an existing related-lookup
17792 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17793 The PUT operation will entirely replace an existing object.
17794 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17796 Other differences between PUT and PATCH are:
17798 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17799 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17800 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17801 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
17810 description: Response codes found in [response codes](https://wiki.onap.org/).
17812 - name: named-query-uuid
17816 example: __NAMED-QUERY-UUID__
17817 - name: named-query-element-uuid
17821 example: __NAMED-QUERY-ELEMENT-UUID__
17822 - name: related-lookup-uuid
17826 example: __RELATED-LOOKUP-UUID__
17829 description: related-lookup object that needs to be created or updated.
17832 $ref: "#/patchDefinitions/related-lookup"
17835 - ServiceDesignAndCreation
17836 summary: delete an existing related-lookup
17837 description: delete an existing related-lookup
17838 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
17847 description: Response codes found in [response codes](https://wiki.onap.org/).
17849 - name: named-query-uuid
17853 example: __NAMED-QUERY-UUID__
17854 - name: named-query-element-uuid
17858 example: __NAMED-QUERY-ELEMENT-UUID__
17859 - name: related-lookup-uuid
17863 example: __RELATED-LOOKUP-UUID__
17864 - name: resource-version
17866 description: resource-version for concurrency
17869 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups:
17872 - ServiceDesignAndCreation
17873 summary: returns related-lookups
17874 description: returns related-lookups
17875 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups
17881 description: successful operation
17883 $ref: "#/getDefinitions/related-lookups"
17885 description: Response codes found in [response codes](https://wiki.onap.org/).
17887 - name: named-query-uuid
17891 example: __NAMED-QUERY-UUID__
17892 - name: named-query-element-uuid
17896 example: __NAMED-QUERY-ELEMENT-UUID__
17897 - name: named-query-name
17901 /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}:
17904 - ServiceDesignAndCreation
17905 summary: returns property-constraint
17906 description: returns property-constraint
17907 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
17913 description: successful operation
17915 $ref: "#/getDefinitions/property-constraint"
17917 description: Response codes found in [response codes](https://wiki.onap.org/).
17919 - name: named-query-uuid
17923 example: __NAMED-QUERY-UUID__
17924 - name: named-query-element-uuid
17928 example: __NAMED-QUERY-ELEMENT-UUID__
17929 - name: property-constraint-uuid
17933 example: __PROPERTY-CONSTRAINT-UUID__
17934 - name: named-query-name
17940 - ServiceDesignAndCreation
17941 summary: create or update an existing property-constraint
17943 Create or update an existing property-constraint.
17945 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17946 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
17955 description: Response codes found in [response codes](https://wiki.onap.org/).
17957 - name: named-query-uuid
17961 example: __NAMED-QUERY-UUID__
17962 - name: named-query-element-uuid
17966 example: __NAMED-QUERY-ELEMENT-UUID__
17967 - name: property-constraint-uuid
17971 example: __PROPERTY-CONSTRAINT-UUID__
17974 description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)
17977 $ref: "#/definitions/property-constraint"
17980 - ServiceDesignAndCreation
17981 summary: update an existing property-constraint
17983 Update an existing property-constraint
17985 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17986 The PUT operation will entirely replace an existing object.
17987 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17989 Other differences between PUT and PATCH are:
17991 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17992 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17993 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17994 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
18003 description: Response codes found in [response codes](https://wiki.onap.org/).
18005 - name: named-query-uuid
18009 example: __NAMED-QUERY-UUID__
18010 - name: named-query-element-uuid
18014 example: __NAMED-QUERY-ELEMENT-UUID__
18015 - name: property-constraint-uuid
18019 example: __PROPERTY-CONSTRAINT-UUID__
18022 description: property-constraint object that needs to be created or updated.
18025 $ref: "#/patchDefinitions/property-constraint"
18028 - ServiceDesignAndCreation
18029 summary: delete an existing property-constraint
18030 description: delete an existing property-constraint
18031 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
18040 description: Response codes found in [response codes](https://wiki.onap.org/).
18042 - name: named-query-uuid
18046 example: __NAMED-QUERY-UUID__
18047 - name: named-query-element-uuid
18051 example: __NAMED-QUERY-ELEMENT-UUID__
18052 - name: property-constraint-uuid
18056 example: __PROPERTY-CONSTRAINT-UUID__
18057 - name: resource-version
18059 description: resource-version for concurrency
18062 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints:
18065 - ServiceDesignAndCreation
18066 summary: returns property-constraints
18067 description: returns property-constraints
18068 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints
18074 description: successful operation
18076 $ref: "#/getDefinitions/property-constraints"
18078 description: Response codes found in [response codes](https://wiki.onap.org/).
18080 - name: named-query-uuid
18084 example: __NAMED-QUERY-UUID__
18085 - name: named-query-element-uuid
18089 example: __NAMED-QUERY-ELEMENT-UUID__
18090 - name: named-query-name
18094 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship:
18097 - ServiceDesignAndCreation
18098 summary: see node definition for valid relationships
18099 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
18108 description: Response codes found in [response codes](https://wiki.onap.org/).
18110 - name: named-query-uuid
18114 example: __NAMED-QUERY-UUID__
18115 - name: named-query-element-uuid
18119 example: __NAMED-QUERY-ELEMENT-UUID__
18122 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
18125 $ref: "#/definitions/relationship"
18128 - ServiceDesignAndCreation
18129 summary: delete an existing relationship
18130 description: delete an existing relationship
18131 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
18140 description: Response codes found in [response codes](https://wiki.onap.org/).
18142 - name: named-query-uuid
18146 example: __NAMED-QUERY-UUID__
18147 - name: named-query-element-uuid
18151 example: __NAMED-QUERY-ELEMENT-UUID__
18152 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}:
18155 - ServiceDesignAndCreation
18156 summary: returns named-query-element
18157 description: returns named-query-element
18158 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
18164 description: successful operation
18166 $ref: "#/getDefinitions/named-query-element"
18168 description: Response codes found in [response codes](https://wiki.onap.org/).
18170 - name: named-query-uuid
18174 example: __NAMED-QUERY-UUID__
18175 - name: named-query-element-uuid
18179 example: __NAMED-QUERY-ELEMENT-UUID__
18180 - name: named-query-name
18186 - ServiceDesignAndCreation
18187 summary: create or update an existing named-query-element
18189 Create or update an existing named-query-element.
18191 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18192 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
18201 description: Response codes found in [response codes](https://wiki.onap.org/).
18203 - name: named-query-uuid
18207 example: __NAMED-QUERY-UUID__
18208 - name: named-query-element-uuid
18212 example: __NAMED-QUERY-ELEMENT-UUID__
18215 description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
18218 $ref: "#/definitions/named-query-element"
18221 - ServiceDesignAndCreation
18222 summary: update an existing named-query-element
18224 Update an existing named-query-element
18226 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18227 The PUT operation will entirely replace an existing object.
18228 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18230 Other differences between PUT and PATCH are:
18232 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18233 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18234 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18235 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
18244 description: Response codes found in [response codes](https://wiki.onap.org/).
18246 - name: named-query-uuid
18250 example: __NAMED-QUERY-UUID__
18251 - name: named-query-element-uuid
18255 example: __NAMED-QUERY-ELEMENT-UUID__
18258 description: named-query-element object that needs to be created or updated.
18261 $ref: "#/patchDefinitions/named-query-element"
18264 - ServiceDesignAndCreation
18265 summary: delete an existing named-query-element
18266 description: delete an existing named-query-element
18267 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
18276 description: Response codes found in [response codes](https://wiki.onap.org/).
18278 - name: named-query-uuid
18282 example: __NAMED-QUERY-UUID__
18283 - name: named-query-element-uuid
18287 example: __NAMED-QUERY-ELEMENT-UUID__
18288 - name: resource-version
18290 description: resource-version for concurrency
18293 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements:
18296 - ServiceDesignAndCreation
18297 summary: returns named-query-elements
18298 description: returns named-query-elements
18299 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements
18305 description: successful operation
18307 $ref: "#/getDefinitions/named-query-elements"
18309 description: Response codes found in [response codes](https://wiki.onap.org/).
18311 - name: named-query-uuid
18315 example: __NAMED-QUERY-UUID__
18316 - name: named-query-name
18320 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship:
18323 - ServiceDesignAndCreation
18324 summary: see node definition for valid relationships
18325 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
18334 description: Response codes found in [response codes](https://wiki.onap.org/).
18336 - name: named-query-uuid
18340 example: __NAMED-QUERY-UUID__
18343 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
18346 $ref: "#/definitions/relationship"
18349 - ServiceDesignAndCreation
18350 summary: delete an existing relationship
18351 description: delete an existing relationship
18352 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
18361 description: Response codes found in [response codes](https://wiki.onap.org/).
18363 - name: named-query-uuid
18367 example: __NAMED-QUERY-UUID__
18368 /service-design-and-creation/named-queries/named-query/{named-query-uuid}:
18371 - ServiceDesignAndCreation
18372 summary: returns named-query
18373 description: returns named-query
18374 operationId: getServiceDesignAndCreationNamedQueriesNamedQuery
18380 description: successful operation
18382 $ref: "#/getDefinitions/named-query"
18384 description: Response codes found in [response codes](https://wiki.onap.org/).
18386 - name: named-query-uuid
18390 example: __NAMED-QUERY-UUID__
18391 - name: named-query-name
18397 - ServiceDesignAndCreation
18398 summary: create or update an existing named-query
18400 Create or update an existing named-query.
18402 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18403 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery
18412 description: Response codes found in [response codes](https://wiki.onap.org/).
18414 - name: named-query-uuid
18418 example: __NAMED-QUERY-UUID__
18421 description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
18424 $ref: "#/definitions/named-query"
18427 - ServiceDesignAndCreation
18428 summary: update an existing named-query
18430 Update an existing named-query
18432 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18433 The PUT operation will entirely replace an existing object.
18434 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18436 Other differences between PUT and PATCH are:
18438 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18439 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18440 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18441 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQuery
18450 description: Response codes found in [response codes](https://wiki.onap.org/).
18452 - name: named-query-uuid
18456 example: __NAMED-QUERY-UUID__
18459 description: named-query object that needs to be created or updated.
18462 $ref: "#/patchDefinitions/named-query"
18465 - ServiceDesignAndCreation
18466 summary: delete an existing named-query
18467 description: delete an existing named-query
18468 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery
18477 description: Response codes found in [response codes](https://wiki.onap.org/).
18479 - name: named-query-uuid
18483 example: __NAMED-QUERY-UUID__
18484 - name: resource-version
18486 description: resource-version for concurrency
18489 /service-design-and-creation/named-queries:
18492 - ServiceDesignAndCreation
18493 summary: returns named-queries
18494 description: returns named-queries
18495 operationId: getServiceDesignAndCreationNamedQueries
18501 description: successful operation
18503 $ref: "#/getDefinitions/named-queries"
18505 description: Response codes found in [response codes](https://wiki.onap.org/).
18506 /network/logical-links/logical-link/{link-name}/relationship-list/relationship:
18510 summary: see node definition for valid relationships
18511 operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship
18520 description: Response codes found in [response codes](https://wiki.onap.org/).
18524 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
18527 example: __LINK-NAME__
18530 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkLogicalLinksLogicalLink.json)
18533 $ref: "#/definitions/relationship"
18537 summary: delete an existing relationship
18538 description: delete an existing relationship
18539 operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship
18548 description: Response codes found in [response codes](https://wiki.onap.org/).
18552 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
18555 example: __LINK-NAME__
18556 /network/logical-links/logical-link/{link-name}:
18560 summary: returns logical-link
18561 description: returns logical-link
18562 operationId: getNetworkLogicalLinksLogicalLink
18568 description: successful operation
18570 $ref: "#/getDefinitions/logical-link"
18572 description: Response codes found in [response codes](https://wiki.onap.org/).
18576 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
18579 example: __LINK-NAME__
18580 - name: persona-model-id
18582 description: the ASDC model id for this resource or service model.
18585 - name: persona-model-version
18587 description: the ASDC model version for this resource or service model.
18590 - name: widget-model-id
18592 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
18595 - name: widget-model-version
18597 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
18602 description: UUID of the logical-link, SDNC generates this.
18608 summary: create or update an existing logical-link
18610 Create or update an existing logical-link.
18612 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18613 operationId: createOrUpdateNetworkLogicalLinksLogicalLink
18622 description: Response codes found in [response codes](https://wiki.onap.org/).
18626 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
18629 example: __LINK-NAME__
18632 description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkLogicalLinksLogicalLink.json)
18635 $ref: "#/definitions/logical-link"
18639 summary: update an existing logical-link
18641 Update an existing logical-link
18643 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18644 The PUT operation will entirely replace an existing object.
18645 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18647 Other differences between PUT and PATCH are:
18649 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18650 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18651 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18652 operationId: UpdateNetworkLogicalLinksLogicalLink
18661 description: Response codes found in [response codes](https://wiki.onap.org/).
18665 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
18668 example: __LINK-NAME__
18671 description: logical-link object that needs to be created or updated.
18674 $ref: "#/patchDefinitions/logical-link"
18678 summary: delete an existing logical-link
18679 description: delete an existing logical-link
18680 operationId: deleteNetworkLogicalLinksLogicalLink
18689 description: Response codes found in [response codes](https://wiki.onap.org/).
18693 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
18696 example: __LINK-NAME__
18697 - name: resource-version
18699 description: resource-version for concurrency
18702 /network/logical-links:
18706 summary: returns logical-links
18707 description: returns logical-links
18708 operationId: getNetworkLogicalLinks
18714 description: successful operation
18716 $ref: "#/getDefinitions/logical-links"
18718 description: Response codes found in [response codes](https://wiki.onap.org/).
18719 /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:
18723 summary: see node definition for valid relationships
18724 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
18733 description: Response codes found in [response codes](https://wiki.onap.org/).
18735 - name: site-pair-set-id
18737 description: Unique id of site pair set.
18740 example: __SITE-PAIR-SET-ID__
18741 - name: routing-instance-id
18743 description: Unique id of routing instance
18746 example: __ROUTING-INSTANCE-ID__
18747 - name: site-pair-id
18749 description: unique identifier of probe
18752 example: __SITE-PAIR-ID__
18755 description: unique identifier of probe
18761 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
18764 $ref: "#/definitions/relationship"
18768 summary: delete an existing relationship
18769 description: delete an existing relationship
18770 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
18779 description: Response codes found in [response codes](https://wiki.onap.org/).
18781 - name: site-pair-set-id
18783 description: Unique id of site pair set.
18786 example: __SITE-PAIR-SET-ID__
18787 - name: routing-instance-id
18789 description: Unique id of routing instance
18792 example: __ROUTING-INSTANCE-ID__
18793 - name: site-pair-id
18795 description: unique identifier of probe
18798 example: __SITE-PAIR-ID__
18801 description: unique identifier of probe
18805 /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}:
18809 summary: returns class-of-service
18810 description: returns class-of-service
18811 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
18817 description: successful operation
18819 $ref: "#/getDefinitions/class-of-service"
18821 description: Response codes found in [response codes](https://wiki.onap.org/).
18823 - name: site-pair-set-id
18825 description: Unique id of site pair set.
18828 example: __SITE-PAIR-SET-ID__
18829 - name: routing-instance-id
18831 description: Unique id of routing instance
18834 example: __ROUTING-INSTANCE-ID__
18835 - name: site-pair-id
18837 description: unique identifier of probe
18840 example: __SITE-PAIR-ID__
18843 description: unique identifier of probe
18850 summary: create or update an existing class-of-service
18852 Create or update an existing class-of-service.
18854 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18855 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
18864 description: Response codes found in [response codes](https://wiki.onap.org/).
18866 - name: site-pair-set-id
18868 description: Unique id of site pair set.
18871 example: __SITE-PAIR-SET-ID__
18872 - name: routing-instance-id
18874 description: Unique id of routing instance
18877 example: __ROUTING-INSTANCE-ID__
18878 - name: site-pair-id
18880 description: unique identifier of probe
18883 example: __SITE-PAIR-ID__
18886 description: unique identifier of probe
18892 description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
18895 $ref: "#/definitions/class-of-service"
18899 summary: update an existing class-of-service
18901 Update an existing class-of-service
18903 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18904 The PUT operation will entirely replace an existing object.
18905 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18907 Other differences between PUT and PATCH are:
18909 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18910 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18911 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18912 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
18921 description: Response codes found in [response codes](https://wiki.onap.org/).
18923 - name: site-pair-set-id
18925 description: Unique id of site pair set.
18928 example: __SITE-PAIR-SET-ID__
18929 - name: routing-instance-id
18931 description: Unique id of routing instance
18934 example: __ROUTING-INSTANCE-ID__
18935 - name: site-pair-id
18937 description: unique identifier of probe
18940 example: __SITE-PAIR-ID__
18943 description: unique identifier of probe
18949 description: class-of-service object that needs to be created or updated.
18952 $ref: "#/patchDefinitions/class-of-service"
18956 summary: delete an existing class-of-service
18957 description: delete an existing class-of-service
18958 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
18967 description: Response codes found in [response codes](https://wiki.onap.org/).
18969 - name: site-pair-set-id
18971 description: Unique id of site pair set.
18974 example: __SITE-PAIR-SET-ID__
18975 - name: routing-instance-id
18977 description: Unique id of routing instance
18980 example: __ROUTING-INSTANCE-ID__
18981 - name: site-pair-id
18983 description: unique identifier of probe
18986 example: __SITE-PAIR-ID__
18989 description: unique identifier of probe
18993 - name: resource-version
18995 description: resource-version for concurrency
18998 /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:
19002 summary: returns classes-of-service
19003 description: returns classes-of-service
19004 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService
19010 description: successful operation
19012 $ref: "#/getDefinitions/classes-of-service"
19014 description: Response codes found in [response codes](https://wiki.onap.org/).
19016 - name: site-pair-set-id
19018 description: Unique id of site pair set.
19021 example: __SITE-PAIR-SET-ID__
19022 - name: routing-instance-id
19024 description: Unique id of routing instance
19027 example: __ROUTING-INSTANCE-ID__
19028 - name: site-pair-id
19030 description: unique identifier of probe
19033 example: __SITE-PAIR-ID__
19034 /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:
19038 summary: see node definition for valid relationships
19039 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
19048 description: Response codes found in [response codes](https://wiki.onap.org/).
19050 - name: site-pair-set-id
19052 description: Unique id of site pair set.
19055 example: __SITE-PAIR-SET-ID__
19056 - name: routing-instance-id
19058 description: Unique id of routing instance
19061 example: __ROUTING-INSTANCE-ID__
19062 - name: site-pair-id
19064 description: unique identifier of probe
19067 example: __SITE-PAIR-ID__
19070 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
19073 $ref: "#/definitions/relationship"
19077 summary: delete an existing relationship
19078 description: delete an existing relationship
19079 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
19088 description: Response codes found in [response codes](https://wiki.onap.org/).
19090 - name: site-pair-set-id
19092 description: Unique id of site pair set.
19095 example: __SITE-PAIR-SET-ID__
19096 - name: routing-instance-id
19098 description: Unique id of routing instance
19101 example: __ROUTING-INSTANCE-ID__
19102 - name: site-pair-id
19104 description: unique identifier of probe
19107 example: __SITE-PAIR-ID__
19108 /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}:
19112 summary: returns site-pair
19113 description: returns site-pair
19114 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
19120 description: successful operation
19122 $ref: "#/getDefinitions/site-pair"
19124 description: Response codes found in [response codes](https://wiki.onap.org/).
19126 - name: site-pair-set-id
19128 description: Unique id of site pair set.
19131 example: __SITE-PAIR-SET-ID__
19132 - name: routing-instance-id
19134 description: Unique id of routing instance
19137 example: __ROUTING-INSTANCE-ID__
19138 - name: site-pair-id
19140 description: unique identifier of probe
19143 example: __SITE-PAIR-ID__
19147 summary: create or update an existing site-pair
19149 Create or update an existing site-pair.
19151 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19152 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
19161 description: Response codes found in [response codes](https://wiki.onap.org/).
19163 - name: site-pair-set-id
19165 description: Unique id of site pair set.
19168 example: __SITE-PAIR-SET-ID__
19169 - name: routing-instance-id
19171 description: Unique id of routing instance
19174 example: __ROUTING-INSTANCE-ID__
19175 - name: site-pair-id
19177 description: unique identifier of probe
19180 example: __SITE-PAIR-ID__
19183 description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
19186 $ref: "#/definitions/site-pair"
19190 summary: update an existing site-pair
19192 Update an existing site-pair
19194 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19195 The PUT operation will entirely replace an existing object.
19196 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19198 Other differences between PUT and PATCH are:
19200 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19201 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19202 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19203 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
19212 description: Response codes found in [response codes](https://wiki.onap.org/).
19214 - name: site-pair-set-id
19216 description: Unique id of site pair set.
19219 example: __SITE-PAIR-SET-ID__
19220 - name: routing-instance-id
19222 description: Unique id of routing instance
19225 example: __ROUTING-INSTANCE-ID__
19226 - name: site-pair-id
19228 description: unique identifier of probe
19231 example: __SITE-PAIR-ID__
19234 description: site-pair object that needs to be created or updated.
19237 $ref: "#/patchDefinitions/site-pair"
19241 summary: delete an existing site-pair
19242 description: delete an existing site-pair
19243 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
19252 description: Response codes found in [response codes](https://wiki.onap.org/).
19254 - name: site-pair-set-id
19256 description: Unique id of site pair set.
19259 example: __SITE-PAIR-SET-ID__
19260 - name: routing-instance-id
19262 description: Unique id of routing instance
19265 example: __ROUTING-INSTANCE-ID__
19266 - name: site-pair-id
19268 description: unique identifier of probe
19271 example: __SITE-PAIR-ID__
19272 - name: resource-version
19274 description: resource-version for concurrency
19277 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs:
19281 summary: returns site-pairs
19282 description: returns site-pairs
19283 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs
19289 description: successful operation
19291 $ref: "#/getDefinitions/site-pairs"
19293 description: Response codes found in [response codes](https://wiki.onap.org/).
19295 - name: site-pair-set-id
19297 description: Unique id of site pair set.
19300 example: __SITE-PAIR-SET-ID__
19301 - name: routing-instance-id
19303 description: Unique id of routing instance
19306 example: __ROUTING-INSTANCE-ID__
19307 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship:
19311 summary: see node definition for valid relationships
19312 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
19321 description: Response codes found in [response codes](https://wiki.onap.org/).
19323 - name: site-pair-set-id
19325 description: Unique id of site pair set.
19328 example: __SITE-PAIR-SET-ID__
19329 - name: routing-instance-id
19331 description: Unique id of routing instance
19334 example: __ROUTING-INSTANCE-ID__
19337 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
19340 $ref: "#/definitions/relationship"
19344 summary: delete an existing relationship
19345 description: delete an existing relationship
19346 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
19355 description: Response codes found in [response codes](https://wiki.onap.org/).
19357 - name: site-pair-set-id
19359 description: Unique id of site pair set.
19362 example: __SITE-PAIR-SET-ID__
19363 - name: routing-instance-id
19365 description: Unique id of routing instance
19368 example: __ROUTING-INSTANCE-ID__
19369 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}:
19373 summary: returns routing-instance
19374 description: returns routing-instance
19375 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
19381 description: successful operation
19383 $ref: "#/getDefinitions/routing-instance"
19385 description: Response codes found in [response codes](https://wiki.onap.org/).
19387 - name: site-pair-set-id
19389 description: Unique id of site pair set.
19392 example: __SITE-PAIR-SET-ID__
19393 - name: routing-instance-id
19395 description: Unique id of routing instance
19398 example: __ROUTING-INSTANCE-ID__
19402 summary: create or update an existing routing-instance
19404 Create or update an existing routing-instance.
19406 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19407 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
19416 description: Response codes found in [response codes](https://wiki.onap.org/).
19418 - name: site-pair-set-id
19420 description: Unique id of site pair set.
19423 example: __SITE-PAIR-SET-ID__
19424 - name: routing-instance-id
19426 description: Unique id of routing instance
19429 example: __ROUTING-INSTANCE-ID__
19432 description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
19435 $ref: "#/definitions/routing-instance"
19439 summary: update an existing routing-instance
19441 Update an existing routing-instance
19443 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19444 The PUT operation will entirely replace an existing object.
19445 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19447 Other differences between PUT and PATCH are:
19449 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19450 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19451 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19452 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
19461 description: Response codes found in [response codes](https://wiki.onap.org/).
19463 - name: site-pair-set-id
19465 description: Unique id of site pair set.
19468 example: __SITE-PAIR-SET-ID__
19469 - name: routing-instance-id
19471 description: Unique id of routing instance
19474 example: __ROUTING-INSTANCE-ID__
19477 description: routing-instance object that needs to be created or updated.
19480 $ref: "#/patchDefinitions/routing-instance"
19484 summary: delete an existing routing-instance
19485 description: delete an existing routing-instance
19486 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
19495 description: Response codes found in [response codes](https://wiki.onap.org/).
19497 - name: site-pair-set-id
19499 description: Unique id of site pair set.
19502 example: __SITE-PAIR-SET-ID__
19503 - name: routing-instance-id
19505 description: Unique id of routing instance
19508 example: __ROUTING-INSTANCE-ID__
19509 - name: resource-version
19511 description: resource-version for concurrency
19514 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances:
19518 summary: returns routing-instances
19519 description: returns routing-instances
19520 operationId: getNetworkSitePairSetsSitePairSetRoutingInstances
19526 description: successful operation
19528 $ref: "#/getDefinitions/routing-instances"
19530 description: Response codes found in [response codes](https://wiki.onap.org/).
19532 - name: site-pair-set-id
19534 description: Unique id of site pair set.
19537 example: __SITE-PAIR-SET-ID__
19538 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship:
19542 summary: see node definition for valid relationships
19543 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship
19552 description: Response codes found in [response codes](https://wiki.onap.org/).
19554 - name: site-pair-set-id
19556 description: Unique id of site pair set.
19559 example: __SITE-PAIR-SET-ID__
19562 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSet.json)
19565 $ref: "#/definitions/relationship"
19569 summary: delete an existing relationship
19570 description: delete an existing relationship
19571 operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship
19580 description: Response codes found in [response codes](https://wiki.onap.org/).
19582 - name: site-pair-set-id
19584 description: Unique id of site pair set.
19587 example: __SITE-PAIR-SET-ID__
19588 /network/site-pair-sets/site-pair-set/{site-pair-set-id}:
19592 summary: returns site-pair-set
19593 description: returns site-pair-set
19594 operationId: getNetworkSitePairSetsSitePairSet
19600 description: successful operation
19602 $ref: "#/getDefinitions/site-pair-set"
19604 description: Response codes found in [response codes](https://wiki.onap.org/).
19606 - name: site-pair-set-id
19608 description: Unique id of site pair set.
19611 example: __SITE-PAIR-SET-ID__
19615 summary: create or update an existing site-pair-set
19617 Create or update an existing site-pair-set.
19619 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19620 operationId: createOrUpdateNetworkSitePairSetsSitePairSet
19629 description: Response codes found in [response codes](https://wiki.onap.org/).
19631 - name: site-pair-set-id
19633 description: Unique id of site pair set.
19636 example: __SITE-PAIR-SET-ID__
19639 description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSet.json)
19642 $ref: "#/definitions/site-pair-set"
19646 summary: update an existing site-pair-set
19648 Update an existing site-pair-set
19650 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19651 The PUT operation will entirely replace an existing object.
19652 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19654 Other differences between PUT and PATCH are:
19656 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19657 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19658 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19659 operationId: UpdateNetworkSitePairSetsSitePairSet
19668 description: Response codes found in [response codes](https://wiki.onap.org/).
19670 - name: site-pair-set-id
19672 description: Unique id of site pair set.
19675 example: __SITE-PAIR-SET-ID__
19678 description: site-pair-set object that needs to be created or updated.
19681 $ref: "#/patchDefinitions/site-pair-set"
19685 summary: delete an existing site-pair-set
19686 description: delete an existing site-pair-set
19687 operationId: deleteNetworkSitePairSetsSitePairSet
19696 description: Response codes found in [response codes](https://wiki.onap.org/).
19698 - name: site-pair-set-id
19700 description: Unique id of site pair set.
19703 example: __SITE-PAIR-SET-ID__
19704 - name: resource-version
19706 description: resource-version for concurrency
19709 /network/site-pair-sets:
19713 summary: returns site-pair-sets
19714 description: returns site-pair-sets
19715 operationId: getNetworkSitePairSets
19721 description: successful operation
19723 $ref: "#/getDefinitions/site-pair-sets"
19725 description: Response codes found in [response codes](https://wiki.onap.org/).
19726 /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship:
19730 summary: see node definition for valid relationships
19731 operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship
19740 description: Response codes found in [response codes](https://wiki.onap.org/).
19744 description: VPN ID, globally unique within A&AI
19747 example: __VPN-ID__
19750 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVpnBindingsVpnBinding.json)
19753 $ref: "#/definitions/relationship"
19757 summary: delete an existing relationship
19758 description: delete an existing relationship
19759 operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship
19768 description: Response codes found in [response codes](https://wiki.onap.org/).
19772 description: VPN ID, globally unique within A&AI
19775 example: __VPN-ID__
19776 /network/vpn-bindings/vpn-binding/{vpn-id}:
19780 summary: returns vpn-binding
19781 description: returns vpn-binding
19782 operationId: getNetworkVpnBindingsVpnBinding
19788 description: successful operation
19790 $ref: "#/getDefinitions/vpn-binding"
19792 description: Response codes found in [response codes](https://wiki.onap.org/).
19796 description: VPN ID, globally unique within A&AI
19799 example: __VPN-ID__
19802 description: VPN Name
19805 - name: global-route-target
19807 description: Number used to identify a VPN, globally unique in the network
19813 summary: create or update an existing vpn-binding
19815 Create or update an existing vpn-binding.
19817 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19818 operationId: createOrUpdateNetworkVpnBindingsVpnBinding
19827 description: Response codes found in [response codes](https://wiki.onap.org/).
19831 description: VPN ID, globally unique within A&AI
19834 example: __VPN-ID__
19837 description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVpnBindingsVpnBinding.json)
19840 $ref: "#/definitions/vpn-binding"
19844 summary: update an existing vpn-binding
19846 Update an existing vpn-binding
19848 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19849 The PUT operation will entirely replace an existing object.
19850 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19852 Other differences between PUT and PATCH are:
19854 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19855 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19856 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19857 operationId: UpdateNetworkVpnBindingsVpnBinding
19866 description: Response codes found in [response codes](https://wiki.onap.org/).
19870 description: VPN ID, globally unique within A&AI
19873 example: __VPN-ID__
19876 description: vpn-binding object that needs to be created or updated.
19879 $ref: "#/patchDefinitions/vpn-binding"
19883 summary: delete an existing vpn-binding
19884 description: delete an existing vpn-binding
19885 operationId: deleteNetworkVpnBindingsVpnBinding
19894 description: Response codes found in [response codes](https://wiki.onap.org/).
19898 description: VPN ID, globally unique within A&AI
19901 example: __VPN-ID__
19902 - name: resource-version
19904 description: resource-version for concurrency
19907 /network/vpn-bindings:
19911 summary: returns vpn-bindings
19912 description: returns vpn-bindings
19913 operationId: getNetworkVpnBindings
19919 description: successful operation
19921 $ref: "#/getDefinitions/vpn-bindings"
19923 description: Response codes found in [response codes](https://wiki.onap.org/).
19924 /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
19928 summary: see node definition for valid relationships
19929 operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship
19938 description: Response codes found in [response codes](https://wiki.onap.org/).
19940 - name: equipment-name
19944 example: __EQUIPMENT-NAME__
19947 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPe.json)
19950 $ref: "#/definitions/relationship"
19954 summary: delete an existing relationship
19955 description: delete an existing relationship
19956 operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship
19965 description: Response codes found in [response codes](https://wiki.onap.org/).
19967 - name: equipment-name
19971 example: __EQUIPMENT-NAME__
19972 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
19976 summary: see node definition for valid relationships
19977 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
19986 description: Response codes found in [response codes](https://wiki.onap.org/).
19988 - name: equipment-name
19992 example: __EQUIPMENT-NAME__
19993 - name: interface-name
19995 description: Name that identifies the physical interface
19998 example: __INTERFACE-NAME__
20001 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterface.json)
20004 $ref: "#/definitions/relationship"
20008 summary: delete an existing relationship
20009 description: delete an existing relationship
20010 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
20019 description: Response codes found in [response codes](https://wiki.onap.org/).
20021 - name: equipment-name
20025 example: __EQUIPMENT-NAME__
20026 - name: interface-name
20028 description: Name that identifies the physical interface
20031 example: __INTERFACE-NAME__
20032 /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:
20036 summary: see node definition for valid relationships
20037 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
20046 description: Response codes found in [response codes](https://wiki.onap.org/).
20048 - name: equipment-name
20052 example: __EQUIPMENT-NAME__
20053 - name: interface-name
20055 description: Name that identifies the physical interface
20058 example: __INTERFACE-NAME__
20059 - name: interface-name
20061 description: Name given to the interface
20064 example: __INTERFACE-NAME__
20065 - name: vlan-interface
20067 description: String that identifies the interface
20070 example: __VLAN-INTERFACE__
20073 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
20076 $ref: "#/definitions/relationship"
20080 summary: delete an existing relationship
20081 description: delete an existing relationship
20082 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
20091 description: Response codes found in [response codes](https://wiki.onap.org/).
20093 - name: equipment-name
20097 example: __EQUIPMENT-NAME__
20098 - name: interface-name
20100 description: Name that identifies the physical interface
20103 example: __INTERFACE-NAME__
20104 - name: interface-name
20106 description: Name given to the interface
20109 example: __INTERFACE-NAME__
20110 - name: vlan-interface
20112 description: String that identifies the interface
20115 example: __VLAN-INTERFACE__
20116 /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:
20120 summary: see node definition for valid relationships
20121 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
20130 description: Response codes found in [response codes](https://wiki.onap.org/).
20132 - name: equipment-name
20136 example: __EQUIPMENT-NAME__
20137 - name: interface-name
20139 description: Name that identifies the physical interface
20142 example: __INTERFACE-NAME__
20143 - name: interface-name
20145 description: Name given to the interface
20148 example: __INTERFACE-NAME__
20149 - name: vlan-interface
20151 description: String that identifies the interface
20154 example: __VLAN-INTERFACE__
20155 - name: l3-interface-ipv4-address
20157 description: IP address
20160 example: __L3-INTERFACE-IPV4-ADDRESS__
20163 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
20166 $ref: "#/definitions/relationship"
20170 summary: delete an existing relationship
20171 description: delete an existing relationship
20172 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
20181 description: Response codes found in [response codes](https://wiki.onap.org/).
20183 - name: equipment-name
20187 example: __EQUIPMENT-NAME__
20188 - name: interface-name
20190 description: Name that identifies the physical interface
20193 example: __INTERFACE-NAME__
20194 - name: interface-name
20196 description: Name given to the interface
20199 example: __INTERFACE-NAME__
20200 - name: vlan-interface
20202 description: String that identifies the interface
20205 example: __VLAN-INTERFACE__
20206 - name: l3-interface-ipv4-address
20208 description: IP address
20211 example: __L3-INTERFACE-IPV4-ADDRESS__
20212 /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}:
20216 summary: returns l3-interface-ipv4-address-list
20217 description: returns l3-interface-ipv4-address-list
20218 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
20224 description: successful operation
20226 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
20228 description: Response codes found in [response codes](https://wiki.onap.org/).
20230 - name: equipment-name
20234 example: __EQUIPMENT-NAME__
20235 - name: interface-name
20237 description: Name that identifies the physical interface
20240 example: __INTERFACE-NAME__
20241 - name: interface-name
20243 description: Name given to the interface
20246 example: __INTERFACE-NAME__
20247 - name: vlan-interface
20249 description: String that identifies the interface
20252 example: __VLAN-INTERFACE__
20253 - name: l3-interface-ipv4-address
20255 description: IP address
20258 example: __L3-INTERFACE-IPV4-ADDRESS__
20259 - name: prov-status
20261 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
20264 - name: interface-id
20266 description: ID of interface
20271 description: MAC address for the interface
20274 - name: network-name
20276 description: Name of the network
20279 - name: vlan-id-inner
20281 description: Inner VLAN tag
20287 description: This indicates the customers VPN ID associated with this vlan
20290 - name: vlan-id-inner
20292 description: Inner VLAN tag
20296 - name: neutron-network-id
20298 description: Neutron network id of the interface that address belongs to
20301 - name: neutron-subnet-id
20303 description: Neutron id of subnet that address belongs to
20309 summary: create or update an existing l3-interface-ipv4-address-list
20311 Create or update an existing l3-interface-ipv4-address-list.
20313 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20314 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
20323 description: Response codes found in [response codes](https://wiki.onap.org/).
20325 - name: equipment-name
20329 example: __EQUIPMENT-NAME__
20330 - name: interface-name
20332 description: Name that identifies the physical interface
20335 example: __INTERFACE-NAME__
20336 - name: interface-name
20338 description: Name given to the interface
20341 example: __INTERFACE-NAME__
20342 - name: vlan-interface
20344 description: String that identifies the interface
20347 example: __VLAN-INTERFACE__
20348 - name: l3-interface-ipv4-address
20350 description: IP address
20353 example: __L3-INTERFACE-IPV4-ADDRESS__
20356 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
20359 $ref: "#/definitions/l3-interface-ipv4-address-list"
20363 summary: update an existing l3-interface-ipv4-address-list
20365 Update an existing l3-interface-ipv4-address-list
20367 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20368 The PUT operation will entirely replace an existing object.
20369 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20371 Other differences between PUT and PATCH are:
20373 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20374 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20375 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20376 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
20385 description: Response codes found in [response codes](https://wiki.onap.org/).
20387 - name: equipment-name
20391 example: __EQUIPMENT-NAME__
20392 - name: interface-name
20394 description: Name that identifies the physical interface
20397 example: __INTERFACE-NAME__
20398 - name: interface-name
20400 description: Name given to the interface
20403 example: __INTERFACE-NAME__
20404 - name: vlan-interface
20406 description: String that identifies the interface
20409 example: __VLAN-INTERFACE__
20410 - name: l3-interface-ipv4-address
20412 description: IP address
20415 example: __L3-INTERFACE-IPV4-ADDRESS__
20418 description: l3-interface-ipv4-address-list object that needs to be created or updated.
20421 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
20425 summary: delete an existing l3-interface-ipv4-address-list
20426 description: delete an existing l3-interface-ipv4-address-list
20427 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
20436 description: Response codes found in [response codes](https://wiki.onap.org/).
20438 - name: equipment-name
20442 example: __EQUIPMENT-NAME__
20443 - name: interface-name
20445 description: Name that identifies the physical interface
20448 example: __INTERFACE-NAME__
20449 - name: interface-name
20451 description: Name given to the interface
20454 example: __INTERFACE-NAME__
20455 - name: vlan-interface
20457 description: String that identifies the interface
20460 example: __VLAN-INTERFACE__
20461 - name: l3-interface-ipv4-address
20463 description: IP address
20466 example: __L3-INTERFACE-IPV4-ADDRESS__
20467 - name: resource-version
20469 description: resource-version for concurrency
20472 /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:
20476 summary: see node definition for valid relationships
20477 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
20486 description: Response codes found in [response codes](https://wiki.onap.org/).
20488 - name: equipment-name
20492 example: __EQUIPMENT-NAME__
20493 - name: interface-name
20495 description: Name that identifies the physical interface
20498 example: __INTERFACE-NAME__
20499 - name: interface-name
20501 description: Name given to the interface
20504 example: __INTERFACE-NAME__
20505 - name: vlan-interface
20507 description: String that identifies the interface
20510 example: __VLAN-INTERFACE__
20511 - name: l3-interface-ipv6-address
20513 description: IP address
20516 example: __L3-INTERFACE-IPV6-ADDRESS__
20519 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
20522 $ref: "#/definitions/relationship"
20526 summary: delete an existing relationship
20527 description: delete an existing relationship
20528 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
20537 description: Response codes found in [response codes](https://wiki.onap.org/).
20539 - name: equipment-name
20543 example: __EQUIPMENT-NAME__
20544 - name: interface-name
20546 description: Name that identifies the physical interface
20549 example: __INTERFACE-NAME__
20550 - name: interface-name
20552 description: Name given to the interface
20555 example: __INTERFACE-NAME__
20556 - name: vlan-interface
20558 description: String that identifies the interface
20561 example: __VLAN-INTERFACE__
20562 - name: l3-interface-ipv6-address
20564 description: IP address
20567 example: __L3-INTERFACE-IPV6-ADDRESS__
20568 /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}:
20572 summary: returns l3-interface-ipv6-address-list
20573 description: returns l3-interface-ipv6-address-list
20574 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
20580 description: successful operation
20582 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
20584 description: Response codes found in [response codes](https://wiki.onap.org/).
20586 - name: equipment-name
20590 example: __EQUIPMENT-NAME__
20591 - name: interface-name
20593 description: Name that identifies the physical interface
20596 example: __INTERFACE-NAME__
20597 - name: interface-name
20599 description: Name given to the interface
20602 example: __INTERFACE-NAME__
20603 - name: vlan-interface
20605 description: String that identifies the interface
20608 example: __VLAN-INTERFACE__
20609 - name: l3-interface-ipv6-address
20611 description: IP address
20614 example: __L3-INTERFACE-IPV6-ADDRESS__
20615 - name: prov-status
20617 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
20620 - name: interface-id
20622 description: ID of interface
20627 description: MAC address for the interface
20630 - name: network-name
20632 description: Name of the network
20635 - name: vlan-id-inner
20637 description: Inner VLAN tag
20643 description: This indicates the customers VPN ID associated with this vlan
20646 - name: vlan-id-inner
20648 description: Inner VLAN tag
20652 - name: neutron-network-id
20654 description: Neutron network id of the interface that address belongs to
20657 - name: neutron-subnet-id
20659 description: Neutron id of subnet that address belongs to
20665 summary: create or update an existing l3-interface-ipv6-address-list
20667 Create or update an existing l3-interface-ipv6-address-list.
20669 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20670 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
20679 description: Response codes found in [response codes](https://wiki.onap.org/).
20681 - name: equipment-name
20685 example: __EQUIPMENT-NAME__
20686 - name: interface-name
20688 description: Name that identifies the physical interface
20691 example: __INTERFACE-NAME__
20692 - name: interface-name
20694 description: Name given to the interface
20697 example: __INTERFACE-NAME__
20698 - name: vlan-interface
20700 description: String that identifies the interface
20703 example: __VLAN-INTERFACE__
20704 - name: l3-interface-ipv6-address
20706 description: IP address
20709 example: __L3-INTERFACE-IPV6-ADDRESS__
20712 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
20715 $ref: "#/definitions/l3-interface-ipv6-address-list"
20719 summary: update an existing l3-interface-ipv6-address-list
20721 Update an existing l3-interface-ipv6-address-list
20723 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20724 The PUT operation will entirely replace an existing object.
20725 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20727 Other differences between PUT and PATCH are:
20729 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20730 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20731 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20732 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
20741 description: Response codes found in [response codes](https://wiki.onap.org/).
20743 - name: equipment-name
20747 example: __EQUIPMENT-NAME__
20748 - name: interface-name
20750 description: Name that identifies the physical interface
20753 example: __INTERFACE-NAME__
20754 - name: interface-name
20756 description: Name given to the interface
20759 example: __INTERFACE-NAME__
20760 - name: vlan-interface
20762 description: String that identifies the interface
20765 example: __VLAN-INTERFACE__
20766 - name: l3-interface-ipv6-address
20768 description: IP address
20771 example: __L3-INTERFACE-IPV6-ADDRESS__
20774 description: l3-interface-ipv6-address-list object that needs to be created or updated.
20777 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
20781 summary: delete an existing l3-interface-ipv6-address-list
20782 description: delete an existing l3-interface-ipv6-address-list
20783 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
20792 description: Response codes found in [response codes](https://wiki.onap.org/).
20794 - name: equipment-name
20798 example: __EQUIPMENT-NAME__
20799 - name: interface-name
20801 description: Name that identifies the physical interface
20804 example: __INTERFACE-NAME__
20805 - name: interface-name
20807 description: Name given to the interface
20810 example: __INTERFACE-NAME__
20811 - name: vlan-interface
20813 description: String that identifies the interface
20816 example: __VLAN-INTERFACE__
20817 - name: l3-interface-ipv6-address
20819 description: IP address
20822 example: __L3-INTERFACE-IPV6-ADDRESS__
20823 - name: resource-version
20825 description: resource-version for concurrency
20828 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
20832 summary: returns vlan
20833 description: returns vlan
20834 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
20840 description: successful operation
20842 $ref: "#/getDefinitions/vlan"
20844 description: Response codes found in [response codes](https://wiki.onap.org/).
20846 - name: equipment-name
20850 example: __EQUIPMENT-NAME__
20851 - name: interface-name
20853 description: Name that identifies the physical interface
20856 example: __INTERFACE-NAME__
20857 - name: interface-name
20859 description: Name given to the interface
20862 example: __INTERFACE-NAME__
20863 - name: vlan-interface
20865 description: String that identifies the interface
20868 example: __VLAN-INTERFACE__
20869 - name: prov-status
20871 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
20874 - name: interface-id
20876 description: ID of interface
20881 description: MAC address for the interface
20884 - name: network-name
20886 description: Name of the network
20889 - name: vlan-id-inner
20891 description: Inner VLAN tag
20897 description: This indicates the customers VPN ID associated with this vlan
20903 summary: create or update an existing vlan
20905 Create or update an existing vlan.
20907 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20908 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
20917 description: Response codes found in [response codes](https://wiki.onap.org/).
20919 - name: equipment-name
20923 example: __EQUIPMENT-NAME__
20924 - name: interface-name
20926 description: Name that identifies the physical interface
20929 example: __INTERFACE-NAME__
20930 - name: interface-name
20932 description: Name given to the interface
20935 example: __INTERFACE-NAME__
20936 - name: vlan-interface
20938 description: String that identifies the interface
20941 example: __VLAN-INTERFACE__
20944 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
20947 $ref: "#/definitions/vlan"
20951 summary: update an existing vlan
20953 Update an existing vlan
20955 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20956 The PUT operation will entirely replace an existing object.
20957 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20959 Other differences between PUT and PATCH are:
20961 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20962 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20963 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20964 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
20973 description: Response codes found in [response codes](https://wiki.onap.org/).
20975 - name: equipment-name
20979 example: __EQUIPMENT-NAME__
20980 - name: interface-name
20982 description: Name that identifies the physical interface
20985 example: __INTERFACE-NAME__
20986 - name: interface-name
20988 description: Name given to the interface
20991 example: __INTERFACE-NAME__
20992 - name: vlan-interface
20994 description: String that identifies the interface
20997 example: __VLAN-INTERFACE__
21000 description: vlan object that needs to be created or updated.
21003 $ref: "#/patchDefinitions/vlan"
21007 summary: delete an existing vlan
21008 description: delete an existing vlan
21009 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
21018 description: Response codes found in [response codes](https://wiki.onap.org/).
21020 - name: equipment-name
21024 example: __EQUIPMENT-NAME__
21025 - name: interface-name
21027 description: Name that identifies the physical interface
21030 example: __INTERFACE-NAME__
21031 - name: interface-name
21033 description: Name given to the interface
21036 example: __INTERFACE-NAME__
21037 - name: vlan-interface
21039 description: String that identifies the interface
21042 example: __VLAN-INTERFACE__
21043 - name: resource-version
21045 description: resource-version for concurrency
21048 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
21052 summary: returns vlans
21053 description: returns vlans
21054 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans
21060 description: successful operation
21062 $ref: "#/getDefinitions/vlans"
21064 description: Response codes found in [response codes](https://wiki.onap.org/).
21066 - name: equipment-name
21070 example: __EQUIPMENT-NAME__
21071 - name: interface-name
21073 description: Name that identifies the physical interface
21076 example: __INTERFACE-NAME__
21077 - name: interface-name
21079 description: Name given to the interface
21082 example: __INTERFACE-NAME__
21083 - name: prov-status
21085 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
21088 - name: interface-id
21090 description: ID of interface
21095 description: MAC address for the interface
21098 - name: network-name
21100 description: Name of the network
21103 /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:
21107 summary: see node definition for valid relationships
21108 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
21117 description: Response codes found in [response codes](https://wiki.onap.org/).
21119 - name: equipment-name
21123 example: __EQUIPMENT-NAME__
21124 - name: interface-name
21126 description: Name that identifies the physical interface
21129 example: __INTERFACE-NAME__
21130 - name: interface-name
21132 description: Name given to the interface
21135 example: __INTERFACE-NAME__
21138 description: PCI ID used to identify the sriov-vf
21141 example: __PCI-ID__
21144 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
21147 $ref: "#/definitions/relationship"
21151 summary: delete an existing relationship
21152 description: delete an existing relationship
21153 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
21162 description: Response codes found in [response codes](https://wiki.onap.org/).
21164 - name: equipment-name
21168 example: __EQUIPMENT-NAME__
21169 - name: interface-name
21171 description: Name that identifies the physical interface
21174 example: __INTERFACE-NAME__
21175 - name: interface-name
21177 description: Name given to the interface
21180 example: __INTERFACE-NAME__
21183 description: PCI ID used to identify the sriov-vf
21186 example: __PCI-ID__
21187 /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}:
21191 summary: returns sriov-vf
21192 description: returns sriov-vf
21193 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
21199 description: successful operation
21201 $ref: "#/getDefinitions/sriov-vf"
21203 description: Response codes found in [response codes](https://wiki.onap.org/).
21205 - name: equipment-name
21209 example: __EQUIPMENT-NAME__
21210 - name: interface-name
21212 description: Name that identifies the physical interface
21215 example: __INTERFACE-NAME__
21216 - name: interface-name
21218 description: Name given to the interface
21221 example: __INTERFACE-NAME__
21224 description: PCI ID used to identify the sriov-vf
21227 example: __PCI-ID__
21228 - name: prov-status
21230 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
21233 - name: interface-id
21235 description: ID of interface
21240 description: MAC address for the interface
21243 - name: network-name
21245 description: Name of the network
21248 - name: vf-vlan-filter
21250 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
21253 - name: vf-mac-filter
21255 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
21258 - name: vf-vlan-strip
21260 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
21263 - name: neutron-network-id
21265 description: Neutron network id of the interface
21271 summary: create or update an existing sriov-vf
21273 Create or update an existing sriov-vf.
21275 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21276 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
21285 description: Response codes found in [response codes](https://wiki.onap.org/).
21287 - name: equipment-name
21291 example: __EQUIPMENT-NAME__
21292 - name: interface-name
21294 description: Name that identifies the physical interface
21297 example: __INTERFACE-NAME__
21298 - name: interface-name
21300 description: Name given to the interface
21303 example: __INTERFACE-NAME__
21306 description: PCI ID used to identify the sriov-vf
21309 example: __PCI-ID__
21312 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
21315 $ref: "#/definitions/sriov-vf"
21319 summary: update an existing sriov-vf
21321 Update an existing sriov-vf
21323 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21324 The PUT operation will entirely replace an existing object.
21325 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21327 Other differences between PUT and PATCH are:
21329 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21330 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21331 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21332 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
21341 description: Response codes found in [response codes](https://wiki.onap.org/).
21343 - name: equipment-name
21347 example: __EQUIPMENT-NAME__
21348 - name: interface-name
21350 description: Name that identifies the physical interface
21353 example: __INTERFACE-NAME__
21354 - name: interface-name
21356 description: Name given to the interface
21359 example: __INTERFACE-NAME__
21362 description: PCI ID used to identify the sriov-vf
21365 example: __PCI-ID__
21368 description: sriov-vf object that needs to be created or updated.
21371 $ref: "#/patchDefinitions/sriov-vf"
21375 summary: delete an existing sriov-vf
21376 description: delete an existing sriov-vf
21377 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
21386 description: Response codes found in [response codes](https://wiki.onap.org/).
21388 - name: equipment-name
21392 example: __EQUIPMENT-NAME__
21393 - name: interface-name
21395 description: Name that identifies the physical interface
21398 example: __INTERFACE-NAME__
21399 - name: interface-name
21401 description: Name given to the interface
21404 example: __INTERFACE-NAME__
21407 description: PCI ID used to identify the sriov-vf
21410 example: __PCI-ID__
21411 - name: resource-version
21413 description: resource-version for concurrency
21416 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
21420 summary: returns sriov-vfs
21421 description: returns sriov-vfs
21422 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
21428 description: successful operation
21430 $ref: "#/getDefinitions/sriov-vfs"
21432 description: Response codes found in [response codes](https://wiki.onap.org/).
21434 - name: equipment-name
21438 example: __EQUIPMENT-NAME__
21439 - name: interface-name
21441 description: Name that identifies the physical interface
21444 example: __INTERFACE-NAME__
21445 - name: interface-name
21447 description: Name given to the interface
21450 example: __INTERFACE-NAME__
21451 - name: prov-status
21453 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
21456 - name: interface-id
21458 description: ID of interface
21463 description: MAC address for the interface
21466 - name: network-name
21468 description: Name of the network
21471 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
21475 summary: see node definition for valid relationships
21476 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
21485 description: Response codes found in [response codes](https://wiki.onap.org/).
21487 - name: equipment-name
21491 example: __EQUIPMENT-NAME__
21492 - name: interface-name
21494 description: Name that identifies the physical interface
21497 example: __INTERFACE-NAME__
21498 - name: interface-name
21500 description: Name given to the interface
21503 example: __INTERFACE-NAME__
21506 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
21509 $ref: "#/definitions/relationship"
21513 summary: delete an existing relationship
21514 description: delete an existing relationship
21515 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
21524 description: Response codes found in [response codes](https://wiki.onap.org/).
21526 - name: equipment-name
21530 example: __EQUIPMENT-NAME__
21531 - name: interface-name
21533 description: Name that identifies the physical interface
21536 example: __INTERFACE-NAME__
21537 - name: interface-name
21539 description: Name given to the interface
21542 example: __INTERFACE-NAME__
21543 /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:
21547 summary: see node definition for valid relationships
21548 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
21557 description: Response codes found in [response codes](https://wiki.onap.org/).
21559 - name: equipment-name
21563 example: __EQUIPMENT-NAME__
21564 - name: interface-name
21566 description: Name that identifies the physical interface
21569 example: __INTERFACE-NAME__
21570 - name: interface-name
21572 description: Name given to the interface
21575 example: __INTERFACE-NAME__
21576 - name: l3-interface-ipv4-address
21578 description: IP address
21581 example: __L3-INTERFACE-IPV4-ADDRESS__
21584 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
21587 $ref: "#/definitions/relationship"
21591 summary: delete an existing relationship
21592 description: delete an existing relationship
21593 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
21602 description: Response codes found in [response codes](https://wiki.onap.org/).
21604 - name: equipment-name
21608 example: __EQUIPMENT-NAME__
21609 - name: interface-name
21611 description: Name that identifies the physical interface
21614 example: __INTERFACE-NAME__
21615 - name: interface-name
21617 description: Name given to the interface
21620 example: __INTERFACE-NAME__
21621 - name: l3-interface-ipv4-address
21623 description: IP address
21626 example: __L3-INTERFACE-IPV4-ADDRESS__
21627 /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}:
21631 summary: returns l3-interface-ipv4-address-list
21632 description: returns l3-interface-ipv4-address-list
21633 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
21639 description: successful operation
21641 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
21643 description: Response codes found in [response codes](https://wiki.onap.org/).
21645 - name: equipment-name
21649 example: __EQUIPMENT-NAME__
21650 - name: interface-name
21652 description: Name that identifies the physical interface
21655 example: __INTERFACE-NAME__
21656 - name: interface-name
21658 description: Name given to the interface
21661 example: __INTERFACE-NAME__
21662 - name: l3-interface-ipv4-address
21664 description: IP address
21667 example: __L3-INTERFACE-IPV4-ADDRESS__
21668 - name: prov-status
21670 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
21673 - name: interface-id
21675 description: ID of interface
21680 description: MAC address for the interface
21683 - name: network-name
21685 description: Name of the network
21688 - name: vlan-id-inner
21690 description: Inner VLAN tag
21694 - name: neutron-network-id
21696 description: Neutron network id of the interface that address belongs to
21699 - name: neutron-subnet-id
21701 description: Neutron id of subnet that address belongs to
21707 summary: create or update an existing l3-interface-ipv4-address-list
21709 Create or update an existing l3-interface-ipv4-address-list.
21711 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21712 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
21721 description: Response codes found in [response codes](https://wiki.onap.org/).
21723 - name: equipment-name
21727 example: __EQUIPMENT-NAME__
21728 - name: interface-name
21730 description: Name that identifies the physical interface
21733 example: __INTERFACE-NAME__
21734 - name: interface-name
21736 description: Name given to the interface
21739 example: __INTERFACE-NAME__
21740 - name: l3-interface-ipv4-address
21742 description: IP address
21745 example: __L3-INTERFACE-IPV4-ADDRESS__
21748 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
21751 $ref: "#/definitions/l3-interface-ipv4-address-list"
21755 summary: update an existing l3-interface-ipv4-address-list
21757 Update an existing l3-interface-ipv4-address-list
21759 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21760 The PUT operation will entirely replace an existing object.
21761 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21763 Other differences between PUT and PATCH are:
21765 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21766 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21767 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21768 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
21777 description: Response codes found in [response codes](https://wiki.onap.org/).
21779 - name: equipment-name
21783 example: __EQUIPMENT-NAME__
21784 - name: interface-name
21786 description: Name that identifies the physical interface
21789 example: __INTERFACE-NAME__
21790 - name: interface-name
21792 description: Name given to the interface
21795 example: __INTERFACE-NAME__
21796 - name: l3-interface-ipv4-address
21798 description: IP address
21801 example: __L3-INTERFACE-IPV4-ADDRESS__
21804 description: l3-interface-ipv4-address-list object that needs to be created or updated.
21807 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
21811 summary: delete an existing l3-interface-ipv4-address-list
21812 description: delete an existing l3-interface-ipv4-address-list
21813 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
21822 description: Response codes found in [response codes](https://wiki.onap.org/).
21824 - name: equipment-name
21828 example: __EQUIPMENT-NAME__
21829 - name: interface-name
21831 description: Name that identifies the physical interface
21834 example: __INTERFACE-NAME__
21835 - name: interface-name
21837 description: Name given to the interface
21840 example: __INTERFACE-NAME__
21841 - name: l3-interface-ipv4-address
21843 description: IP address
21846 example: __L3-INTERFACE-IPV4-ADDRESS__
21847 - name: resource-version
21849 description: resource-version for concurrency
21852 /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:
21856 summary: see node definition for valid relationships
21857 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
21866 description: Response codes found in [response codes](https://wiki.onap.org/).
21868 - name: equipment-name
21872 example: __EQUIPMENT-NAME__
21873 - name: interface-name
21875 description: Name that identifies the physical interface
21878 example: __INTERFACE-NAME__
21879 - name: interface-name
21881 description: Name given to the interface
21884 example: __INTERFACE-NAME__
21885 - name: l3-interface-ipv6-address
21887 description: IP address
21890 example: __L3-INTERFACE-IPV6-ADDRESS__
21893 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
21896 $ref: "#/definitions/relationship"
21900 summary: delete an existing relationship
21901 description: delete an existing relationship
21902 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
21911 description: Response codes found in [response codes](https://wiki.onap.org/).
21913 - name: equipment-name
21917 example: __EQUIPMENT-NAME__
21918 - name: interface-name
21920 description: Name that identifies the physical interface
21923 example: __INTERFACE-NAME__
21924 - name: interface-name
21926 description: Name given to the interface
21929 example: __INTERFACE-NAME__
21930 - name: l3-interface-ipv6-address
21932 description: IP address
21935 example: __L3-INTERFACE-IPV6-ADDRESS__
21936 /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}:
21940 summary: returns l3-interface-ipv6-address-list
21941 description: returns l3-interface-ipv6-address-list
21942 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
21948 description: successful operation
21950 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
21952 description: Response codes found in [response codes](https://wiki.onap.org/).
21954 - name: equipment-name
21958 example: __EQUIPMENT-NAME__
21959 - name: interface-name
21961 description: Name that identifies the physical interface
21964 example: __INTERFACE-NAME__
21965 - name: interface-name
21967 description: Name given to the interface
21970 example: __INTERFACE-NAME__
21971 - name: l3-interface-ipv6-address
21973 description: IP address
21976 example: __L3-INTERFACE-IPV6-ADDRESS__
21977 - name: prov-status
21979 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
21982 - name: interface-id
21984 description: ID of interface
21989 description: MAC address for the interface
21992 - name: network-name
21994 description: Name of the network
21997 - name: vlan-id-inner
21999 description: Inner VLAN tag
22003 - name: neutron-network-id
22005 description: Neutron network id of the interface that address belongs to
22008 - name: neutron-subnet-id
22010 description: Neutron id of subnet that address belongs to
22016 summary: create or update an existing l3-interface-ipv6-address-list
22018 Create or update an existing l3-interface-ipv6-address-list.
22020 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22021 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
22030 description: Response codes found in [response codes](https://wiki.onap.org/).
22032 - name: equipment-name
22036 example: __EQUIPMENT-NAME__
22037 - name: interface-name
22039 description: Name that identifies the physical interface
22042 example: __INTERFACE-NAME__
22043 - name: interface-name
22045 description: Name given to the interface
22048 example: __INTERFACE-NAME__
22049 - name: l3-interface-ipv6-address
22051 description: IP address
22054 example: __L3-INTERFACE-IPV6-ADDRESS__
22057 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
22060 $ref: "#/definitions/l3-interface-ipv6-address-list"
22064 summary: update an existing l3-interface-ipv6-address-list
22066 Update an existing l3-interface-ipv6-address-list
22068 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22069 The PUT operation will entirely replace an existing object.
22070 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22072 Other differences between PUT and PATCH are:
22074 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22075 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22076 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22077 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
22086 description: Response codes found in [response codes](https://wiki.onap.org/).
22088 - name: equipment-name
22092 example: __EQUIPMENT-NAME__
22093 - name: interface-name
22095 description: Name that identifies the physical interface
22098 example: __INTERFACE-NAME__
22099 - name: interface-name
22101 description: Name given to the interface
22104 example: __INTERFACE-NAME__
22105 - name: l3-interface-ipv6-address
22107 description: IP address
22110 example: __L3-INTERFACE-IPV6-ADDRESS__
22113 description: l3-interface-ipv6-address-list object that needs to be created or updated.
22116 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
22120 summary: delete an existing l3-interface-ipv6-address-list
22121 description: delete an existing l3-interface-ipv6-address-list
22122 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
22131 description: Response codes found in [response codes](https://wiki.onap.org/).
22133 - name: equipment-name
22137 example: __EQUIPMENT-NAME__
22138 - name: interface-name
22140 description: Name that identifies the physical interface
22143 example: __INTERFACE-NAME__
22144 - name: interface-name
22146 description: Name given to the interface
22149 example: __INTERFACE-NAME__
22150 - name: l3-interface-ipv6-address
22152 description: IP address
22155 example: __L3-INTERFACE-IPV6-ADDRESS__
22156 - name: resource-version
22158 description: resource-version for concurrency
22161 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
22165 summary: returns l-interface
22166 description: returns l-interface
22167 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
22173 description: successful operation
22175 $ref: "#/getDefinitions/l-interface"
22177 description: Response codes found in [response codes](https://wiki.onap.org/).
22179 - name: equipment-name
22183 example: __EQUIPMENT-NAME__
22184 - name: interface-name
22186 description: Name that identifies the physical interface
22189 example: __INTERFACE-NAME__
22190 - name: interface-name
22192 description: Name given to the interface
22195 example: __INTERFACE-NAME__
22196 - name: prov-status
22198 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22201 - name: interface-id
22203 description: ID of interface
22208 description: MAC address for the interface
22211 - name: network-name
22213 description: Name of the network
22219 summary: create or update an existing l-interface
22221 Create or update an existing l-interface.
22223 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22224 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
22233 description: Response codes found in [response codes](https://wiki.onap.org/).
22235 - name: equipment-name
22239 example: __EQUIPMENT-NAME__
22240 - name: interface-name
22242 description: Name that identifies the physical interface
22245 example: __INTERFACE-NAME__
22246 - name: interface-name
22248 description: Name given to the interface
22251 example: __INTERFACE-NAME__
22254 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
22257 $ref: "#/definitions/l-interface"
22261 summary: update an existing l-interface
22263 Update an existing l-interface
22265 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22266 The PUT operation will entirely replace an existing object.
22267 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22269 Other differences between PUT and PATCH are:
22271 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22272 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22273 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22274 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
22283 description: Response codes found in [response codes](https://wiki.onap.org/).
22285 - name: equipment-name
22289 example: __EQUIPMENT-NAME__
22290 - name: interface-name
22292 description: Name that identifies the physical interface
22295 example: __INTERFACE-NAME__
22296 - name: interface-name
22298 description: Name given to the interface
22301 example: __INTERFACE-NAME__
22304 description: l-interface object that needs to be created or updated.
22307 $ref: "#/patchDefinitions/l-interface"
22311 summary: delete an existing l-interface
22312 description: delete an existing l-interface
22313 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
22322 description: Response codes found in [response codes](https://wiki.onap.org/).
22324 - name: equipment-name
22328 example: __EQUIPMENT-NAME__
22329 - name: interface-name
22331 description: Name that identifies the physical interface
22334 example: __INTERFACE-NAME__
22335 - name: interface-name
22337 description: Name given to the interface
22340 example: __INTERFACE-NAME__
22341 - name: resource-version
22343 description: resource-version for concurrency
22346 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
22350 summary: returns l-interfaces
22351 description: returns l-interfaces
22352 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces
22358 description: successful operation
22360 $ref: "#/getDefinitions/l-interfaces"
22362 description: Response codes found in [response codes](https://wiki.onap.org/).
22364 - name: equipment-name
22368 example: __EQUIPMENT-NAME__
22369 - name: interface-name
22371 description: Name that identifies the physical interface
22374 example: __INTERFACE-NAME__
22375 - name: prov-status
22377 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22380 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}:
22384 summary: returns p-interface
22385 description: returns p-interface
22386 operationId: getNetworkVplsPesVplsPePInterfacesPInterface
22392 description: successful operation
22394 $ref: "#/getDefinitions/p-interface"
22396 description: Response codes found in [response codes](https://wiki.onap.org/).
22398 - name: equipment-name
22402 example: __EQUIPMENT-NAME__
22403 - name: interface-name
22405 description: Name that identifies the physical interface
22408 example: __INTERFACE-NAME__
22409 - name: prov-status
22411 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22417 summary: create or update an existing p-interface
22419 Create or update an existing p-interface.
22421 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22422 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface
22431 description: Response codes found in [response codes](https://wiki.onap.org/).
22433 - name: equipment-name
22437 example: __EQUIPMENT-NAME__
22438 - name: interface-name
22440 description: Name that identifies the physical interface
22443 example: __INTERFACE-NAME__
22446 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterface.json)
22449 $ref: "#/definitions/p-interface"
22453 summary: update an existing p-interface
22455 Update an existing p-interface
22457 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22458 The PUT operation will entirely replace an existing object.
22459 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22461 Other differences between PUT and PATCH are:
22463 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22464 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22465 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22466 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterface
22475 description: Response codes found in [response codes](https://wiki.onap.org/).
22477 - name: equipment-name
22481 example: __EQUIPMENT-NAME__
22482 - name: interface-name
22484 description: Name that identifies the physical interface
22487 example: __INTERFACE-NAME__
22490 description: p-interface object that needs to be created or updated.
22493 $ref: "#/patchDefinitions/p-interface"
22497 summary: delete an existing p-interface
22498 description: delete an existing p-interface
22499 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface
22508 description: Response codes found in [response codes](https://wiki.onap.org/).
22510 - name: equipment-name
22514 example: __EQUIPMENT-NAME__
22515 - name: interface-name
22517 description: Name that identifies the physical interface
22520 example: __INTERFACE-NAME__
22521 - name: resource-version
22523 description: resource-version for concurrency
22526 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces:
22530 summary: returns p-interfaces
22531 description: returns p-interfaces
22532 operationId: getNetworkVplsPesVplsPePInterfaces
22538 description: successful operation
22540 $ref: "#/getDefinitions/p-interfaces"
22542 description: Response codes found in [response codes](https://wiki.onap.org/).
22544 - name: equipment-name
22548 example: __EQUIPMENT-NAME__
22549 - name: prov-status
22551 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22554 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
22558 summary: see node definition for valid relationships
22559 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
22568 description: Response codes found in [response codes](https://wiki.onap.org/).
22570 - name: equipment-name
22574 example: __EQUIPMENT-NAME__
22575 - name: interface-name
22577 description: Name that identifies the link aggregate interface
22580 example: __INTERFACE-NAME__
22583 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
22586 $ref: "#/definitions/relationship"
22590 summary: delete an existing relationship
22591 description: delete an existing relationship
22592 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
22601 description: Response codes found in [response codes](https://wiki.onap.org/).
22603 - name: equipment-name
22607 example: __EQUIPMENT-NAME__
22608 - name: interface-name
22610 description: Name that identifies the link aggregate interface
22613 example: __INTERFACE-NAME__
22614 /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:
22618 summary: see node definition for valid relationships
22619 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
22628 description: Response codes found in [response codes](https://wiki.onap.org/).
22630 - name: equipment-name
22634 example: __EQUIPMENT-NAME__
22635 - name: interface-name
22637 description: Name that identifies the link aggregate interface
22640 example: __INTERFACE-NAME__
22641 - name: interface-name
22643 description: Name given to the interface
22646 example: __INTERFACE-NAME__
22647 - name: vlan-interface
22649 description: String that identifies the interface
22652 example: __VLAN-INTERFACE__
22655 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
22658 $ref: "#/definitions/relationship"
22662 summary: delete an existing relationship
22663 description: delete an existing relationship
22664 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
22673 description: Response codes found in [response codes](https://wiki.onap.org/).
22675 - name: equipment-name
22679 example: __EQUIPMENT-NAME__
22680 - name: interface-name
22682 description: Name that identifies the link aggregate interface
22685 example: __INTERFACE-NAME__
22686 - name: interface-name
22688 description: Name given to the interface
22691 example: __INTERFACE-NAME__
22692 - name: vlan-interface
22694 description: String that identifies the interface
22697 example: __VLAN-INTERFACE__
22698 /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:
22702 summary: see node definition for valid relationships
22703 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
22712 description: Response codes found in [response codes](https://wiki.onap.org/).
22714 - name: equipment-name
22718 example: __EQUIPMENT-NAME__
22719 - name: interface-name
22721 description: Name that identifies the link aggregate interface
22724 example: __INTERFACE-NAME__
22725 - name: interface-name
22727 description: Name given to the interface
22730 example: __INTERFACE-NAME__
22731 - name: vlan-interface
22733 description: String that identifies the interface
22736 example: __VLAN-INTERFACE__
22737 - name: l3-interface-ipv4-address
22739 description: IP address
22742 example: __L3-INTERFACE-IPV4-ADDRESS__
22745 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
22748 $ref: "#/definitions/relationship"
22752 summary: delete an existing relationship
22753 description: delete an existing relationship
22754 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
22763 description: Response codes found in [response codes](https://wiki.onap.org/).
22765 - name: equipment-name
22769 example: __EQUIPMENT-NAME__
22770 - name: interface-name
22772 description: Name that identifies the link aggregate interface
22775 example: __INTERFACE-NAME__
22776 - name: interface-name
22778 description: Name given to the interface
22781 example: __INTERFACE-NAME__
22782 - name: vlan-interface
22784 description: String that identifies the interface
22787 example: __VLAN-INTERFACE__
22788 - name: l3-interface-ipv4-address
22790 description: IP address
22793 example: __L3-INTERFACE-IPV4-ADDRESS__
22794 /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}:
22798 summary: returns l3-interface-ipv4-address-list
22799 description: returns l3-interface-ipv4-address-list
22800 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22806 description: successful operation
22808 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
22810 description: Response codes found in [response codes](https://wiki.onap.org/).
22812 - name: equipment-name
22816 example: __EQUIPMENT-NAME__
22817 - name: interface-name
22819 description: Name that identifies the link aggregate interface
22822 example: __INTERFACE-NAME__
22823 - name: interface-name
22825 description: Name given to the interface
22828 example: __INTERFACE-NAME__
22829 - name: vlan-interface
22831 description: String that identifies the interface
22834 example: __VLAN-INTERFACE__
22835 - name: l3-interface-ipv4-address
22837 description: IP address
22840 example: __L3-INTERFACE-IPV4-ADDRESS__
22841 - name: prov-status
22843 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22846 - name: interface-id
22848 description: ID of interface
22853 description: MAC address for the interface
22856 - name: network-name
22858 description: Name of the network
22861 - name: vlan-id-inner
22863 description: Inner VLAN tag
22869 description: This indicates the customers VPN ID associated with this vlan
22872 - name: vlan-id-inner
22874 description: Inner VLAN tag
22878 - name: neutron-network-id
22880 description: Neutron network id of the interface that address belongs to
22883 - name: neutron-subnet-id
22885 description: Neutron id of subnet that address belongs to
22891 summary: create or update an existing l3-interface-ipv4-address-list
22893 Create or update an existing l3-interface-ipv4-address-list.
22895 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22896 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22905 description: Response codes found in [response codes](https://wiki.onap.org/).
22907 - name: equipment-name
22911 example: __EQUIPMENT-NAME__
22912 - name: interface-name
22914 description: Name that identifies the link aggregate interface
22917 example: __INTERFACE-NAME__
22918 - name: interface-name
22920 description: Name given to the interface
22923 example: __INTERFACE-NAME__
22924 - name: vlan-interface
22926 description: String that identifies the interface
22929 example: __VLAN-INTERFACE__
22930 - name: l3-interface-ipv4-address
22932 description: IP address
22935 example: __L3-INTERFACE-IPV4-ADDRESS__
22938 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
22941 $ref: "#/definitions/l3-interface-ipv4-address-list"
22945 summary: update an existing l3-interface-ipv4-address-list
22947 Update an existing l3-interface-ipv4-address-list
22949 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22950 The PUT operation will entirely replace an existing object.
22951 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22953 Other differences between PUT and PATCH are:
22955 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22956 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22957 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22958 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22967 description: Response codes found in [response codes](https://wiki.onap.org/).
22969 - name: equipment-name
22973 example: __EQUIPMENT-NAME__
22974 - name: interface-name
22976 description: Name that identifies the link aggregate interface
22979 example: __INTERFACE-NAME__
22980 - name: interface-name
22982 description: Name given to the interface
22985 example: __INTERFACE-NAME__
22986 - name: vlan-interface
22988 description: String that identifies the interface
22991 example: __VLAN-INTERFACE__
22992 - name: l3-interface-ipv4-address
22994 description: IP address
22997 example: __L3-INTERFACE-IPV4-ADDRESS__
23000 description: l3-interface-ipv4-address-list object that needs to be created or updated.
23003 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
23007 summary: delete an existing l3-interface-ipv4-address-list
23008 description: delete an existing l3-interface-ipv4-address-list
23009 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
23018 description: Response codes found in [response codes](https://wiki.onap.org/).
23020 - name: equipment-name
23024 example: __EQUIPMENT-NAME__
23025 - name: interface-name
23027 description: Name that identifies the link aggregate interface
23030 example: __INTERFACE-NAME__
23031 - name: interface-name
23033 description: Name given to the interface
23036 example: __INTERFACE-NAME__
23037 - name: vlan-interface
23039 description: String that identifies the interface
23042 example: __VLAN-INTERFACE__
23043 - name: l3-interface-ipv4-address
23045 description: IP address
23048 example: __L3-INTERFACE-IPV4-ADDRESS__
23049 - name: resource-version
23051 description: resource-version for concurrency
23054 /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:
23058 summary: see node definition for valid relationships
23059 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
23068 description: Response codes found in [response codes](https://wiki.onap.org/).
23070 - name: equipment-name
23074 example: __EQUIPMENT-NAME__
23075 - name: interface-name
23077 description: Name that identifies the link aggregate interface
23080 example: __INTERFACE-NAME__
23081 - name: interface-name
23083 description: Name given to the interface
23086 example: __INTERFACE-NAME__
23087 - name: vlan-interface
23089 description: String that identifies the interface
23092 example: __VLAN-INTERFACE__
23093 - name: l3-interface-ipv6-address
23095 description: IP address
23098 example: __L3-INTERFACE-IPV6-ADDRESS__
23101 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
23104 $ref: "#/definitions/relationship"
23108 summary: delete an existing relationship
23109 description: delete an existing relationship
23110 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
23119 description: Response codes found in [response codes](https://wiki.onap.org/).
23121 - name: equipment-name
23125 example: __EQUIPMENT-NAME__
23126 - name: interface-name
23128 description: Name that identifies the link aggregate interface
23131 example: __INTERFACE-NAME__
23132 - name: interface-name
23134 description: Name given to the interface
23137 example: __INTERFACE-NAME__
23138 - name: vlan-interface
23140 description: String that identifies the interface
23143 example: __VLAN-INTERFACE__
23144 - name: l3-interface-ipv6-address
23146 description: IP address
23149 example: __L3-INTERFACE-IPV6-ADDRESS__
23150 /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}:
23154 summary: returns l3-interface-ipv6-address-list
23155 description: returns l3-interface-ipv6-address-list
23156 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
23162 description: successful operation
23164 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
23166 description: Response codes found in [response codes](https://wiki.onap.org/).
23168 - name: equipment-name
23172 example: __EQUIPMENT-NAME__
23173 - name: interface-name
23175 description: Name that identifies the link aggregate interface
23178 example: __INTERFACE-NAME__
23179 - name: interface-name
23181 description: Name given to the interface
23184 example: __INTERFACE-NAME__
23185 - name: vlan-interface
23187 description: String that identifies the interface
23190 example: __VLAN-INTERFACE__
23191 - name: l3-interface-ipv6-address
23193 description: IP address
23196 example: __L3-INTERFACE-IPV6-ADDRESS__
23197 - name: prov-status
23199 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
23202 - name: interface-id
23204 description: ID of interface
23209 description: MAC address for the interface
23212 - name: network-name
23214 description: Name of the network
23217 - name: vlan-id-inner
23219 description: Inner VLAN tag
23225 description: This indicates the customers VPN ID associated with this vlan
23228 - name: vlan-id-inner
23230 description: Inner VLAN tag
23234 - name: neutron-network-id
23236 description: Neutron network id of the interface that address belongs to
23239 - name: neutron-subnet-id
23241 description: Neutron id of subnet that address belongs to
23247 summary: create or update an existing l3-interface-ipv6-address-list
23249 Create or update an existing l3-interface-ipv6-address-list.
23251 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23252 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
23261 description: Response codes found in [response codes](https://wiki.onap.org/).
23263 - name: equipment-name
23267 example: __EQUIPMENT-NAME__
23268 - name: interface-name
23270 description: Name that identifies the link aggregate interface
23273 example: __INTERFACE-NAME__
23274 - name: interface-name
23276 description: Name given to the interface
23279 example: __INTERFACE-NAME__
23280 - name: vlan-interface
23282 description: String that identifies the interface
23285 example: __VLAN-INTERFACE__
23286 - name: l3-interface-ipv6-address
23288 description: IP address
23291 example: __L3-INTERFACE-IPV6-ADDRESS__
23294 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
23297 $ref: "#/definitions/l3-interface-ipv6-address-list"
23301 summary: update an existing l3-interface-ipv6-address-list
23303 Update an existing l3-interface-ipv6-address-list
23305 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23306 The PUT operation will entirely replace an existing object.
23307 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23309 Other differences between PUT and PATCH are:
23311 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23312 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23313 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23314 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
23323 description: Response codes found in [response codes](https://wiki.onap.org/).
23325 - name: equipment-name
23329 example: __EQUIPMENT-NAME__
23330 - name: interface-name
23332 description: Name that identifies the link aggregate interface
23335 example: __INTERFACE-NAME__
23336 - name: interface-name
23338 description: Name given to the interface
23341 example: __INTERFACE-NAME__
23342 - name: vlan-interface
23344 description: String that identifies the interface
23347 example: __VLAN-INTERFACE__
23348 - name: l3-interface-ipv6-address
23350 description: IP address
23353 example: __L3-INTERFACE-IPV6-ADDRESS__
23356 description: l3-interface-ipv6-address-list object that needs to be created or updated.
23359 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
23363 summary: delete an existing l3-interface-ipv6-address-list
23364 description: delete an existing l3-interface-ipv6-address-list
23365 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
23374 description: Response codes found in [response codes](https://wiki.onap.org/).
23376 - name: equipment-name
23380 example: __EQUIPMENT-NAME__
23381 - name: interface-name
23383 description: Name that identifies the link aggregate interface
23386 example: __INTERFACE-NAME__
23387 - name: interface-name
23389 description: Name given to the interface
23392 example: __INTERFACE-NAME__
23393 - name: vlan-interface
23395 description: String that identifies the interface
23398 example: __VLAN-INTERFACE__
23399 - name: l3-interface-ipv6-address
23401 description: IP address
23404 example: __L3-INTERFACE-IPV6-ADDRESS__
23405 - name: resource-version
23407 description: resource-version for concurrency
23410 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
23414 summary: returns vlan
23415 description: returns vlan
23416 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
23422 description: successful operation
23424 $ref: "#/getDefinitions/vlan"
23426 description: Response codes found in [response codes](https://wiki.onap.org/).
23428 - name: equipment-name
23432 example: __EQUIPMENT-NAME__
23433 - name: interface-name
23435 description: Name that identifies the link aggregate interface
23438 example: __INTERFACE-NAME__
23439 - name: interface-name
23441 description: Name given to the interface
23444 example: __INTERFACE-NAME__
23445 - name: vlan-interface
23447 description: String that identifies the interface
23450 example: __VLAN-INTERFACE__
23451 - name: prov-status
23453 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
23456 - name: interface-id
23458 description: ID of interface
23463 description: MAC address for the interface
23466 - name: network-name
23468 description: Name of the network
23471 - name: vlan-id-inner
23473 description: Inner VLAN tag
23479 description: This indicates the customers VPN ID associated with this vlan
23485 summary: create or update an existing vlan
23487 Create or update an existing vlan.
23489 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23490 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
23499 description: Response codes found in [response codes](https://wiki.onap.org/).
23501 - name: equipment-name
23505 example: __EQUIPMENT-NAME__
23506 - name: interface-name
23508 description: Name that identifies the link aggregate interface
23511 example: __INTERFACE-NAME__
23512 - name: interface-name
23514 description: Name given to the interface
23517 example: __INTERFACE-NAME__
23518 - name: vlan-interface
23520 description: String that identifies the interface
23523 example: __VLAN-INTERFACE__
23526 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
23529 $ref: "#/definitions/vlan"
23533 summary: update an existing vlan
23535 Update an existing vlan
23537 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23538 The PUT operation will entirely replace an existing object.
23539 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23541 Other differences between PUT and PATCH are:
23543 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23544 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23545 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23546 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
23555 description: Response codes found in [response codes](https://wiki.onap.org/).
23557 - name: equipment-name
23561 example: __EQUIPMENT-NAME__
23562 - name: interface-name
23564 description: Name that identifies the link aggregate interface
23567 example: __INTERFACE-NAME__
23568 - name: interface-name
23570 description: Name given to the interface
23573 example: __INTERFACE-NAME__
23574 - name: vlan-interface
23576 description: String that identifies the interface
23579 example: __VLAN-INTERFACE__
23582 description: vlan object that needs to be created or updated.
23585 $ref: "#/patchDefinitions/vlan"
23589 summary: delete an existing vlan
23590 description: delete an existing vlan
23591 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
23600 description: Response codes found in [response codes](https://wiki.onap.org/).
23602 - name: equipment-name
23606 example: __EQUIPMENT-NAME__
23607 - name: interface-name
23609 description: Name that identifies the link aggregate interface
23612 example: __INTERFACE-NAME__
23613 - name: interface-name
23615 description: Name given to the interface
23618 example: __INTERFACE-NAME__
23619 - name: vlan-interface
23621 description: String that identifies the interface
23624 example: __VLAN-INTERFACE__
23625 - name: resource-version
23627 description: resource-version for concurrency
23630 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
23634 summary: returns vlans
23635 description: returns vlans
23636 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
23642 description: successful operation
23644 $ref: "#/getDefinitions/vlans"
23646 description: Response codes found in [response codes](https://wiki.onap.org/).
23648 - name: equipment-name
23652 example: __EQUIPMENT-NAME__
23653 - name: interface-name
23655 description: Name that identifies the link aggregate interface
23658 example: __INTERFACE-NAME__
23659 - name: interface-name
23661 description: Name given to the interface
23664 example: __INTERFACE-NAME__
23665 - name: prov-status
23667 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
23670 - name: interface-id
23672 description: ID of interface
23677 description: MAC address for the interface
23680 - name: network-name
23682 description: Name of the network
23685 /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:
23689 summary: see node definition for valid relationships
23690 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
23699 description: Response codes found in [response codes](https://wiki.onap.org/).
23701 - name: equipment-name
23705 example: __EQUIPMENT-NAME__
23706 - name: interface-name
23708 description: Name that identifies the link aggregate interface
23711 example: __INTERFACE-NAME__
23712 - name: interface-name
23714 description: Name given to the interface
23717 example: __INTERFACE-NAME__
23720 description: PCI ID used to identify the sriov-vf
23723 example: __PCI-ID__
23726 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
23729 $ref: "#/definitions/relationship"
23733 summary: delete an existing relationship
23734 description: delete an existing relationship
23735 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
23744 description: Response codes found in [response codes](https://wiki.onap.org/).
23746 - name: equipment-name
23750 example: __EQUIPMENT-NAME__
23751 - name: interface-name
23753 description: Name that identifies the link aggregate interface
23756 example: __INTERFACE-NAME__
23757 - name: interface-name
23759 description: Name given to the interface
23762 example: __INTERFACE-NAME__
23765 description: PCI ID used to identify the sriov-vf
23768 example: __PCI-ID__
23769 /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}:
23773 summary: returns sriov-vf
23774 description: returns sriov-vf
23775 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
23781 description: successful operation
23783 $ref: "#/getDefinitions/sriov-vf"
23785 description: Response codes found in [response codes](https://wiki.onap.org/).
23787 - name: equipment-name
23791 example: __EQUIPMENT-NAME__
23792 - name: interface-name
23794 description: Name that identifies the link aggregate interface
23797 example: __INTERFACE-NAME__
23798 - name: interface-name
23800 description: Name given to the interface
23803 example: __INTERFACE-NAME__
23806 description: PCI ID used to identify the sriov-vf
23809 example: __PCI-ID__
23810 - name: prov-status
23812 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
23815 - name: interface-id
23817 description: ID of interface
23822 description: MAC address for the interface
23825 - name: network-name
23827 description: Name of the network
23830 - name: vf-vlan-filter
23832 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
23835 - name: vf-mac-filter
23837 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
23840 - name: vf-vlan-strip
23842 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
23845 - name: neutron-network-id
23847 description: Neutron network id of the interface
23853 summary: create or update an existing sriov-vf
23855 Create or update an existing sriov-vf.
23857 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23858 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
23867 description: Response codes found in [response codes](https://wiki.onap.org/).
23869 - name: equipment-name
23873 example: __EQUIPMENT-NAME__
23874 - name: interface-name
23876 description: Name that identifies the link aggregate interface
23879 example: __INTERFACE-NAME__
23880 - name: interface-name
23882 description: Name given to the interface
23885 example: __INTERFACE-NAME__
23888 description: PCI ID used to identify the sriov-vf
23891 example: __PCI-ID__
23894 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
23897 $ref: "#/definitions/sriov-vf"
23901 summary: update an existing sriov-vf
23903 Update an existing sriov-vf
23905 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23906 The PUT operation will entirely replace an existing object.
23907 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23909 Other differences between PUT and PATCH are:
23911 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23912 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23913 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23914 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
23923 description: Response codes found in [response codes](https://wiki.onap.org/).
23925 - name: equipment-name
23929 example: __EQUIPMENT-NAME__
23930 - name: interface-name
23932 description: Name that identifies the link aggregate interface
23935 example: __INTERFACE-NAME__
23936 - name: interface-name
23938 description: Name given to the interface
23941 example: __INTERFACE-NAME__
23944 description: PCI ID used to identify the sriov-vf
23947 example: __PCI-ID__
23950 description: sriov-vf object that needs to be created or updated.
23953 $ref: "#/patchDefinitions/sriov-vf"
23957 summary: delete an existing sriov-vf
23958 description: delete an existing sriov-vf
23959 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
23968 description: Response codes found in [response codes](https://wiki.onap.org/).
23970 - name: equipment-name
23974 example: __EQUIPMENT-NAME__
23975 - name: interface-name
23977 description: Name that identifies the link aggregate interface
23980 example: __INTERFACE-NAME__
23981 - name: interface-name
23983 description: Name given to the interface
23986 example: __INTERFACE-NAME__
23989 description: PCI ID used to identify the sriov-vf
23992 example: __PCI-ID__
23993 - name: resource-version
23995 description: resource-version for concurrency
23998 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
24002 summary: returns sriov-vfs
24003 description: returns sriov-vfs
24004 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
24010 description: successful operation
24012 $ref: "#/getDefinitions/sriov-vfs"
24014 description: Response codes found in [response codes](https://wiki.onap.org/).
24016 - name: equipment-name
24020 example: __EQUIPMENT-NAME__
24021 - name: interface-name
24023 description: Name that identifies the link aggregate interface
24026 example: __INTERFACE-NAME__
24027 - name: interface-name
24029 description: Name given to the interface
24032 example: __INTERFACE-NAME__
24033 - name: prov-status
24035 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24038 - name: interface-id
24040 description: ID of interface
24045 description: MAC address for the interface
24048 - name: network-name
24050 description: Name of the network
24053 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
24057 summary: see node definition for valid relationships
24058 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
24067 description: Response codes found in [response codes](https://wiki.onap.org/).
24069 - name: equipment-name
24073 example: __EQUIPMENT-NAME__
24074 - name: interface-name
24076 description: Name that identifies the link aggregate interface
24079 example: __INTERFACE-NAME__
24080 - name: interface-name
24082 description: Name given to the interface
24085 example: __INTERFACE-NAME__
24088 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
24091 $ref: "#/definitions/relationship"
24095 summary: delete an existing relationship
24096 description: delete an existing relationship
24097 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
24106 description: Response codes found in [response codes](https://wiki.onap.org/).
24108 - name: equipment-name
24112 example: __EQUIPMENT-NAME__
24113 - name: interface-name
24115 description: Name that identifies the link aggregate interface
24118 example: __INTERFACE-NAME__
24119 - name: interface-name
24121 description: Name given to the interface
24124 example: __INTERFACE-NAME__
24125 /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:
24129 summary: see node definition for valid relationships
24130 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
24139 description: Response codes found in [response codes](https://wiki.onap.org/).
24141 - name: equipment-name
24145 example: __EQUIPMENT-NAME__
24146 - name: interface-name
24148 description: Name that identifies the link aggregate interface
24151 example: __INTERFACE-NAME__
24152 - name: interface-name
24154 description: Name given to the interface
24157 example: __INTERFACE-NAME__
24158 - name: l3-interface-ipv4-address
24160 description: IP address
24163 example: __L3-INTERFACE-IPV4-ADDRESS__
24166 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
24169 $ref: "#/definitions/relationship"
24173 summary: delete an existing relationship
24174 description: delete an existing relationship
24175 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
24184 description: Response codes found in [response codes](https://wiki.onap.org/).
24186 - name: equipment-name
24190 example: __EQUIPMENT-NAME__
24191 - name: interface-name
24193 description: Name that identifies the link aggregate interface
24196 example: __INTERFACE-NAME__
24197 - name: interface-name
24199 description: Name given to the interface
24202 example: __INTERFACE-NAME__
24203 - name: l3-interface-ipv4-address
24205 description: IP address
24208 example: __L3-INTERFACE-IPV4-ADDRESS__
24209 /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}:
24213 summary: returns l3-interface-ipv4-address-list
24214 description: returns l3-interface-ipv4-address-list
24215 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
24221 description: successful operation
24223 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
24225 description: Response codes found in [response codes](https://wiki.onap.org/).
24227 - name: equipment-name
24231 example: __EQUIPMENT-NAME__
24232 - name: interface-name
24234 description: Name that identifies the link aggregate interface
24237 example: __INTERFACE-NAME__
24238 - name: interface-name
24240 description: Name given to the interface
24243 example: __INTERFACE-NAME__
24244 - name: l3-interface-ipv4-address
24246 description: IP address
24249 example: __L3-INTERFACE-IPV4-ADDRESS__
24250 - name: prov-status
24252 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24255 - name: interface-id
24257 description: ID of interface
24262 description: MAC address for the interface
24265 - name: network-name
24267 description: Name of the network
24270 - name: vlan-id-inner
24272 description: Inner VLAN tag
24276 - name: neutron-network-id
24278 description: Neutron network id of the interface that address belongs to
24281 - name: neutron-subnet-id
24283 description: Neutron id of subnet that address belongs to
24289 summary: create or update an existing l3-interface-ipv4-address-list
24291 Create or update an existing l3-interface-ipv4-address-list.
24293 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24294 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
24303 description: Response codes found in [response codes](https://wiki.onap.org/).
24305 - name: equipment-name
24309 example: __EQUIPMENT-NAME__
24310 - name: interface-name
24312 description: Name that identifies the link aggregate interface
24315 example: __INTERFACE-NAME__
24316 - name: interface-name
24318 description: Name given to the interface
24321 example: __INTERFACE-NAME__
24322 - name: l3-interface-ipv4-address
24324 description: IP address
24327 example: __L3-INTERFACE-IPV4-ADDRESS__
24330 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
24333 $ref: "#/definitions/l3-interface-ipv4-address-list"
24337 summary: update an existing l3-interface-ipv4-address-list
24339 Update an existing l3-interface-ipv4-address-list
24341 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24342 The PUT operation will entirely replace an existing object.
24343 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24345 Other differences between PUT and PATCH are:
24347 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24348 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24349 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24350 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
24359 description: Response codes found in [response codes](https://wiki.onap.org/).
24361 - name: equipment-name
24365 example: __EQUIPMENT-NAME__
24366 - name: interface-name
24368 description: Name that identifies the link aggregate interface
24371 example: __INTERFACE-NAME__
24372 - name: interface-name
24374 description: Name given to the interface
24377 example: __INTERFACE-NAME__
24378 - name: l3-interface-ipv4-address
24380 description: IP address
24383 example: __L3-INTERFACE-IPV4-ADDRESS__
24386 description: l3-interface-ipv4-address-list object that needs to be created or updated.
24389 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
24393 summary: delete an existing l3-interface-ipv4-address-list
24394 description: delete an existing l3-interface-ipv4-address-list
24395 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
24404 description: Response codes found in [response codes](https://wiki.onap.org/).
24406 - name: equipment-name
24410 example: __EQUIPMENT-NAME__
24411 - name: interface-name
24413 description: Name that identifies the link aggregate interface
24416 example: __INTERFACE-NAME__
24417 - name: interface-name
24419 description: Name given to the interface
24422 example: __INTERFACE-NAME__
24423 - name: l3-interface-ipv4-address
24425 description: IP address
24428 example: __L3-INTERFACE-IPV4-ADDRESS__
24429 - name: resource-version
24431 description: resource-version for concurrency
24434 /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:
24438 summary: see node definition for valid relationships
24439 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
24448 description: Response codes found in [response codes](https://wiki.onap.org/).
24450 - name: equipment-name
24454 example: __EQUIPMENT-NAME__
24455 - name: interface-name
24457 description: Name that identifies the link aggregate interface
24460 example: __INTERFACE-NAME__
24461 - name: interface-name
24463 description: Name given to the interface
24466 example: __INTERFACE-NAME__
24467 - name: l3-interface-ipv6-address
24469 description: IP address
24472 example: __L3-INTERFACE-IPV6-ADDRESS__
24475 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
24478 $ref: "#/definitions/relationship"
24482 summary: delete an existing relationship
24483 description: delete an existing relationship
24484 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
24493 description: Response codes found in [response codes](https://wiki.onap.org/).
24495 - name: equipment-name
24499 example: __EQUIPMENT-NAME__
24500 - name: interface-name
24502 description: Name that identifies the link aggregate interface
24505 example: __INTERFACE-NAME__
24506 - name: interface-name
24508 description: Name given to the interface
24511 example: __INTERFACE-NAME__
24512 - name: l3-interface-ipv6-address
24514 description: IP address
24517 example: __L3-INTERFACE-IPV6-ADDRESS__
24518 /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}:
24522 summary: returns l3-interface-ipv6-address-list
24523 description: returns l3-interface-ipv6-address-list
24524 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
24530 description: successful operation
24532 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
24534 description: Response codes found in [response codes](https://wiki.onap.org/).
24536 - name: equipment-name
24540 example: __EQUIPMENT-NAME__
24541 - name: interface-name
24543 description: Name that identifies the link aggregate interface
24546 example: __INTERFACE-NAME__
24547 - name: interface-name
24549 description: Name given to the interface
24552 example: __INTERFACE-NAME__
24553 - name: l3-interface-ipv6-address
24555 description: IP address
24558 example: __L3-INTERFACE-IPV6-ADDRESS__
24559 - name: prov-status
24561 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24564 - name: interface-id
24566 description: ID of interface
24571 description: MAC address for the interface
24574 - name: network-name
24576 description: Name of the network
24579 - name: vlan-id-inner
24581 description: Inner VLAN tag
24585 - name: neutron-network-id
24587 description: Neutron network id of the interface that address belongs to
24590 - name: neutron-subnet-id
24592 description: Neutron id of subnet that address belongs to
24598 summary: create or update an existing l3-interface-ipv6-address-list
24600 Create or update an existing l3-interface-ipv6-address-list.
24602 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24603 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
24612 description: Response codes found in [response codes](https://wiki.onap.org/).
24614 - name: equipment-name
24618 example: __EQUIPMENT-NAME__
24619 - name: interface-name
24621 description: Name that identifies the link aggregate interface
24624 example: __INTERFACE-NAME__
24625 - name: interface-name
24627 description: Name given to the interface
24630 example: __INTERFACE-NAME__
24631 - name: l3-interface-ipv6-address
24633 description: IP address
24636 example: __L3-INTERFACE-IPV6-ADDRESS__
24639 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
24642 $ref: "#/definitions/l3-interface-ipv6-address-list"
24646 summary: update an existing l3-interface-ipv6-address-list
24648 Update an existing l3-interface-ipv6-address-list
24650 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24651 The PUT operation will entirely replace an existing object.
24652 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24654 Other differences between PUT and PATCH are:
24656 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24657 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24658 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24659 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
24668 description: Response codes found in [response codes](https://wiki.onap.org/).
24670 - name: equipment-name
24674 example: __EQUIPMENT-NAME__
24675 - name: interface-name
24677 description: Name that identifies the link aggregate interface
24680 example: __INTERFACE-NAME__
24681 - name: interface-name
24683 description: Name given to the interface
24686 example: __INTERFACE-NAME__
24687 - name: l3-interface-ipv6-address
24689 description: IP address
24692 example: __L3-INTERFACE-IPV6-ADDRESS__
24695 description: l3-interface-ipv6-address-list object that needs to be created or updated.
24698 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
24702 summary: delete an existing l3-interface-ipv6-address-list
24703 description: delete an existing l3-interface-ipv6-address-list
24704 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
24713 description: Response codes found in [response codes](https://wiki.onap.org/).
24715 - name: equipment-name
24719 example: __EQUIPMENT-NAME__
24720 - name: interface-name
24722 description: Name that identifies the link aggregate interface
24725 example: __INTERFACE-NAME__
24726 - name: interface-name
24728 description: Name given to the interface
24731 example: __INTERFACE-NAME__
24732 - name: l3-interface-ipv6-address
24734 description: IP address
24737 example: __L3-INTERFACE-IPV6-ADDRESS__
24738 - name: resource-version
24740 description: resource-version for concurrency
24743 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
24747 summary: returns l-interface
24748 description: returns l-interface
24749 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
24755 description: successful operation
24757 $ref: "#/getDefinitions/l-interface"
24759 description: Response codes found in [response codes](https://wiki.onap.org/).
24761 - name: equipment-name
24765 example: __EQUIPMENT-NAME__
24766 - name: interface-name
24768 description: Name that identifies the link aggregate interface
24771 example: __INTERFACE-NAME__
24772 - name: interface-name
24774 description: Name given to the interface
24777 example: __INTERFACE-NAME__
24778 - name: prov-status
24780 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24783 - name: interface-id
24785 description: ID of interface
24790 description: MAC address for the interface
24793 - name: network-name
24795 description: Name of the network
24801 summary: create or update an existing l-interface
24803 Create or update an existing l-interface.
24805 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24806 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
24815 description: Response codes found in [response codes](https://wiki.onap.org/).
24817 - name: equipment-name
24821 example: __EQUIPMENT-NAME__
24822 - name: interface-name
24824 description: Name that identifies the link aggregate interface
24827 example: __INTERFACE-NAME__
24828 - name: interface-name
24830 description: Name given to the interface
24833 example: __INTERFACE-NAME__
24836 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
24839 $ref: "#/definitions/l-interface"
24843 summary: update an existing l-interface
24845 Update an existing l-interface
24847 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24848 The PUT operation will entirely replace an existing object.
24849 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24851 Other differences between PUT and PATCH are:
24853 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24854 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24855 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24856 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
24865 description: Response codes found in [response codes](https://wiki.onap.org/).
24867 - name: equipment-name
24871 example: __EQUIPMENT-NAME__
24872 - name: interface-name
24874 description: Name that identifies the link aggregate interface
24877 example: __INTERFACE-NAME__
24878 - name: interface-name
24880 description: Name given to the interface
24883 example: __INTERFACE-NAME__
24886 description: l-interface object that needs to be created or updated.
24889 $ref: "#/patchDefinitions/l-interface"
24893 summary: delete an existing l-interface
24894 description: delete an existing l-interface
24895 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
24904 description: Response codes found in [response codes](https://wiki.onap.org/).
24906 - name: equipment-name
24910 example: __EQUIPMENT-NAME__
24911 - name: interface-name
24913 description: Name that identifies the link aggregate interface
24916 example: __INTERFACE-NAME__
24917 - name: interface-name
24919 description: Name given to the interface
24922 example: __INTERFACE-NAME__
24923 - name: resource-version
24925 description: resource-version for concurrency
24928 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
24932 summary: returns l-interfaces
24933 description: returns l-interfaces
24934 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces
24940 description: successful operation
24942 $ref: "#/getDefinitions/l-interfaces"
24944 description: Response codes found in [response codes](https://wiki.onap.org/).
24946 - name: equipment-name
24950 example: __EQUIPMENT-NAME__
24951 - name: interface-name
24953 description: Name that identifies the link aggregate interface
24956 example: __INTERFACE-NAME__
24957 - name: prov-status
24959 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24962 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}:
24966 summary: returns lag-interface
24967 description: returns lag-interface
24968 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface
24974 description: successful operation
24976 $ref: "#/getDefinitions/lag-interface"
24978 description: Response codes found in [response codes](https://wiki.onap.org/).
24980 - name: equipment-name
24984 example: __EQUIPMENT-NAME__
24985 - name: interface-name
24987 description: Name that identifies the link aggregate interface
24990 example: __INTERFACE-NAME__
24991 - name: prov-status
24993 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24999 summary: create or update an existing lag-interface
25001 Create or update an existing lag-interface.
25003 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25004 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
25013 description: Response codes found in [response codes](https://wiki.onap.org/).
25015 - name: equipment-name
25019 example: __EQUIPMENT-NAME__
25020 - name: interface-name
25022 description: Name that identifies the link aggregate interface
25025 example: __INTERFACE-NAME__
25028 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
25031 $ref: "#/definitions/lag-interface"
25035 summary: update an existing lag-interface
25037 Update an existing lag-interface
25039 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25040 The PUT operation will entirely replace an existing object.
25041 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25043 Other differences between PUT and PATCH are:
25045 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25046 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25047 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25048 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
25057 description: Response codes found in [response codes](https://wiki.onap.org/).
25059 - name: equipment-name
25063 example: __EQUIPMENT-NAME__
25064 - name: interface-name
25066 description: Name that identifies the link aggregate interface
25069 example: __INTERFACE-NAME__
25072 description: lag-interface object that needs to be created or updated.
25075 $ref: "#/patchDefinitions/lag-interface"
25079 summary: delete an existing lag-interface
25080 description: delete an existing lag-interface
25081 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface
25090 description: Response codes found in [response codes](https://wiki.onap.org/).
25092 - name: equipment-name
25096 example: __EQUIPMENT-NAME__
25097 - name: interface-name
25099 description: Name that identifies the link aggregate interface
25102 example: __INTERFACE-NAME__
25103 - name: resource-version
25105 description: resource-version for concurrency
25108 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces:
25112 summary: returns lag-interfaces
25113 description: returns lag-interfaces
25114 operationId: getNetworkVplsPesVplsPeLagInterfaces
25120 description: successful operation
25122 $ref: "#/getDefinitions/lag-interfaces"
25124 description: Response codes found in [response codes](https://wiki.onap.org/).
25126 - name: equipment-name
25130 example: __EQUIPMENT-NAME__
25131 - name: prov-status
25133 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25136 /network/vpls-pes/vpls-pe/{equipment-name}:
25140 summary: returns vpls-pe
25141 description: returns vpls-pe
25142 operationId: getNetworkVplsPesVplsPe
25148 description: successful operation
25150 $ref: "#/getDefinitions/vpls-pe"
25152 description: Response codes found in [response codes](https://wiki.onap.org/).
25154 - name: equipment-name
25158 example: __EQUIPMENT-NAME__
25159 - name: prov-status
25161 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25167 summary: create or update an existing vpls-pe
25169 Create or update an existing vpls-pe.
25171 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25172 operationId: createOrUpdateNetworkVplsPesVplsPe
25181 description: Response codes found in [response codes](https://wiki.onap.org/).
25183 - name: equipment-name
25187 example: __EQUIPMENT-NAME__
25190 description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPe.json)
25193 $ref: "#/definitions/vpls-pe"
25197 summary: update an existing vpls-pe
25199 Update an existing vpls-pe
25201 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25202 The PUT operation will entirely replace an existing object.
25203 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25205 Other differences between PUT and PATCH are:
25207 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25208 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25209 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25210 operationId: UpdateNetworkVplsPesVplsPe
25219 description: Response codes found in [response codes](https://wiki.onap.org/).
25221 - name: equipment-name
25225 example: __EQUIPMENT-NAME__
25228 description: vpls-pe object that needs to be created or updated.
25231 $ref: "#/patchDefinitions/vpls-pe"
25235 summary: delete an existing vpls-pe
25236 description: delete an existing vpls-pe
25237 operationId: deleteNetworkVplsPesVplsPe
25246 description: Response codes found in [response codes](https://wiki.onap.org/).
25248 - name: equipment-name
25252 example: __EQUIPMENT-NAME__
25253 - name: resource-version
25255 description: resource-version for concurrency
25262 summary: returns vpls-pes
25263 description: returns vpls-pes
25264 operationId: getNetworkVplsPes
25270 description: successful operation
25272 $ref: "#/getDefinitions/vpls-pes"
25274 description: Response codes found in [response codes](https://wiki.onap.org/).
25275 /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
25279 summary: see node definition for valid relationships
25280 operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
25289 description: Response codes found in [response codes](https://wiki.onap.org/).
25291 - name: multicast-configuration-id
25293 description: Unique id of multicast configuration.
25296 example: __MULTICAST-CONFIGURATION-ID__
25299 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkMulticastConfigurationsMulticastConfiguration.json)
25302 $ref: "#/definitions/relationship"
25306 summary: delete an existing relationship
25307 description: delete an existing relationship
25308 operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
25317 description: Response codes found in [response codes](https://wiki.onap.org/).
25319 - name: multicast-configuration-id
25321 description: Unique id of multicast configuration.
25324 example: __MULTICAST-CONFIGURATION-ID__
25325 /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}:
25329 summary: returns multicast-configuration
25330 description: returns multicast-configuration
25331 operationId: getNetworkMulticastConfigurationsMulticastConfiguration
25337 description: successful operation
25339 $ref: "#/getDefinitions/multicast-configuration"
25341 description: Response codes found in [response codes](https://wiki.onap.org/).
25343 - name: multicast-configuration-id
25345 description: Unique id of multicast configuration.
25348 example: __MULTICAST-CONFIGURATION-ID__
25352 summary: create or update an existing multicast-configuration
25354 Create or update an existing multicast-configuration.
25356 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25357 operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration
25366 description: Response codes found in [response codes](https://wiki.onap.org/).
25368 - name: multicast-configuration-id
25370 description: Unique id of multicast configuration.
25373 example: __MULTICAST-CONFIGURATION-ID__
25376 description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkMulticastConfigurationsMulticastConfiguration.json)
25379 $ref: "#/definitions/multicast-configuration"
25383 summary: update an existing multicast-configuration
25385 Update an existing multicast-configuration
25387 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25388 The PUT operation will entirely replace an existing object.
25389 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25391 Other differences between PUT and PATCH are:
25393 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25394 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25395 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25396 operationId: UpdateNetworkMulticastConfigurationsMulticastConfiguration
25405 description: Response codes found in [response codes](https://wiki.onap.org/).
25407 - name: multicast-configuration-id
25409 description: Unique id of multicast configuration.
25412 example: __MULTICAST-CONFIGURATION-ID__
25415 description: multicast-configuration object that needs to be created or updated.
25418 $ref: "#/patchDefinitions/multicast-configuration"
25422 summary: delete an existing multicast-configuration
25423 description: delete an existing multicast-configuration
25424 operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration
25433 description: Response codes found in [response codes](https://wiki.onap.org/).
25435 - name: multicast-configuration-id
25437 description: Unique id of multicast configuration.
25440 example: __MULTICAST-CONFIGURATION-ID__
25441 - name: resource-version
25443 description: resource-version for concurrency
25446 /network/multicast-configurations:
25450 summary: returns multicast-configurations
25451 description: returns multicast-configurations
25452 operationId: getNetworkMulticastConfigurations
25458 description: successful operation
25460 $ref: "#/getDefinitions/multicast-configurations"
25462 description: Response codes found in [response codes](https://wiki.onap.org/).
25463 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship:
25467 summary: see node definition for valid relationships
25468 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
25477 description: Response codes found in [response codes](https://wiki.onap.org/).
25481 description: Unique id of VNF. This is unique across the graph.
25484 example: __VNF-ID__
25485 - name: interface-id
25487 description: Unique ID of the interface
25490 example: __INTERFACE-ID__
25493 description: See mis-na-virtualization-platform.yang
25497 example: __CVLAN-TAG__
25500 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
25503 $ref: "#/definitions/relationship"
25507 summary: delete an existing relationship
25508 description: delete an existing relationship
25509 operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
25518 description: Response codes found in [response codes](https://wiki.onap.org/).
25522 description: Unique id of VNF. This is unique across the graph.
25525 example: __VNF-ID__
25526 - name: interface-id
25528 description: Unique ID of the interface
25531 example: __INTERFACE-ID__
25534 description: See mis-na-virtualization-platform.yang
25538 example: __CVLAN-TAG__
25539 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
25543 summary: returns cvlan-tag-entry
25544 description: returns cvlan-tag-entry
25545 operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
25551 description: successful operation
25553 $ref: "#/getDefinitions/cvlan-tag-entry"
25555 description: Response codes found in [response codes](https://wiki.onap.org/).
25559 description: Unique id of VNF. This is unique across the graph.
25562 example: __VNF-ID__
25563 - name: interface-id
25565 description: Unique ID of the interface
25568 example: __INTERFACE-ID__
25571 description: See mis-na-virtualization-platform.yang
25575 example: __CVLAN-TAG__
25578 description: Name of VNF.
25583 description: Alternate name of VNF.
25588 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
25593 description: Unique identifier of service from ASDC. Expect this to change as ASDC matures.
25596 - name: regional-resource-zone
25598 description: Regional way of organizing pservers, source of truth should define values
25601 - name: prov-status
25603 description: Trigger for operational monitoring of this resource by Service Assurance systems.
25606 - name: heat-stack-id
25608 description: Heat stack id corresponding to this instance, managed by MSO
25613 description: Unique ID of VPE connected to this VCE.
25616 - name: port-group-id
25618 description: Unique ID for port group in vmware
25621 - name: switch-name
25623 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
25626 - name: heat-stack-id
25628 description: Heat stack id corresponding to this instance, managed by MSO
25634 summary: create or update an existing cvlan-tag-entry
25636 Create or update an existing cvlan-tag-entry.
25638 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25639 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
25648 description: Response codes found in [response codes](https://wiki.onap.org/).
25652 description: Unique id of VNF. This is unique across the graph.
25655 example: __VNF-ID__
25656 - name: interface-id
25658 description: Unique ID of the interface
25661 example: __INTERFACE-ID__
25664 description: See mis-na-virtualization-platform.yang
25668 example: __CVLAN-TAG__
25671 description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
25674 $ref: "#/definitions/cvlan-tag-entry"
25678 summary: update an existing cvlan-tag-entry
25680 Update an existing cvlan-tag-entry
25682 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25683 The PUT operation will entirely replace an existing object.
25684 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25686 Other differences between PUT and PATCH are:
25688 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25689 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25690 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25691 operationId: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
25700 description: Response codes found in [response codes](https://wiki.onap.org/).
25704 description: Unique id of VNF. This is unique across the graph.
25707 example: __VNF-ID__
25708 - name: interface-id
25710 description: Unique ID of the interface
25713 example: __INTERFACE-ID__
25716 description: See mis-na-virtualization-platform.yang
25720 example: __CVLAN-TAG__
25723 description: cvlan-tag-entry object that needs to be created or updated.
25726 $ref: "#/patchDefinitions/cvlan-tag-entry"
25730 summary: delete an existing cvlan-tag-entry
25731 description: delete an existing cvlan-tag-entry
25732 operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
25741 description: Response codes found in [response codes](https://wiki.onap.org/).
25745 description: Unique id of VNF. This is unique across the graph.
25748 example: __VNF-ID__
25749 - name: interface-id
25751 description: Unique ID of the interface
25754 example: __INTERFACE-ID__
25757 description: See mis-na-virtualization-platform.yang
25761 example: __CVLAN-TAG__
25762 - name: resource-version
25764 description: resource-version for concurrency
25767 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags:
25771 summary: returns cvlan-tags
25772 description: returns cvlan-tags
25773 operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags
25779 description: successful operation
25781 $ref: "#/getDefinitions/cvlan-tags"
25783 description: Response codes found in [response codes](https://wiki.onap.org/).
25787 description: Unique id of VNF. This is unique across the graph.
25790 example: __VNF-ID__
25791 - name: interface-id
25793 description: Unique ID of the interface
25796 example: __INTERFACE-ID__
25799 description: Name of VNF.
25804 description: Alternate name of VNF.
25809 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
25814 description: Unique identifier of service from ASDC. Expect this to change as ASDC matures.
25817 - name: regional-resource-zone
25819 description: Regional way of organizing pservers, source of truth should define values
25822 - name: prov-status
25824 description: Trigger for operational monitoring of this resource by Service Assurance systems.
25827 - name: heat-stack-id
25829 description: Heat stack id corresponding to this instance, managed by MSO
25834 description: Unique ID of VPE connected to this VCE.
25837 - name: port-group-id
25839 description: Unique ID for port group in vmware
25842 - name: switch-name
25844 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
25847 - name: heat-stack-id
25849 description: Heat stack id corresponding to this instance, managed by MSO
25852 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
25856 summary: see node definition for valid relationships
25857 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
25866 description: Response codes found in [response codes](https://wiki.onap.org/).
25870 description: Unique id of VNF. This is unique across the graph.
25873 example: __VNF-ID__
25874 - name: interface-id
25876 description: Unique ID of the interface
25879 example: __INTERFACE-ID__
25882 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVcePortGroupsPortGroup.json)
25885 $ref: "#/definitions/relationship"
25889 summary: delete an existing relationship
25890 description: delete an existing relationship
25891 operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
25900 description: Response codes found in [response codes](https://wiki.onap.org/).
25904 description: Unique id of VNF. This is unique across the graph.
25907 example: __VNF-ID__
25908 - name: interface-id
25910 description: Unique ID of the interface
25913 example: __INTERFACE-ID__
25914 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
25918 summary: returns port-group
25919 description: returns port-group
25920 operationId: getNetworkVcesVcePortGroupsPortGroup
25926 description: successful operation
25928 $ref: "#/getDefinitions/port-group"
25930 description: Response codes found in [response codes](https://wiki.onap.org/).
25934 description: Unique id of VNF. This is unique across the graph.
25937 example: __VNF-ID__
25938 - name: interface-id
25940 description: Unique ID of the interface
25943 example: __INTERFACE-ID__
25946 description: Name of VNF.
25951 description: Alternate name of VNF.
25956 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
25961 description: Unique identifier of service from ASDC. Expect this to change as ASDC matures.
25964 - name: regional-resource-zone
25966 description: Regional way of organizing pservers, source of truth should define values
25969 - name: prov-status
25971 description: Trigger for operational monitoring of this resource by Service Assurance systems.
25974 - name: heat-stack-id
25976 description: Heat stack id corresponding to this instance, managed by MSO
25981 description: Unique ID of VPE connected to this VCE.
25984 - name: port-group-id
25986 description: Unique ID for port group in vmware
25989 - name: switch-name
25991 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
25994 - name: heat-stack-id
25996 description: Heat stack id corresponding to this instance, managed by MSO
26002 summary: create or update an existing port-group
26004 Create or update an existing port-group.
26006 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26007 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
26016 description: Response codes found in [response codes](https://wiki.onap.org/).
26020 description: Unique id of VNF. This is unique across the graph.
26023 example: __VNF-ID__
26024 - name: interface-id
26026 description: Unique ID of the interface
26029 example: __INTERFACE-ID__
26032 description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVcePortGroupsPortGroup.json)
26035 $ref: "#/definitions/port-group"
26039 summary: update an existing port-group
26041 Update an existing port-group
26043 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26044 The PUT operation will entirely replace an existing object.
26045 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26047 Other differences between PUT and PATCH are:
26049 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26050 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26051 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26052 operationId: UpdateNetworkVcesVcePortGroupsPortGroup
26061 description: Response codes found in [response codes](https://wiki.onap.org/).
26065 description: Unique id of VNF. This is unique across the graph.
26068 example: __VNF-ID__
26069 - name: interface-id
26071 description: Unique ID of the interface
26074 example: __INTERFACE-ID__
26077 description: port-group object that needs to be created or updated.
26080 $ref: "#/patchDefinitions/port-group"
26084 summary: delete an existing port-group
26085 description: delete an existing port-group
26086 operationId: deleteNetworkVcesVcePortGroupsPortGroup
26095 description: Response codes found in [response codes](https://wiki.onap.org/).
26099 description: Unique id of VNF. This is unique across the graph.
26102 example: __VNF-ID__
26103 - name: interface-id
26105 description: Unique ID of the interface
26108 example: __INTERFACE-ID__
26109 - name: resource-version
26111 description: resource-version for concurrency
26114 /network/vces/vce/{vnf-id}/port-groups:
26118 summary: returns port-groups
26119 description: returns port-groups
26120 operationId: getNetworkVcesVcePortGroups
26126 description: successful operation
26128 $ref: "#/getDefinitions/port-groups"
26130 description: Response codes found in [response codes](https://wiki.onap.org/).
26134 description: Unique id of VNF. This is unique across the graph.
26137 example: __VNF-ID__
26140 description: Name of VNF.
26145 description: Alternate name of VNF.
26150 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
26155 description: Unique identifier of service from ASDC. Expect this to change as ASDC matures.
26158 - name: regional-resource-zone
26160 description: Regional way of organizing pservers, source of truth should define values
26163 - name: prov-status
26165 description: Trigger for operational monitoring of this resource by Service Assurance systems.
26168 - name: heat-stack-id
26170 description: Heat stack id corresponding to this instance, managed by MSO
26175 description: Unique ID of VPE connected to this VCE.
26178 /network/vces/vce/{vnf-id}/relationship-list/relationship:
26182 summary: see node definition for valid relationships
26183 operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship
26192 description: Response codes found in [response codes](https://wiki.onap.org/).
26196 description: Unique id of VNF. This is unique across the graph.
26199 example: __VNF-ID__
26202 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVce.json)
26205 $ref: "#/definitions/relationship"
26209 summary: delete an existing relationship
26210 description: delete an existing relationship
26211 operationId: deleteNetworkVcesVceRelationshipListRelationship
26220 description: Response codes found in [response codes](https://wiki.onap.org/).
26224 description: Unique id of VNF. This is unique across the graph.
26227 example: __VNF-ID__
26228 /network/vces/vce/{vnf-id}:
26232 summary: returns vce
26233 description: returns vce
26234 operationId: getNetworkVcesVce
26240 description: successful operation
26242 $ref: "#/getDefinitions/vce"
26244 description: Response codes found in [response codes](https://wiki.onap.org/).
26248 description: Unique id of VNF. This is unique across the graph.
26251 example: __VNF-ID__
26254 description: Name of VNF.
26259 description: Alternate name of VNF.
26264 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
26269 description: Unique identifier of service from ASDC. Expect this to change as ASDC matures.
26272 - name: regional-resource-zone
26274 description: Regional way of organizing pservers, source of truth should define values
26277 - name: prov-status
26279 description: Trigger for operational monitoring of this resource by Service Assurance systems.
26282 - name: heat-stack-id
26284 description: Heat stack id corresponding to this instance, managed by MSO
26289 description: Unique ID of VPE connected to this VCE.
26295 summary: create or update an existing vce
26297 Create or update an existing vce.
26299 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26300 operationId: createOrUpdateNetworkVcesVce
26309 description: Response codes found in [response codes](https://wiki.onap.org/).
26313 description: Unique id of VNF. This is unique across the graph.
26316 example: __VNF-ID__
26319 description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVce.json)
26322 $ref: "#/definitions/vce"
26326 summary: update an existing vce
26328 Update an existing vce
26330 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26331 The PUT operation will entirely replace an existing object.
26332 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26334 Other differences between PUT and PATCH are:
26336 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26337 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26338 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26339 operationId: UpdateNetworkVcesVce
26348 description: Response codes found in [response codes](https://wiki.onap.org/).
26352 description: Unique id of VNF. This is unique across the graph.
26355 example: __VNF-ID__
26358 description: vce object that needs to be created or updated.
26361 $ref: "#/patchDefinitions/vce"
26365 summary: delete an existing vce
26366 description: delete an existing vce
26367 operationId: deleteNetworkVcesVce
26376 description: Response codes found in [response codes](https://wiki.onap.org/).
26380 description: Unique id of VNF. This is unique across the graph.
26383 example: __VNF-ID__
26384 - name: resource-version
26386 description: resource-version for concurrency
26393 summary: returns vces
26394 description: returns vces
26395 operationId: getNetworkVces
26401 description: successful operation
26403 $ref: "#/getDefinitions/vces"
26405 description: Response codes found in [response codes](https://wiki.onap.org/).
26406 /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
26410 summary: see node definition for valid relationships
26411 operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship
26420 description: Response codes found in [response codes](https://wiki.onap.org/).
26424 description: Unique ID of vnfc.
26427 example: __VNFC-NAME__
26430 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVnfcsVnfc.json)
26433 $ref: "#/definitions/relationship"
26437 summary: delete an existing relationship
26438 description: delete an existing relationship
26439 operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship
26448 description: Response codes found in [response codes](https://wiki.onap.org/).
26452 description: Unique ID of vnfc.
26455 example: __VNFC-NAME__
26456 /network/vnfcs/vnfc/{vnfc-name}:
26460 summary: returns vnfc
26461 description: returns vnfc
26462 operationId: getNetworkVnfcsVnfc
26468 description: successful operation
26470 $ref: "#/getDefinitions/vnfc"
26472 description: Response codes found in [response codes](https://wiki.onap.org/).
26476 description: Unique ID of vnfc.
26479 example: __VNFC-NAME__
26480 - name: vnfc-function-code
26482 description: function code
26490 - name: prov-status
26492 description: prov status of this vnfc
26495 - name: ipaddress-v4-oam-vip
26497 description: Oam V4 vip address of this vnfc
26504 - name: is-closed-loop-disabled
26508 - name: group-notation
26510 description: Group notation of VNFC
26516 summary: create or update an existing vnfc
26518 Create or update an existing vnfc.
26520 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26521 operationId: createOrUpdateNetworkVnfcsVnfc
26530 description: Response codes found in [response codes](https://wiki.onap.org/).
26534 description: Unique ID of vnfc.
26537 example: __VNFC-NAME__
26540 description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVnfcsVnfc.json)
26543 $ref: "#/definitions/vnfc"
26547 summary: update an existing vnfc
26549 Update an existing vnfc
26551 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26552 The PUT operation will entirely replace an existing object.
26553 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26555 Other differences between PUT and PATCH are:
26557 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26558 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26559 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26560 operationId: UpdateNetworkVnfcsVnfc
26569 description: Response codes found in [response codes](https://wiki.onap.org/).
26573 description: Unique ID of vnfc.
26576 example: __VNFC-NAME__
26579 description: vnfc object that needs to be created or updated.
26582 $ref: "#/patchDefinitions/vnfc"
26586 summary: delete an existing vnfc
26587 description: delete an existing vnfc
26588 operationId: deleteNetworkVnfcsVnfc
26597 description: Response codes found in [response codes](https://wiki.onap.org/).
26601 description: Unique ID of vnfc.
26604 example: __VNFC-NAME__
26605 - name: resource-version
26607 description: resource-version for concurrency
26614 summary: returns vnfcs
26615 description: returns vnfcs
26616 operationId: getNetworkVnfcs
26622 description: successful operation
26624 $ref: "#/getDefinitions/vnfcs"
26626 description: Response codes found in [response codes](https://wiki.onap.org/).
26627 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
26631 summary: see node definition for valid relationships
26632 operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
26641 description: Response codes found in [response codes](https://wiki.onap.org/).
26645 description: Network ID, should be uuid. Unique across A&AI.
26648 example: __NETWORK-ID__
26651 description: Subnet ID, should be UUID.
26654 example: __SUBNET-ID__
26657 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
26660 $ref: "#/definitions/relationship"
26664 summary: delete an existing relationship
26665 description: delete an existing relationship
26666 operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
26675 description: Response codes found in [response codes](https://wiki.onap.org/).
26679 description: Network ID, should be uuid. Unique across A&AI.
26682 example: __NETWORK-ID__
26685 description: Subnet ID, should be UUID.
26688 example: __SUBNET-ID__
26689 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}:
26693 summary: returns subnet
26694 description: returns subnet
26695 operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet
26701 description: successful operation
26703 $ref: "#/getDefinitions/subnet"
26705 description: Response codes found in [response codes](https://wiki.onap.org/).
26709 description: Network ID, should be uuid. Unique across A&AI.
26712 example: __NETWORK-ID__
26715 description: Subnet ID, should be UUID.
26718 example: __SUBNET-ID__
26719 - name: network-name
26721 description: Name of the network, governed by some naming convention..
26726 description: Unique identifier of service from ASDC
26729 - name: heat-stack-id
26731 description: Heat stack id corresponding to this instance, managed by MSO
26734 - name: contrail-network-fqdn
26736 description: Contrail FQDN for the network
26739 - name: persona-model-id
26741 description: the ASDC model id for this resource or service model.
26744 - name: persona-model-version
26746 description: the ASDC model version for this resource or service model.
26749 - name: widget-model-id
26751 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
26754 - name: widget-model-version
26756 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
26759 - name: subnet-name
26761 description: Name associated with the subnet.
26767 summary: create or update an existing subnet
26769 Create or update an existing subnet.
26771 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26772 operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet
26781 description: Response codes found in [response codes](https://wiki.onap.org/).
26785 description: Network ID, should be uuid. Unique across A&AI.
26788 example: __NETWORK-ID__
26791 description: Subnet ID, should be UUID.
26794 example: __SUBNET-ID__
26797 description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
26800 $ref: "#/definitions/subnet"
26804 summary: update an existing subnet
26806 Update an existing subnet
26808 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26809 The PUT operation will entirely replace an existing object.
26810 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26812 Other differences between PUT and PATCH are:
26814 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26815 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26816 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26817 operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet
26826 description: Response codes found in [response codes](https://wiki.onap.org/).
26830 description: Network ID, should be uuid. Unique across A&AI.
26833 example: __NETWORK-ID__
26836 description: Subnet ID, should be UUID.
26839 example: __SUBNET-ID__
26842 description: subnet object that needs to be created or updated.
26845 $ref: "#/patchDefinitions/subnet"
26849 summary: delete an existing subnet
26850 description: delete an existing subnet
26851 operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet
26860 description: Response codes found in [response codes](https://wiki.onap.org/).
26864 description: Network ID, should be uuid. Unique across A&AI.
26867 example: __NETWORK-ID__
26870 description: Subnet ID, should be UUID.
26873 example: __SUBNET-ID__
26874 - name: resource-version
26876 description: resource-version for concurrency
26879 /network/l3-networks/l3-network/{network-id}/subnets:
26883 summary: returns subnets
26884 description: returns subnets
26885 operationId: getNetworkL3NetworksL3NetworkSubnets
26891 description: successful operation
26893 $ref: "#/getDefinitions/subnets"
26895 description: Response codes found in [response codes](https://wiki.onap.org/).
26899 description: Network ID, should be uuid. Unique across A&AI.
26902 example: __NETWORK-ID__
26903 - name: network-name
26905 description: Name of the network, governed by some naming convention..
26910 description: Unique identifier of service from ASDC
26913 - name: heat-stack-id
26915 description: Heat stack id corresponding to this instance, managed by MSO
26918 - name: contrail-network-fqdn
26920 description: Contrail FQDN for the network
26923 - name: persona-model-id
26925 description: the ASDC model id for this resource or service model.
26928 - name: persona-model-version
26930 description: the ASDC model version for this resource or service model.
26933 - name: widget-model-id
26935 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
26938 - name: widget-model-version
26940 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
26943 /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship:
26947 summary: see node definition for valid relationships
26948 operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
26957 description: Response codes found in [response codes](https://wiki.onap.org/).
26961 description: Network ID, should be uuid. Unique across A&AI.
26964 example: __NETWORK-ID__
26965 - name: vlan-id-inner
26971 example: __VLAN-ID-INNER__
26974 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
26977 $ref: "#/definitions/relationship"
26981 summary: delete an existing relationship
26982 description: delete an existing relationship
26983 operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
26992 description: Response codes found in [response codes](https://wiki.onap.org/).
26996 description: Network ID, should be uuid. Unique across A&AI.
26999 example: __NETWORK-ID__
27000 - name: vlan-id-inner
27006 example: __VLAN-ID-INNER__
27007 /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}:
27011 summary: returns ctag-assignment
27012 description: returns ctag-assignment
27013 operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
27019 description: successful operation
27021 $ref: "#/getDefinitions/ctag-assignment"
27023 description: Response codes found in [response codes](https://wiki.onap.org/).
27027 description: Network ID, should be uuid. Unique across A&AI.
27030 example: __NETWORK-ID__
27031 - name: vlan-id-inner
27037 example: __VLAN-ID-INNER__
27038 - name: network-name
27040 description: Name of the network, governed by some naming convention..
27045 description: Unique identifier of service from ASDC
27048 - name: heat-stack-id
27050 description: Heat stack id corresponding to this instance, managed by MSO
27053 - name: contrail-network-fqdn
27055 description: Contrail FQDN for the network
27058 - name: persona-model-id
27060 description: the ASDC model id for this resource or service model.
27063 - name: persona-model-version
27065 description: the ASDC model version for this resource or service model.
27068 - name: widget-model-id
27070 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
27073 - name: widget-model-version
27075 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
27081 summary: create or update an existing ctag-assignment
27083 Create or update an existing ctag-assignment.
27085 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27086 operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
27095 description: Response codes found in [response codes](https://wiki.onap.org/).
27099 description: Network ID, should be uuid. Unique across A&AI.
27102 example: __NETWORK-ID__
27103 - name: vlan-id-inner
27109 example: __VLAN-ID-INNER__
27112 description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
27115 $ref: "#/definitions/ctag-assignment"
27119 summary: update an existing ctag-assignment
27121 Update an existing ctag-assignment
27123 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27124 The PUT operation will entirely replace an existing object.
27125 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27127 Other differences between PUT and PATCH are:
27129 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27130 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27131 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27132 operationId: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
27141 description: Response codes found in [response codes](https://wiki.onap.org/).
27145 description: Network ID, should be uuid. Unique across A&AI.
27148 example: __NETWORK-ID__
27149 - name: vlan-id-inner
27155 example: __VLAN-ID-INNER__
27158 description: ctag-assignment object that needs to be created or updated.
27161 $ref: "#/patchDefinitions/ctag-assignment"
27165 summary: delete an existing ctag-assignment
27166 description: delete an existing ctag-assignment
27167 operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
27176 description: Response codes found in [response codes](https://wiki.onap.org/).
27180 description: Network ID, should be uuid. Unique across A&AI.
27183 example: __NETWORK-ID__
27184 - name: vlan-id-inner
27190 example: __VLAN-ID-INNER__
27191 - name: resource-version
27193 description: resource-version for concurrency
27196 /network/l3-networks/l3-network/{network-id}/ctag-assignments:
27200 summary: returns ctag-assignments
27201 description: returns ctag-assignments
27202 operationId: getNetworkL3NetworksL3NetworkCtagAssignments
27208 description: successful operation
27210 $ref: "#/getDefinitions/ctag-assignments"
27212 description: Response codes found in [response codes](https://wiki.onap.org/).
27216 description: Network ID, should be uuid. Unique across A&AI.
27219 example: __NETWORK-ID__
27220 - name: network-name
27222 description: Name of the network, governed by some naming convention..
27227 description: Unique identifier of service from ASDC
27230 - name: heat-stack-id
27232 description: Heat stack id corresponding to this instance, managed by MSO
27235 - name: contrail-network-fqdn
27237 description: Contrail FQDN for the network
27240 - name: persona-model-id
27242 description: the ASDC model id for this resource or service model.
27245 - name: persona-model-version
27247 description: the ASDC model version for this resource or service model.
27250 - name: widget-model-id
27252 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
27255 - name: widget-model-version
27257 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
27260 /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship:
27264 summary: see node definition for valid relationships
27265 operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
27274 description: Response codes found in [response codes](https://wiki.onap.org/).
27278 description: Network ID, should be uuid. Unique across A&AI.
27281 example: __NETWORK-ID__
27282 - name: segmentation-id
27284 description: Route Table Reference id, UUID assigned to this instance.
27287 example: __SEGMENTATION-ID__
27290 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
27293 $ref: "#/definitions/relationship"
27297 summary: delete an existing relationship
27298 description: delete an existing relationship
27299 operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
27308 description: Response codes found in [response codes](https://wiki.onap.org/).
27312 description: Network ID, should be uuid. Unique across A&AI.
27315 example: __NETWORK-ID__
27316 - name: segmentation-id
27318 description: Route Table Reference id, UUID assigned to this instance.
27321 example: __SEGMENTATION-ID__
27322 /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}:
27326 summary: returns segmentation-assignment
27327 description: returns segmentation-assignment
27328 operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
27334 description: successful operation
27336 $ref: "#/getDefinitions/segmentation-assignment"
27338 description: Response codes found in [response codes](https://wiki.onap.org/).
27342 description: Network ID, should be uuid. Unique across A&AI.
27345 example: __NETWORK-ID__
27346 - name: segmentation-id
27348 description: Route Table Reference id, UUID assigned to this instance.
27351 example: __SEGMENTATION-ID__
27352 - name: network-name
27354 description: Name of the network, governed by some naming convention..
27359 description: Unique identifier of service from ASDC
27362 - name: heat-stack-id
27364 description: Heat stack id corresponding to this instance, managed by MSO
27367 - name: contrail-network-fqdn
27369 description: Contrail FQDN for the network
27372 - name: persona-model-id
27374 description: the ASDC model id for this resource or service model.
27377 - name: persona-model-version
27379 description: the ASDC model version for this resource or service model.
27382 - name: widget-model-id
27384 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
27387 - name: widget-model-version
27389 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
27395 summary: create or update an existing segmentation-assignment
27397 Create or update an existing segmentation-assignment.
27399 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27400 operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
27409 description: Response codes found in [response codes](https://wiki.onap.org/).
27413 description: Network ID, should be uuid. Unique across A&AI.
27416 example: __NETWORK-ID__
27417 - name: segmentation-id
27419 description: Route Table Reference id, UUID assigned to this instance.
27422 example: __SEGMENTATION-ID__
27425 description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
27428 $ref: "#/definitions/segmentation-assignment"
27432 summary: update an existing segmentation-assignment
27434 Update an existing segmentation-assignment
27436 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27437 The PUT operation will entirely replace an existing object.
27438 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27440 Other differences between PUT and PATCH are:
27442 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27443 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27444 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27445 operationId: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
27454 description: Response codes found in [response codes](https://wiki.onap.org/).
27458 description: Network ID, should be uuid. Unique across A&AI.
27461 example: __NETWORK-ID__
27462 - name: segmentation-id
27464 description: Route Table Reference id, UUID assigned to this instance.
27467 example: __SEGMENTATION-ID__
27470 description: segmentation-assignment object that needs to be created or updated.
27473 $ref: "#/patchDefinitions/segmentation-assignment"
27477 summary: delete an existing segmentation-assignment
27478 description: delete an existing segmentation-assignment
27479 operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
27488 description: Response codes found in [response codes](https://wiki.onap.org/).
27492 description: Network ID, should be uuid. Unique across A&AI.
27495 example: __NETWORK-ID__
27496 - name: segmentation-id
27498 description: Route Table Reference id, UUID assigned to this instance.
27501 example: __SEGMENTATION-ID__
27502 - name: resource-version
27504 description: resource-version for concurrency
27507 /network/l3-networks/l3-network/{network-id}/segmentation-assignments:
27511 summary: returns segmentation-assignments
27512 description: returns segmentation-assignments
27513 operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments
27519 description: successful operation
27521 $ref: "#/getDefinitions/segmentation-assignments"
27523 description: Response codes found in [response codes](https://wiki.onap.org/).
27527 description: Network ID, should be uuid. Unique across A&AI.
27530 example: __NETWORK-ID__
27531 - name: network-name
27533 description: Name of the network, governed by some naming convention..
27538 description: Unique identifier of service from ASDC
27541 - name: heat-stack-id
27543 description: Heat stack id corresponding to this instance, managed by MSO
27546 - name: contrail-network-fqdn
27548 description: Contrail FQDN for the network
27551 - name: persona-model-id
27553 description: the ASDC model id for this resource or service model.
27556 - name: persona-model-version
27558 description: the ASDC model version for this resource or service model.
27561 - name: widget-model-id
27563 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
27566 - name: widget-model-version
27568 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
27571 /network/l3-networks/l3-network/{network-id}/relationship-list/relationship:
27575 summary: see node definition for valid relationships
27576 operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship
27585 description: Response codes found in [response codes](https://wiki.onap.org/).
27589 description: Network ID, should be uuid. Unique across A&AI.
27592 example: __NETWORK-ID__
27595 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3Network.json)
27598 $ref: "#/definitions/relationship"
27602 summary: delete an existing relationship
27603 description: delete an existing relationship
27604 operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship
27613 description: Response codes found in [response codes](https://wiki.onap.org/).
27617 description: Network ID, should be uuid. Unique across A&AI.
27620 example: __NETWORK-ID__
27621 /network/l3-networks/l3-network/{network-id}:
27625 summary: returns l3-network
27626 description: returns l3-network
27627 operationId: getNetworkL3NetworksL3Network
27633 description: successful operation
27635 $ref: "#/getDefinitions/l3-network"
27637 description: Response codes found in [response codes](https://wiki.onap.org/).
27641 description: Network ID, should be uuid. Unique across A&AI.
27644 example: __NETWORK-ID__
27645 - name: network-name
27647 description: Name of the network, governed by some naming convention..
27652 description: Unique identifier of service from ASDC
27655 - name: heat-stack-id
27657 description: Heat stack id corresponding to this instance, managed by MSO
27660 - name: contrail-network-fqdn
27662 description: Contrail FQDN for the network
27665 - name: persona-model-id
27667 description: the ASDC model id for this resource or service model.
27670 - name: persona-model-version
27672 description: the ASDC model version for this resource or service model.
27675 - name: widget-model-id
27677 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
27680 - name: widget-model-version
27682 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
27688 summary: create or update an existing l3-network
27690 Create or update an existing l3-network.
27692 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27693 operationId: createOrUpdateNetworkL3NetworksL3Network
27702 description: Response codes found in [response codes](https://wiki.onap.org/).
27706 description: Network ID, should be uuid. Unique across A&AI.
27709 example: __NETWORK-ID__
27712 description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3Network.json)
27715 $ref: "#/definitions/l3-network"
27719 summary: update an existing l3-network
27721 Update an existing l3-network
27723 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27724 The PUT operation will entirely replace an existing object.
27725 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27727 Other differences between PUT and PATCH are:
27729 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27730 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27731 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27732 operationId: UpdateNetworkL3NetworksL3Network
27741 description: Response codes found in [response codes](https://wiki.onap.org/).
27745 description: Network ID, should be uuid. Unique across A&AI.
27748 example: __NETWORK-ID__
27751 description: l3-network object that needs to be created or updated.
27754 $ref: "#/patchDefinitions/l3-network"
27758 summary: delete an existing l3-network
27759 description: delete an existing l3-network
27760 operationId: deleteNetworkL3NetworksL3Network
27769 description: Response codes found in [response codes](https://wiki.onap.org/).
27773 description: Network ID, should be uuid. Unique across A&AI.
27776 example: __NETWORK-ID__
27777 - name: resource-version
27779 description: resource-version for concurrency
27782 /network/l3-networks:
27786 summary: returns l3-networks
27787 description: returns l3-networks
27788 operationId: getNetworkL3Networks
27794 description: successful operation
27796 $ref: "#/getDefinitions/l3-networks"
27798 description: Response codes found in [response codes](https://wiki.onap.org/).
27799 /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship:
27803 summary: see node definition for valid relationships
27804 operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
27813 description: Response codes found in [response codes](https://wiki.onap.org/).
27815 - name: network-policy-id
27817 description: UUID representing unique key to this instance
27820 example: __NETWORK-POLICY-ID__
27823 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNetworkPoliciesNetworkPolicy.json)
27826 $ref: "#/definitions/relationship"
27830 summary: delete an existing relationship
27831 description: delete an existing relationship
27832 operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
27841 description: Response codes found in [response codes](https://wiki.onap.org/).
27843 - name: network-policy-id
27845 description: UUID representing unique key to this instance
27848 example: __NETWORK-POLICY-ID__
27849 /network/network-policies/network-policy/{network-policy-id}:
27853 summary: returns network-policy
27854 description: returns network-policy
27855 operationId: getNetworkNetworkPoliciesNetworkPolicy
27861 description: successful operation
27863 $ref: "#/getDefinitions/network-policy"
27865 description: Response codes found in [response codes](https://wiki.onap.org/).
27867 - name: network-policy-id
27869 description: UUID representing unique key to this instance
27872 example: __NETWORK-POLICY-ID__
27873 - name: network-policy-fqdn
27875 description: Contrail FQDN for the policy
27881 summary: create or update an existing network-policy
27883 Create or update an existing network-policy.
27885 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27886 operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy
27895 description: Response codes found in [response codes](https://wiki.onap.org/).
27897 - name: network-policy-id
27899 description: UUID representing unique key to this instance
27902 example: __NETWORK-POLICY-ID__
27905 description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNetworkPoliciesNetworkPolicy.json)
27908 $ref: "#/definitions/network-policy"
27912 summary: update an existing network-policy
27914 Update an existing network-policy
27916 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27917 The PUT operation will entirely replace an existing object.
27918 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27920 Other differences between PUT and PATCH are:
27922 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27923 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27924 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27925 operationId: UpdateNetworkNetworkPoliciesNetworkPolicy
27934 description: Response codes found in [response codes](https://wiki.onap.org/).
27936 - name: network-policy-id
27938 description: UUID representing unique key to this instance
27941 example: __NETWORK-POLICY-ID__
27944 description: network-policy object that needs to be created or updated.
27947 $ref: "#/patchDefinitions/network-policy"
27951 summary: delete an existing network-policy
27952 description: delete an existing network-policy
27953 operationId: deleteNetworkNetworkPoliciesNetworkPolicy
27962 description: Response codes found in [response codes](https://wiki.onap.org/).
27964 - name: network-policy-id
27966 description: UUID representing unique key to this instance
27969 example: __NETWORK-POLICY-ID__
27970 - name: resource-version
27972 description: resource-version for concurrency
27975 /network/network-policies:
27979 summary: returns network-policies
27980 description: returns network-policies
27981 operationId: getNetworkNetworkPolicies
27987 description: successful operation
27989 $ref: "#/getDefinitions/network-policies"
27991 description: Response codes found in [response codes](https://wiki.onap.org/).
27992 /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship:
27996 summary: see node definition for valid relationships
27997 operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship
28006 description: Response codes found in [response codes](https://wiki.onap.org/).
28010 description: Unique id of VNF. This is unique across the graph.
28013 example: __VNF-ID__
28016 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnf.json)
28019 $ref: "#/definitions/relationship"
28023 summary: delete an existing relationship
28024 description: delete an existing relationship
28025 operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship
28034 description: Response codes found in [response codes](https://wiki.onap.org/).
28038 description: Unique id of VNF. This is unique across the graph.
28041 example: __VNF-ID__
28042 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
28046 summary: see node definition for valid relationships
28047 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
28056 description: Response codes found in [response codes](https://wiki.onap.org/).
28060 description: Unique id of VNF. This is unique across the graph.
28063 example: __VNF-ID__
28064 - name: interface-name
28066 description: Name given to the interface
28069 example: __INTERFACE-NAME__
28070 - name: vlan-interface
28072 description: String that identifies the interface
28075 example: __VLAN-INTERFACE__
28078 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
28081 $ref: "#/definitions/relationship"
28085 summary: delete an existing relationship
28086 description: delete an existing relationship
28087 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
28096 description: Response codes found in [response codes](https://wiki.onap.org/).
28100 description: Unique id of VNF. This is unique across the graph.
28103 example: __VNF-ID__
28104 - name: interface-name
28106 description: Name given to the interface
28109 example: __INTERFACE-NAME__
28110 - name: vlan-interface
28112 description: String that identifies the interface
28115 example: __VLAN-INTERFACE__
28116 /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:
28120 summary: see node definition for valid relationships
28121 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
28130 description: Response codes found in [response codes](https://wiki.onap.org/).
28134 description: Unique id of VNF. This is unique across the graph.
28137 example: __VNF-ID__
28138 - name: interface-name
28140 description: Name given to the interface
28143 example: __INTERFACE-NAME__
28144 - name: vlan-interface
28146 description: String that identifies the interface
28149 example: __VLAN-INTERFACE__
28150 - name: l3-interface-ipv4-address
28152 description: IP address
28155 example: __L3-INTERFACE-IPV4-ADDRESS__
28158 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
28161 $ref: "#/definitions/relationship"
28165 summary: delete an existing relationship
28166 description: delete an existing relationship
28167 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
28176 description: Response codes found in [response codes](https://wiki.onap.org/).
28180 description: Unique id of VNF. This is unique across the graph.
28183 example: __VNF-ID__
28184 - name: interface-name
28186 description: Name given to the interface
28189 example: __INTERFACE-NAME__
28190 - name: vlan-interface
28192 description: String that identifies the interface
28195 example: __VLAN-INTERFACE__
28196 - name: l3-interface-ipv4-address
28198 description: IP address
28201 example: __L3-INTERFACE-IPV4-ADDRESS__
28202 /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}:
28206 summary: returns l3-interface-ipv4-address-list
28207 description: returns l3-interface-ipv4-address-list
28208 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
28214 description: successful operation
28216 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
28218 description: Response codes found in [response codes](https://wiki.onap.org/).
28222 description: Unique id of VNF. This is unique across the graph.
28225 example: __VNF-ID__
28226 - name: interface-name
28228 description: Name given to the interface
28231 example: __INTERFACE-NAME__
28232 - name: vlan-interface
28234 description: String that identifies the interface
28237 example: __VLAN-INTERFACE__
28238 - name: l3-interface-ipv4-address
28240 description: IP address
28243 example: __L3-INTERFACE-IPV4-ADDRESS__
28246 description: Name of VNF.
28251 description: Alternate name of VNF.
28256 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
28261 description: Unique identifier of service from ASDC
28264 - name: regional-resource-zone
28266 description: Regional way of organizing pservers, source of truth should define values
28269 - name: prov-status
28271 description: Trigger for operational monitoring of this resource by Service Assurance systems.
28274 - name: heat-stack-id
28276 description: Heat stack id corresponding to this instance, managed by MSO
28283 - name: is-closed-loop-disabled
28287 - name: persona-model-id
28289 description: the ASDC model id for this resource or service model.
28292 - name: persona-model-version
28294 description: the ASDC model version for this resource or service model.
28297 - name: widget-model-id
28299 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
28302 - name: widget-model-version
28304 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
28307 - name: interface-id
28309 description: ID of interface
28314 description: MAC address for the interface
28317 - name: network-name
28319 description: Name of the network
28322 - name: vlan-id-inner
28324 description: Inner VLAN tag
28330 description: This indicates the customers VPN ID associated with this vlan
28333 - name: vlan-id-inner
28335 description: Inner VLAN tag
28339 - name: neutron-network-id
28341 description: Neutron network id of the interface that address belongs to
28344 - name: neutron-subnet-id
28346 description: Neutron id of subnet that address belongs to
28352 summary: create or update an existing l3-interface-ipv4-address-list
28354 Create or update an existing l3-interface-ipv4-address-list.
28356 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28357 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
28366 description: Response codes found in [response codes](https://wiki.onap.org/).
28370 description: Unique id of VNF. This is unique across the graph.
28373 example: __VNF-ID__
28374 - name: interface-name
28376 description: Name given to the interface
28379 example: __INTERFACE-NAME__
28380 - name: vlan-interface
28382 description: String that identifies the interface
28385 example: __VLAN-INTERFACE__
28386 - name: l3-interface-ipv4-address
28388 description: IP address
28391 example: __L3-INTERFACE-IPV4-ADDRESS__
28394 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
28397 $ref: "#/definitions/l3-interface-ipv4-address-list"
28401 summary: update an existing l3-interface-ipv4-address-list
28403 Update an existing l3-interface-ipv4-address-list
28405 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28406 The PUT operation will entirely replace an existing object.
28407 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28409 Other differences between PUT and PATCH are:
28411 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28412 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28413 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28414 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
28423 description: Response codes found in [response codes](https://wiki.onap.org/).
28427 description: Unique id of VNF. This is unique across the graph.
28430 example: __VNF-ID__
28431 - name: interface-name
28433 description: Name given to the interface
28436 example: __INTERFACE-NAME__
28437 - name: vlan-interface
28439 description: String that identifies the interface
28442 example: __VLAN-INTERFACE__
28443 - name: l3-interface-ipv4-address
28445 description: IP address
28448 example: __L3-INTERFACE-IPV4-ADDRESS__
28451 description: l3-interface-ipv4-address-list object that needs to be created or updated.
28454 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
28458 summary: delete an existing l3-interface-ipv4-address-list
28459 description: delete an existing l3-interface-ipv4-address-list
28460 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
28469 description: Response codes found in [response codes](https://wiki.onap.org/).
28473 description: Unique id of VNF. This is unique across the graph.
28476 example: __VNF-ID__
28477 - name: interface-name
28479 description: Name given to the interface
28482 example: __INTERFACE-NAME__
28483 - name: vlan-interface
28485 description: String that identifies the interface
28488 example: __VLAN-INTERFACE__
28489 - name: l3-interface-ipv4-address
28491 description: IP address
28494 example: __L3-INTERFACE-IPV4-ADDRESS__
28495 - name: resource-version
28497 description: resource-version for concurrency
28500 /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:
28504 summary: see node definition for valid relationships
28505 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
28514 description: Response codes found in [response codes](https://wiki.onap.org/).
28518 description: Unique id of VNF. This is unique across the graph.
28521 example: __VNF-ID__
28522 - name: interface-name
28524 description: Name given to the interface
28527 example: __INTERFACE-NAME__
28528 - name: vlan-interface
28530 description: String that identifies the interface
28533 example: __VLAN-INTERFACE__
28534 - name: l3-interface-ipv6-address
28536 description: IP address
28539 example: __L3-INTERFACE-IPV6-ADDRESS__
28542 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
28545 $ref: "#/definitions/relationship"
28549 summary: delete an existing relationship
28550 description: delete an existing relationship
28551 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
28560 description: Response codes found in [response codes](https://wiki.onap.org/).
28564 description: Unique id of VNF. This is unique across the graph.
28567 example: __VNF-ID__
28568 - name: interface-name
28570 description: Name given to the interface
28573 example: __INTERFACE-NAME__
28574 - name: vlan-interface
28576 description: String that identifies the interface
28579 example: __VLAN-INTERFACE__
28580 - name: l3-interface-ipv6-address
28582 description: IP address
28585 example: __L3-INTERFACE-IPV6-ADDRESS__
28586 /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}:
28590 summary: returns l3-interface-ipv6-address-list
28591 description: returns l3-interface-ipv6-address-list
28592 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
28598 description: successful operation
28600 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
28602 description: Response codes found in [response codes](https://wiki.onap.org/).
28606 description: Unique id of VNF. This is unique across the graph.
28609 example: __VNF-ID__
28610 - name: interface-name
28612 description: Name given to the interface
28615 example: __INTERFACE-NAME__
28616 - name: vlan-interface
28618 description: String that identifies the interface
28621 example: __VLAN-INTERFACE__
28622 - name: l3-interface-ipv6-address
28624 description: IP address
28627 example: __L3-INTERFACE-IPV6-ADDRESS__
28630 description: Name of VNF.
28635 description: Alternate name of VNF.
28640 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
28645 description: Unique identifier of service from ASDC
28648 - name: regional-resource-zone
28650 description: Regional way of organizing pservers, source of truth should define values
28653 - name: prov-status
28655 description: Trigger for operational monitoring of this resource by Service Assurance systems.
28658 - name: heat-stack-id
28660 description: Heat stack id corresponding to this instance, managed by MSO
28667 - name: is-closed-loop-disabled
28671 - name: persona-model-id
28673 description: the ASDC model id for this resource or service model.
28676 - name: persona-model-version
28678 description: the ASDC model version for this resource or service model.
28681 - name: widget-model-id
28683 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
28686 - name: widget-model-version
28688 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
28691 - name: interface-id
28693 description: ID of interface
28698 description: MAC address for the interface
28701 - name: network-name
28703 description: Name of the network
28706 - name: vlan-id-inner
28708 description: Inner VLAN tag
28714 description: This indicates the customers VPN ID associated with this vlan
28717 - name: vlan-id-inner
28719 description: Inner VLAN tag
28723 - name: neutron-network-id
28725 description: Neutron network id of the interface that address belongs to
28728 - name: neutron-subnet-id
28730 description: Neutron id of subnet that address belongs to
28736 summary: create or update an existing l3-interface-ipv6-address-list
28738 Create or update an existing l3-interface-ipv6-address-list.
28740 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28741 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
28750 description: Response codes found in [response codes](https://wiki.onap.org/).
28754 description: Unique id of VNF. This is unique across the graph.
28757 example: __VNF-ID__
28758 - name: interface-name
28760 description: Name given to the interface
28763 example: __INTERFACE-NAME__
28764 - name: vlan-interface
28766 description: String that identifies the interface
28769 example: __VLAN-INTERFACE__
28770 - name: l3-interface-ipv6-address
28772 description: IP address
28775 example: __L3-INTERFACE-IPV6-ADDRESS__
28778 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
28781 $ref: "#/definitions/l3-interface-ipv6-address-list"
28785 summary: update an existing l3-interface-ipv6-address-list
28787 Update an existing l3-interface-ipv6-address-list
28789 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28790 The PUT operation will entirely replace an existing object.
28791 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28793 Other differences between PUT and PATCH are:
28795 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28796 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28797 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28798 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
28807 description: Response codes found in [response codes](https://wiki.onap.org/).
28811 description: Unique id of VNF. This is unique across the graph.
28814 example: __VNF-ID__
28815 - name: interface-name
28817 description: Name given to the interface
28820 example: __INTERFACE-NAME__
28821 - name: vlan-interface
28823 description: String that identifies the interface
28826 example: __VLAN-INTERFACE__
28827 - name: l3-interface-ipv6-address
28829 description: IP address
28832 example: __L3-INTERFACE-IPV6-ADDRESS__
28835 description: l3-interface-ipv6-address-list object that needs to be created or updated.
28838 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
28842 summary: delete an existing l3-interface-ipv6-address-list
28843 description: delete an existing l3-interface-ipv6-address-list
28844 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
28853 description: Response codes found in [response codes](https://wiki.onap.org/).
28857 description: Unique id of VNF. This is unique across the graph.
28860 example: __VNF-ID__
28861 - name: interface-name
28863 description: Name given to the interface
28866 example: __INTERFACE-NAME__
28867 - name: vlan-interface
28869 description: String that identifies the interface
28872 example: __VLAN-INTERFACE__
28873 - name: l3-interface-ipv6-address
28875 description: IP address
28878 example: __L3-INTERFACE-IPV6-ADDRESS__
28879 - name: resource-version
28881 description: resource-version for concurrency
28884 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
28888 summary: returns vlan
28889 description: returns vlan
28890 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
28896 description: successful operation
28898 $ref: "#/getDefinitions/vlan"
28900 description: Response codes found in [response codes](https://wiki.onap.org/).
28904 description: Unique id of VNF. This is unique across the graph.
28907 example: __VNF-ID__
28908 - name: interface-name
28910 description: Name given to the interface
28913 example: __INTERFACE-NAME__
28914 - name: vlan-interface
28916 description: String that identifies the interface
28919 example: __VLAN-INTERFACE__
28922 description: Name of VNF.
28927 description: Alternate name of VNF.
28932 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
28937 description: Unique identifier of service from ASDC
28940 - name: regional-resource-zone
28942 description: Regional way of organizing pservers, source of truth should define values
28945 - name: prov-status
28947 description: Trigger for operational monitoring of this resource by Service Assurance systems.
28950 - name: heat-stack-id
28952 description: Heat stack id corresponding to this instance, managed by MSO
28959 - name: is-closed-loop-disabled
28963 - name: persona-model-id
28965 description: the ASDC model id for this resource or service model.
28968 - name: persona-model-version
28970 description: the ASDC model version for this resource or service model.
28973 - name: widget-model-id
28975 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
28978 - name: widget-model-version
28980 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
28983 - name: interface-id
28985 description: ID of interface
28990 description: MAC address for the interface
28993 - name: network-name
28995 description: Name of the network
28998 - name: vlan-id-inner
29000 description: Inner VLAN tag
29006 description: This indicates the customers VPN ID associated with this vlan
29012 summary: create or update an existing vlan
29014 Create or update an existing vlan.
29016 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29017 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
29026 description: Response codes found in [response codes](https://wiki.onap.org/).
29030 description: Unique id of VNF. This is unique across the graph.
29033 example: __VNF-ID__
29034 - name: interface-name
29036 description: Name given to the interface
29039 example: __INTERFACE-NAME__
29040 - name: vlan-interface
29042 description: String that identifies the interface
29045 example: __VLAN-INTERFACE__
29048 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
29051 $ref: "#/definitions/vlan"
29055 summary: update an existing vlan
29057 Update an existing vlan
29059 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29060 The PUT operation will entirely replace an existing object.
29061 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29063 Other differences between PUT and PATCH are:
29065 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29066 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29067 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29068 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
29077 description: Response codes found in [response codes](https://wiki.onap.org/).
29081 description: Unique id of VNF. This is unique across the graph.
29084 example: __VNF-ID__
29085 - name: interface-name
29087 description: Name given to the interface
29090 example: __INTERFACE-NAME__
29091 - name: vlan-interface
29093 description: String that identifies the interface
29096 example: __VLAN-INTERFACE__
29099 description: vlan object that needs to be created or updated.
29102 $ref: "#/patchDefinitions/vlan"
29106 summary: delete an existing vlan
29107 description: delete an existing vlan
29108 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
29117 description: Response codes found in [response codes](https://wiki.onap.org/).
29121 description: Unique id of VNF. This is unique across the graph.
29124 example: __VNF-ID__
29125 - name: interface-name
29127 description: Name given to the interface
29130 example: __INTERFACE-NAME__
29131 - name: vlan-interface
29133 description: String that identifies the interface
29136 example: __VLAN-INTERFACE__
29137 - name: resource-version
29139 description: resource-version for concurrency
29142 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans:
29146 summary: returns vlans
29147 description: returns vlans
29148 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans
29154 description: successful operation
29156 $ref: "#/getDefinitions/vlans"
29158 description: Response codes found in [response codes](https://wiki.onap.org/).
29162 description: Unique id of VNF. This is unique across the graph.
29165 example: __VNF-ID__
29166 - name: interface-name
29168 description: Name given to the interface
29171 example: __INTERFACE-NAME__
29174 description: Name of VNF.
29179 description: Alternate name of VNF.
29184 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
29189 description: Unique identifier of service from ASDC
29192 - name: regional-resource-zone
29194 description: Regional way of organizing pservers, source of truth should define values
29197 - name: prov-status
29199 description: Trigger for operational monitoring of this resource by Service Assurance systems.
29202 - name: heat-stack-id
29204 description: Heat stack id corresponding to this instance, managed by MSO
29211 - name: is-closed-loop-disabled
29215 - name: persona-model-id
29217 description: the ASDC model id for this resource or service model.
29220 - name: persona-model-version
29222 description: the ASDC model version for this resource or service model.
29225 - name: widget-model-id
29227 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
29230 - name: widget-model-version
29232 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
29235 - name: interface-id
29237 description: ID of interface
29242 description: MAC address for the interface
29245 - name: network-name
29247 description: Name of the network
29250 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
29254 summary: see node definition for valid relationships
29255 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
29264 description: Response codes found in [response codes](https://wiki.onap.org/).
29268 description: Unique id of VNF. This is unique across the graph.
29271 example: __VNF-ID__
29272 - name: interface-name
29274 description: Name given to the interface
29277 example: __INTERFACE-NAME__
29280 description: PCI ID used to identify the sriov-vf
29283 example: __PCI-ID__
29286 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
29289 $ref: "#/definitions/relationship"
29293 summary: delete an existing relationship
29294 description: delete an existing relationship
29295 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
29304 description: Response codes found in [response codes](https://wiki.onap.org/).
29308 description: Unique id of VNF. This is unique across the graph.
29311 example: __VNF-ID__
29312 - name: interface-name
29314 description: Name given to the interface
29317 example: __INTERFACE-NAME__
29320 description: PCI ID used to identify the sriov-vf
29323 example: __PCI-ID__
29324 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
29328 summary: returns sriov-vf
29329 description: returns sriov-vf
29330 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
29336 description: successful operation
29338 $ref: "#/getDefinitions/sriov-vf"
29340 description: Response codes found in [response codes](https://wiki.onap.org/).
29344 description: Unique id of VNF. This is unique across the graph.
29347 example: __VNF-ID__
29348 - name: interface-name
29350 description: Name given to the interface
29353 example: __INTERFACE-NAME__
29356 description: PCI ID used to identify the sriov-vf
29359 example: __PCI-ID__
29362 description: Name of VNF.
29367 description: Alternate name of VNF.
29372 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
29377 description: Unique identifier of service from ASDC
29380 - name: regional-resource-zone
29382 description: Regional way of organizing pservers, source of truth should define values
29385 - name: prov-status
29387 description: Trigger for operational monitoring of this resource by Service Assurance systems.
29390 - name: heat-stack-id
29392 description: Heat stack id corresponding to this instance, managed by MSO
29399 - name: is-closed-loop-disabled
29403 - name: persona-model-id
29405 description: the ASDC model id for this resource or service model.
29408 - name: persona-model-version
29410 description: the ASDC model version for this resource or service model.
29413 - name: widget-model-id
29415 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
29418 - name: widget-model-version
29420 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
29423 - name: interface-id
29425 description: ID of interface
29430 description: MAC address for the interface
29433 - name: network-name
29435 description: Name of the network
29438 - name: vf-vlan-filter
29440 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
29443 - name: vf-mac-filter
29445 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
29448 - name: vf-vlan-strip
29450 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
29453 - name: neutron-network-id
29455 description: Neutron network id of the interface
29461 summary: create or update an existing sriov-vf
29463 Create or update an existing sriov-vf.
29465 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29466 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
29475 description: Response codes found in [response codes](https://wiki.onap.org/).
29479 description: Unique id of VNF. This is unique across the graph.
29482 example: __VNF-ID__
29483 - name: interface-name
29485 description: Name given to the interface
29488 example: __INTERFACE-NAME__
29491 description: PCI ID used to identify the sriov-vf
29494 example: __PCI-ID__
29497 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
29500 $ref: "#/definitions/sriov-vf"
29504 summary: update an existing sriov-vf
29506 Update an existing sriov-vf
29508 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29509 The PUT operation will entirely replace an existing object.
29510 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29512 Other differences between PUT and PATCH are:
29514 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29515 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29516 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29517 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
29526 description: Response codes found in [response codes](https://wiki.onap.org/).
29530 description: Unique id of VNF. This is unique across the graph.
29533 example: __VNF-ID__
29534 - name: interface-name
29536 description: Name given to the interface
29539 example: __INTERFACE-NAME__
29542 description: PCI ID used to identify the sriov-vf
29545 example: __PCI-ID__
29548 description: sriov-vf object that needs to be created or updated.
29551 $ref: "#/patchDefinitions/sriov-vf"
29555 summary: delete an existing sriov-vf
29556 description: delete an existing sriov-vf
29557 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
29566 description: Response codes found in [response codes](https://wiki.onap.org/).
29570 description: Unique id of VNF. This is unique across the graph.
29573 example: __VNF-ID__
29574 - name: interface-name
29576 description: Name given to the interface
29579 example: __INTERFACE-NAME__
29582 description: PCI ID used to identify the sriov-vf
29585 example: __PCI-ID__
29586 - name: resource-version
29588 description: resource-version for concurrency
29591 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
29595 summary: returns sriov-vfs
29596 description: returns sriov-vfs
29597 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs
29603 description: successful operation
29605 $ref: "#/getDefinitions/sriov-vfs"
29607 description: Response codes found in [response codes](https://wiki.onap.org/).
29611 description: Unique id of VNF. This is unique across the graph.
29614 example: __VNF-ID__
29615 - name: interface-name
29617 description: Name given to the interface
29620 example: __INTERFACE-NAME__
29623 description: Name of VNF.
29628 description: Alternate name of VNF.
29633 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
29638 description: Unique identifier of service from ASDC
29641 - name: regional-resource-zone
29643 description: Regional way of organizing pservers, source of truth should define values
29646 - name: prov-status
29648 description: Trigger for operational monitoring of this resource by Service Assurance systems.
29651 - name: heat-stack-id
29653 description: Heat stack id corresponding to this instance, managed by MSO
29660 - name: is-closed-loop-disabled
29664 - name: persona-model-id
29666 description: the ASDC model id for this resource or service model.
29669 - name: persona-model-version
29671 description: the ASDC model version for this resource or service model.
29674 - name: widget-model-id
29676 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
29679 - name: widget-model-version
29681 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
29684 - name: interface-id
29686 description: ID of interface
29691 description: MAC address for the interface
29694 - name: network-name
29696 description: Name of the network
29699 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
29703 summary: see node definition for valid relationships
29704 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
29713 description: Response codes found in [response codes](https://wiki.onap.org/).
29717 description: Unique id of VNF. This is unique across the graph.
29720 example: __VNF-ID__
29721 - name: interface-name
29723 description: Name given to the interface
29726 example: __INTERFACE-NAME__
29729 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
29732 $ref: "#/definitions/relationship"
29736 summary: delete an existing relationship
29737 description: delete an existing relationship
29738 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
29747 description: Response codes found in [response codes](https://wiki.onap.org/).
29751 description: Unique id of VNF. This is unique across the graph.
29754 example: __VNF-ID__
29755 - name: interface-name
29757 description: Name given to the interface
29760 example: __INTERFACE-NAME__
29761 /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:
29765 summary: see node definition for valid relationships
29766 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
29775 description: Response codes found in [response codes](https://wiki.onap.org/).
29779 description: Unique id of VNF. This is unique across the graph.
29782 example: __VNF-ID__
29783 - name: interface-name
29785 description: Name given to the interface
29788 example: __INTERFACE-NAME__
29789 - name: l3-interface-ipv4-address
29791 description: IP address
29794 example: __L3-INTERFACE-IPV4-ADDRESS__
29797 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
29800 $ref: "#/definitions/relationship"
29804 summary: delete an existing relationship
29805 description: delete an existing relationship
29806 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
29815 description: Response codes found in [response codes](https://wiki.onap.org/).
29819 description: Unique id of VNF. This is unique across the graph.
29822 example: __VNF-ID__
29823 - name: interface-name
29825 description: Name given to the interface
29828 example: __INTERFACE-NAME__
29829 - name: l3-interface-ipv4-address
29831 description: IP address
29834 example: __L3-INTERFACE-IPV4-ADDRESS__
29835 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
29839 summary: returns l3-interface-ipv4-address-list
29840 description: returns l3-interface-ipv4-address-list
29841 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
29847 description: successful operation
29849 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
29851 description: Response codes found in [response codes](https://wiki.onap.org/).
29855 description: Unique id of VNF. This is unique across the graph.
29858 example: __VNF-ID__
29859 - name: interface-name
29861 description: Name given to the interface
29864 example: __INTERFACE-NAME__
29865 - name: l3-interface-ipv4-address
29867 description: IP address
29870 example: __L3-INTERFACE-IPV4-ADDRESS__
29873 description: Name of VNF.
29878 description: Alternate name of VNF.
29883 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
29888 description: Unique identifier of service from ASDC
29891 - name: regional-resource-zone
29893 description: Regional way of organizing pservers, source of truth should define values
29896 - name: prov-status
29898 description: Trigger for operational monitoring of this resource by Service Assurance systems.
29901 - name: heat-stack-id
29903 description: Heat stack id corresponding to this instance, managed by MSO
29910 - name: is-closed-loop-disabled
29914 - name: persona-model-id
29916 description: the ASDC model id for this resource or service model.
29919 - name: persona-model-version
29921 description: the ASDC model version for this resource or service model.
29924 - name: widget-model-id
29926 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
29929 - name: widget-model-version
29931 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
29934 - name: interface-id
29936 description: ID of interface
29941 description: MAC address for the interface
29944 - name: network-name
29946 description: Name of the network
29949 - name: vlan-id-inner
29951 description: Inner VLAN tag
29955 - name: neutron-network-id
29957 description: Neutron network id of the interface that address belongs to
29960 - name: neutron-subnet-id
29962 description: Neutron id of subnet that address belongs to
29968 summary: create or update an existing l3-interface-ipv4-address-list
29970 Create or update an existing l3-interface-ipv4-address-list.
29972 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29973 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
29982 description: Response codes found in [response codes](https://wiki.onap.org/).
29986 description: Unique id of VNF. This is unique across the graph.
29989 example: __VNF-ID__
29990 - name: interface-name
29992 description: Name given to the interface
29995 example: __INTERFACE-NAME__
29996 - name: l3-interface-ipv4-address
29998 description: IP address
30001 example: __L3-INTERFACE-IPV4-ADDRESS__
30004 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
30007 $ref: "#/definitions/l3-interface-ipv4-address-list"
30011 summary: update an existing l3-interface-ipv4-address-list
30013 Update an existing l3-interface-ipv4-address-list
30015 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30016 The PUT operation will entirely replace an existing object.
30017 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30019 Other differences between PUT and PATCH are:
30021 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30022 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30023 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30024 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
30033 description: Response codes found in [response codes](https://wiki.onap.org/).
30037 description: Unique id of VNF. This is unique across the graph.
30040 example: __VNF-ID__
30041 - name: interface-name
30043 description: Name given to the interface
30046 example: __INTERFACE-NAME__
30047 - name: l3-interface-ipv4-address
30049 description: IP address
30052 example: __L3-INTERFACE-IPV4-ADDRESS__
30055 description: l3-interface-ipv4-address-list object that needs to be created or updated.
30058 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
30062 summary: delete an existing l3-interface-ipv4-address-list
30063 description: delete an existing l3-interface-ipv4-address-list
30064 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
30073 description: Response codes found in [response codes](https://wiki.onap.org/).
30077 description: Unique id of VNF. This is unique across the graph.
30080 example: __VNF-ID__
30081 - name: interface-name
30083 description: Name given to the interface
30086 example: __INTERFACE-NAME__
30087 - name: l3-interface-ipv4-address
30089 description: IP address
30092 example: __L3-INTERFACE-IPV4-ADDRESS__
30093 - name: resource-version
30095 description: resource-version for concurrency
30098 /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:
30102 summary: see node definition for valid relationships
30103 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
30112 description: Response codes found in [response codes](https://wiki.onap.org/).
30116 description: Unique id of VNF. This is unique across the graph.
30119 example: __VNF-ID__
30120 - name: interface-name
30122 description: Name given to the interface
30125 example: __INTERFACE-NAME__
30126 - name: l3-interface-ipv6-address
30128 description: IP address
30131 example: __L3-INTERFACE-IPV6-ADDRESS__
30134 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
30137 $ref: "#/definitions/relationship"
30141 summary: delete an existing relationship
30142 description: delete an existing relationship
30143 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
30152 description: Response codes found in [response codes](https://wiki.onap.org/).
30156 description: Unique id of VNF. This is unique across the graph.
30159 example: __VNF-ID__
30160 - name: interface-name
30162 description: Name given to the interface
30165 example: __INTERFACE-NAME__
30166 - name: l3-interface-ipv6-address
30168 description: IP address
30171 example: __L3-INTERFACE-IPV6-ADDRESS__
30172 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
30176 summary: returns l3-interface-ipv6-address-list
30177 description: returns l3-interface-ipv6-address-list
30178 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
30184 description: successful operation
30186 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
30188 description: Response codes found in [response codes](https://wiki.onap.org/).
30192 description: Unique id of VNF. This is unique across the graph.
30195 example: __VNF-ID__
30196 - name: interface-name
30198 description: Name given to the interface
30201 example: __INTERFACE-NAME__
30202 - name: l3-interface-ipv6-address
30204 description: IP address
30207 example: __L3-INTERFACE-IPV6-ADDRESS__
30210 description: Name of VNF.
30215 description: Alternate name of VNF.
30220 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
30225 description: Unique identifier of service from ASDC
30228 - name: regional-resource-zone
30230 description: Regional way of organizing pservers, source of truth should define values
30233 - name: prov-status
30235 description: Trigger for operational monitoring of this resource by Service Assurance systems.
30238 - name: heat-stack-id
30240 description: Heat stack id corresponding to this instance, managed by MSO
30247 - name: is-closed-loop-disabled
30251 - name: persona-model-id
30253 description: the ASDC model id for this resource or service model.
30256 - name: persona-model-version
30258 description: the ASDC model version for this resource or service model.
30261 - name: widget-model-id
30263 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
30266 - name: widget-model-version
30268 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
30271 - name: interface-id
30273 description: ID of interface
30278 description: MAC address for the interface
30281 - name: network-name
30283 description: Name of the network
30286 - name: vlan-id-inner
30288 description: Inner VLAN tag
30292 - name: neutron-network-id
30294 description: Neutron network id of the interface that address belongs to
30297 - name: neutron-subnet-id
30299 description: Neutron id of subnet that address belongs to
30305 summary: create or update an existing l3-interface-ipv6-address-list
30307 Create or update an existing l3-interface-ipv6-address-list.
30309 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30310 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
30319 description: Response codes found in [response codes](https://wiki.onap.org/).
30323 description: Unique id of VNF. This is unique across the graph.
30326 example: __VNF-ID__
30327 - name: interface-name
30329 description: Name given to the interface
30332 example: __INTERFACE-NAME__
30333 - name: l3-interface-ipv6-address
30335 description: IP address
30338 example: __L3-INTERFACE-IPV6-ADDRESS__
30341 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
30344 $ref: "#/definitions/l3-interface-ipv6-address-list"
30348 summary: update an existing l3-interface-ipv6-address-list
30350 Update an existing l3-interface-ipv6-address-list
30352 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30353 The PUT operation will entirely replace an existing object.
30354 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30356 Other differences between PUT and PATCH are:
30358 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30359 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30360 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30361 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
30370 description: Response codes found in [response codes](https://wiki.onap.org/).
30374 description: Unique id of VNF. This is unique across the graph.
30377 example: __VNF-ID__
30378 - name: interface-name
30380 description: Name given to the interface
30383 example: __INTERFACE-NAME__
30384 - name: l3-interface-ipv6-address
30386 description: IP address
30389 example: __L3-INTERFACE-IPV6-ADDRESS__
30392 description: l3-interface-ipv6-address-list object that needs to be created or updated.
30395 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
30399 summary: delete an existing l3-interface-ipv6-address-list
30400 description: delete an existing l3-interface-ipv6-address-list
30401 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
30410 description: Response codes found in [response codes](https://wiki.onap.org/).
30414 description: Unique id of VNF. This is unique across the graph.
30417 example: __VNF-ID__
30418 - name: interface-name
30420 description: Name given to the interface
30423 example: __INTERFACE-NAME__
30424 - name: l3-interface-ipv6-address
30426 description: IP address
30429 example: __L3-INTERFACE-IPV6-ADDRESS__
30430 - name: resource-version
30432 description: resource-version for concurrency
30435 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}:
30439 summary: returns l-interface
30440 description: returns l-interface
30441 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface
30447 description: successful operation
30449 $ref: "#/getDefinitions/l-interface"
30451 description: Response codes found in [response codes](https://wiki.onap.org/).
30455 description: Unique id of VNF. This is unique across the graph.
30458 example: __VNF-ID__
30459 - name: interface-name
30461 description: Name given to the interface
30464 example: __INTERFACE-NAME__
30467 description: Name of VNF.
30472 description: Alternate name of VNF.
30477 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
30482 description: Unique identifier of service from ASDC
30485 - name: regional-resource-zone
30487 description: Regional way of organizing pservers, source of truth should define values
30490 - name: prov-status
30492 description: Trigger for operational monitoring of this resource by Service Assurance systems.
30495 - name: heat-stack-id
30497 description: Heat stack id corresponding to this instance, managed by MSO
30504 - name: is-closed-loop-disabled
30508 - name: persona-model-id
30510 description: the ASDC model id for this resource or service model.
30513 - name: persona-model-version
30515 description: the ASDC model version for this resource or service model.
30518 - name: widget-model-id
30520 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
30523 - name: widget-model-version
30525 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
30528 - name: interface-id
30530 description: ID of interface
30535 description: MAC address for the interface
30538 - name: network-name
30540 description: Name of the network
30546 summary: create or update an existing l-interface
30548 Create or update an existing l-interface.
30550 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30551 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
30560 description: Response codes found in [response codes](https://wiki.onap.org/).
30564 description: Unique id of VNF. This is unique across the graph.
30567 example: __VNF-ID__
30568 - name: interface-name
30570 description: Name given to the interface
30573 example: __INTERFACE-NAME__
30576 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
30579 $ref: "#/definitions/l-interface"
30583 summary: update an existing l-interface
30585 Update an existing l-interface
30587 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30588 The PUT operation will entirely replace an existing object.
30589 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30591 Other differences between PUT and PATCH are:
30593 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30594 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30595 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30596 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
30605 description: Response codes found in [response codes](https://wiki.onap.org/).
30609 description: Unique id of VNF. This is unique across the graph.
30612 example: __VNF-ID__
30613 - name: interface-name
30615 description: Name given to the interface
30618 example: __INTERFACE-NAME__
30621 description: l-interface object that needs to be created or updated.
30624 $ref: "#/patchDefinitions/l-interface"
30628 summary: delete an existing l-interface
30629 description: delete an existing l-interface
30630 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface
30639 description: Response codes found in [response codes](https://wiki.onap.org/).
30643 description: Unique id of VNF. This is unique across the graph.
30646 example: __VNF-ID__
30647 - name: interface-name
30649 description: Name given to the interface
30652 example: __INTERFACE-NAME__
30653 - name: resource-version
30655 description: resource-version for concurrency
30658 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces:
30662 summary: returns l-interfaces
30663 description: returns l-interfaces
30664 operationId: getNetworkGenericVnfsGenericVnfLInterfaces
30670 description: successful operation
30672 $ref: "#/getDefinitions/l-interfaces"
30674 description: Response codes found in [response codes](https://wiki.onap.org/).
30678 description: Unique id of VNF. This is unique across the graph.
30681 example: __VNF-ID__
30684 description: Name of VNF.
30689 description: Alternate name of VNF.
30694 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
30699 description: Unique identifier of service from ASDC
30702 - name: regional-resource-zone
30704 description: Regional way of organizing pservers, source of truth should define values
30707 - name: prov-status
30709 description: Trigger for operational monitoring of this resource by Service Assurance systems.
30712 - name: heat-stack-id
30714 description: Heat stack id corresponding to this instance, managed by MSO
30721 - name: is-closed-loop-disabled
30725 - name: persona-model-id
30727 description: the ASDC model id for this resource or service model.
30730 - name: persona-model-version
30732 description: the ASDC model version for this resource or service model.
30735 - name: widget-model-id
30737 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
30740 - name: widget-model-version
30742 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
30745 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
30749 summary: see node definition for valid relationships
30750 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
30759 description: Response codes found in [response codes](https://wiki.onap.org/).
30763 description: Unique id of VNF. This is unique across the graph.
30766 example: __VNF-ID__
30767 - name: interface-name
30769 description: Name that identifies the link aggregate interface
30772 example: __INTERFACE-NAME__
30775 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
30778 $ref: "#/definitions/relationship"
30782 summary: delete an existing relationship
30783 description: delete an existing relationship
30784 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
30793 description: Response codes found in [response codes](https://wiki.onap.org/).
30797 description: Unique id of VNF. This is unique across the graph.
30800 example: __VNF-ID__
30801 - name: interface-name
30803 description: Name that identifies the link aggregate interface
30806 example: __INTERFACE-NAME__
30807 /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:
30811 summary: see node definition for valid relationships
30812 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
30821 description: Response codes found in [response codes](https://wiki.onap.org/).
30825 description: Unique id of VNF. This is unique across the graph.
30828 example: __VNF-ID__
30829 - name: interface-name
30831 description: Name that identifies the link aggregate interface
30834 example: __INTERFACE-NAME__
30835 - name: interface-name
30837 description: Name given to the interface
30840 example: __INTERFACE-NAME__
30841 - name: vlan-interface
30843 description: String that identifies the interface
30846 example: __VLAN-INTERFACE__
30849 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
30852 $ref: "#/definitions/relationship"
30856 summary: delete an existing relationship
30857 description: delete an existing relationship
30858 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
30867 description: Response codes found in [response codes](https://wiki.onap.org/).
30871 description: Unique id of VNF. This is unique across the graph.
30874 example: __VNF-ID__
30875 - name: interface-name
30877 description: Name that identifies the link aggregate interface
30880 example: __INTERFACE-NAME__
30881 - name: interface-name
30883 description: Name given to the interface
30886 example: __INTERFACE-NAME__
30887 - name: vlan-interface
30889 description: String that identifies the interface
30892 example: __VLAN-INTERFACE__
30893 /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:
30897 summary: see node definition for valid relationships
30898 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
30907 description: Response codes found in [response codes](https://wiki.onap.org/).
30911 description: Unique id of VNF. This is unique across the graph.
30914 example: __VNF-ID__
30915 - name: interface-name
30917 description: Name that identifies the link aggregate interface
30920 example: __INTERFACE-NAME__
30921 - name: interface-name
30923 description: Name given to the interface
30926 example: __INTERFACE-NAME__
30927 - name: vlan-interface
30929 description: String that identifies the interface
30932 example: __VLAN-INTERFACE__
30933 - name: l3-interface-ipv4-address
30935 description: IP address
30938 example: __L3-INTERFACE-IPV4-ADDRESS__
30941 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
30944 $ref: "#/definitions/relationship"
30948 summary: delete an existing relationship
30949 description: delete an existing relationship
30950 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
30959 description: Response codes found in [response codes](https://wiki.onap.org/).
30963 description: Unique id of VNF. This is unique across the graph.
30966 example: __VNF-ID__
30967 - name: interface-name
30969 description: Name that identifies the link aggregate interface
30972 example: __INTERFACE-NAME__
30973 - name: interface-name
30975 description: Name given to the interface
30978 example: __INTERFACE-NAME__
30979 - name: vlan-interface
30981 description: String that identifies the interface
30984 example: __VLAN-INTERFACE__
30985 - name: l3-interface-ipv4-address
30987 description: IP address
30990 example: __L3-INTERFACE-IPV4-ADDRESS__
30991 /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}:
30995 summary: returns l3-interface-ipv4-address-list
30996 description: returns l3-interface-ipv4-address-list
30997 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31003 description: successful operation
31005 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
31007 description: Response codes found in [response codes](https://wiki.onap.org/).
31011 description: Unique id of VNF. This is unique across the graph.
31014 example: __VNF-ID__
31015 - name: interface-name
31017 description: Name that identifies the link aggregate interface
31020 example: __INTERFACE-NAME__
31021 - name: interface-name
31023 description: Name given to the interface
31026 example: __INTERFACE-NAME__
31027 - name: vlan-interface
31029 description: String that identifies the interface
31032 example: __VLAN-INTERFACE__
31033 - name: l3-interface-ipv4-address
31035 description: IP address
31038 example: __L3-INTERFACE-IPV4-ADDRESS__
31041 description: Name of VNF.
31046 description: Alternate name of VNF.
31051 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
31056 description: Unique identifier of service from ASDC
31059 - name: regional-resource-zone
31061 description: Regional way of organizing pservers, source of truth should define values
31064 - name: prov-status
31066 description: Trigger for operational monitoring of this resource by Service Assurance systems.
31069 - name: heat-stack-id
31071 description: Heat stack id corresponding to this instance, managed by MSO
31078 - name: is-closed-loop-disabled
31082 - name: persona-model-id
31084 description: the ASDC model id for this resource or service model.
31087 - name: persona-model-version
31089 description: the ASDC model version for this resource or service model.
31092 - name: widget-model-id
31094 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
31097 - name: widget-model-version
31099 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
31102 - name: interface-id
31104 description: ID of interface
31109 description: MAC address for the interface
31112 - name: network-name
31114 description: Name of the network
31117 - name: vlan-id-inner
31119 description: Inner VLAN tag
31125 description: This indicates the customers VPN ID associated with this vlan
31128 - name: vlan-id-inner
31130 description: Inner VLAN tag
31134 - name: neutron-network-id
31136 description: Neutron network id of the interface that address belongs to
31139 - name: neutron-subnet-id
31141 description: Neutron id of subnet that address belongs to
31147 summary: create or update an existing l3-interface-ipv4-address-list
31149 Create or update an existing l3-interface-ipv4-address-list.
31151 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31152 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31161 description: Response codes found in [response codes](https://wiki.onap.org/).
31165 description: Unique id of VNF. This is unique across the graph.
31168 example: __VNF-ID__
31169 - name: interface-name
31171 description: Name that identifies the link aggregate interface
31174 example: __INTERFACE-NAME__
31175 - name: interface-name
31177 description: Name given to the interface
31180 example: __INTERFACE-NAME__
31181 - name: vlan-interface
31183 description: String that identifies the interface
31186 example: __VLAN-INTERFACE__
31187 - name: l3-interface-ipv4-address
31189 description: IP address
31192 example: __L3-INTERFACE-IPV4-ADDRESS__
31195 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
31198 $ref: "#/definitions/l3-interface-ipv4-address-list"
31202 summary: update an existing l3-interface-ipv4-address-list
31204 Update an existing l3-interface-ipv4-address-list
31206 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31207 The PUT operation will entirely replace an existing object.
31208 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31210 Other differences between PUT and PATCH are:
31212 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31213 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31214 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31215 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31224 description: Response codes found in [response codes](https://wiki.onap.org/).
31228 description: Unique id of VNF. This is unique across the graph.
31231 example: __VNF-ID__
31232 - name: interface-name
31234 description: Name that identifies the link aggregate interface
31237 example: __INTERFACE-NAME__
31238 - name: interface-name
31240 description: Name given to the interface
31243 example: __INTERFACE-NAME__
31244 - name: vlan-interface
31246 description: String that identifies the interface
31249 example: __VLAN-INTERFACE__
31250 - name: l3-interface-ipv4-address
31252 description: IP address
31255 example: __L3-INTERFACE-IPV4-ADDRESS__
31258 description: l3-interface-ipv4-address-list object that needs to be created or updated.
31261 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
31265 summary: delete an existing l3-interface-ipv4-address-list
31266 description: delete an existing l3-interface-ipv4-address-list
31267 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31276 description: Response codes found in [response codes](https://wiki.onap.org/).
31280 description: Unique id of VNF. This is unique across the graph.
31283 example: __VNF-ID__
31284 - name: interface-name
31286 description: Name that identifies the link aggregate interface
31289 example: __INTERFACE-NAME__
31290 - name: interface-name
31292 description: Name given to the interface
31295 example: __INTERFACE-NAME__
31296 - name: vlan-interface
31298 description: String that identifies the interface
31301 example: __VLAN-INTERFACE__
31302 - name: l3-interface-ipv4-address
31304 description: IP address
31307 example: __L3-INTERFACE-IPV4-ADDRESS__
31308 - name: resource-version
31310 description: resource-version for concurrency
31313 /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:
31317 summary: see node definition for valid relationships
31318 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
31327 description: Response codes found in [response codes](https://wiki.onap.org/).
31331 description: Unique id of VNF. This is unique across the graph.
31334 example: __VNF-ID__
31335 - name: interface-name
31337 description: Name that identifies the link aggregate interface
31340 example: __INTERFACE-NAME__
31341 - name: interface-name
31343 description: Name given to the interface
31346 example: __INTERFACE-NAME__
31347 - name: vlan-interface
31349 description: String that identifies the interface
31352 example: __VLAN-INTERFACE__
31353 - name: l3-interface-ipv6-address
31355 description: IP address
31358 example: __L3-INTERFACE-IPV6-ADDRESS__
31361 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
31364 $ref: "#/definitions/relationship"
31368 summary: delete an existing relationship
31369 description: delete an existing relationship
31370 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
31379 description: Response codes found in [response codes](https://wiki.onap.org/).
31383 description: Unique id of VNF. This is unique across the graph.
31386 example: __VNF-ID__
31387 - name: interface-name
31389 description: Name that identifies the link aggregate interface
31392 example: __INTERFACE-NAME__
31393 - name: interface-name
31395 description: Name given to the interface
31398 example: __INTERFACE-NAME__
31399 - name: vlan-interface
31401 description: String that identifies the interface
31404 example: __VLAN-INTERFACE__
31405 - name: l3-interface-ipv6-address
31407 description: IP address
31410 example: __L3-INTERFACE-IPV6-ADDRESS__
31411 /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}:
31415 summary: returns l3-interface-ipv6-address-list
31416 description: returns l3-interface-ipv6-address-list
31417 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31423 description: successful operation
31425 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
31427 description: Response codes found in [response codes](https://wiki.onap.org/).
31431 description: Unique id of VNF. This is unique across the graph.
31434 example: __VNF-ID__
31435 - name: interface-name
31437 description: Name that identifies the link aggregate interface
31440 example: __INTERFACE-NAME__
31441 - name: interface-name
31443 description: Name given to the interface
31446 example: __INTERFACE-NAME__
31447 - name: vlan-interface
31449 description: String that identifies the interface
31452 example: __VLAN-INTERFACE__
31453 - name: l3-interface-ipv6-address
31455 description: IP address
31458 example: __L3-INTERFACE-IPV6-ADDRESS__
31461 description: Name of VNF.
31466 description: Alternate name of VNF.
31471 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
31476 description: Unique identifier of service from ASDC
31479 - name: regional-resource-zone
31481 description: Regional way of organizing pservers, source of truth should define values
31484 - name: prov-status
31486 description: Trigger for operational monitoring of this resource by Service Assurance systems.
31489 - name: heat-stack-id
31491 description: Heat stack id corresponding to this instance, managed by MSO
31498 - name: is-closed-loop-disabled
31502 - name: persona-model-id
31504 description: the ASDC model id for this resource or service model.
31507 - name: persona-model-version
31509 description: the ASDC model version for this resource or service model.
31512 - name: widget-model-id
31514 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
31517 - name: widget-model-version
31519 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
31522 - name: interface-id
31524 description: ID of interface
31529 description: MAC address for the interface
31532 - name: network-name
31534 description: Name of the network
31537 - name: vlan-id-inner
31539 description: Inner VLAN tag
31545 description: This indicates the customers VPN ID associated with this vlan
31548 - name: vlan-id-inner
31550 description: Inner VLAN tag
31554 - name: neutron-network-id
31556 description: Neutron network id of the interface that address belongs to
31559 - name: neutron-subnet-id
31561 description: Neutron id of subnet that address belongs to
31567 summary: create or update an existing l3-interface-ipv6-address-list
31569 Create or update an existing l3-interface-ipv6-address-list.
31571 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31572 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31581 description: Response codes found in [response codes](https://wiki.onap.org/).
31585 description: Unique id of VNF. This is unique across the graph.
31588 example: __VNF-ID__
31589 - name: interface-name
31591 description: Name that identifies the link aggregate interface
31594 example: __INTERFACE-NAME__
31595 - name: interface-name
31597 description: Name given to the interface
31600 example: __INTERFACE-NAME__
31601 - name: vlan-interface
31603 description: String that identifies the interface
31606 example: __VLAN-INTERFACE__
31607 - name: l3-interface-ipv6-address
31609 description: IP address
31612 example: __L3-INTERFACE-IPV6-ADDRESS__
31615 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
31618 $ref: "#/definitions/l3-interface-ipv6-address-list"
31622 summary: update an existing l3-interface-ipv6-address-list
31624 Update an existing l3-interface-ipv6-address-list
31626 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31627 The PUT operation will entirely replace an existing object.
31628 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31630 Other differences between PUT and PATCH are:
31632 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31633 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31634 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31635 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31644 description: Response codes found in [response codes](https://wiki.onap.org/).
31648 description: Unique id of VNF. This is unique across the graph.
31651 example: __VNF-ID__
31652 - name: interface-name
31654 description: Name that identifies the link aggregate interface
31657 example: __INTERFACE-NAME__
31658 - name: interface-name
31660 description: Name given to the interface
31663 example: __INTERFACE-NAME__
31664 - name: vlan-interface
31666 description: String that identifies the interface
31669 example: __VLAN-INTERFACE__
31670 - name: l3-interface-ipv6-address
31672 description: IP address
31675 example: __L3-INTERFACE-IPV6-ADDRESS__
31678 description: l3-interface-ipv6-address-list object that needs to be created or updated.
31681 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
31685 summary: delete an existing l3-interface-ipv6-address-list
31686 description: delete an existing l3-interface-ipv6-address-list
31687 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31696 description: Response codes found in [response codes](https://wiki.onap.org/).
31700 description: Unique id of VNF. This is unique across the graph.
31703 example: __VNF-ID__
31704 - name: interface-name
31706 description: Name that identifies the link aggregate interface
31709 example: __INTERFACE-NAME__
31710 - name: interface-name
31712 description: Name given to the interface
31715 example: __INTERFACE-NAME__
31716 - name: vlan-interface
31718 description: String that identifies the interface
31721 example: __VLAN-INTERFACE__
31722 - name: l3-interface-ipv6-address
31724 description: IP address
31727 example: __L3-INTERFACE-IPV6-ADDRESS__
31728 - name: resource-version
31730 description: resource-version for concurrency
31733 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
31737 summary: returns vlan
31738 description: returns vlan
31739 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
31745 description: successful operation
31747 $ref: "#/getDefinitions/vlan"
31749 description: Response codes found in [response codes](https://wiki.onap.org/).
31753 description: Unique id of VNF. This is unique across the graph.
31756 example: __VNF-ID__
31757 - name: interface-name
31759 description: Name that identifies the link aggregate interface
31762 example: __INTERFACE-NAME__
31763 - name: interface-name
31765 description: Name given to the interface
31768 example: __INTERFACE-NAME__
31769 - name: vlan-interface
31771 description: String that identifies the interface
31774 example: __VLAN-INTERFACE__
31777 description: Name of VNF.
31782 description: Alternate name of VNF.
31787 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
31792 description: Unique identifier of service from ASDC
31795 - name: regional-resource-zone
31797 description: Regional way of organizing pservers, source of truth should define values
31800 - name: prov-status
31802 description: Trigger for operational monitoring of this resource by Service Assurance systems.
31805 - name: heat-stack-id
31807 description: Heat stack id corresponding to this instance, managed by MSO
31814 - name: is-closed-loop-disabled
31818 - name: persona-model-id
31820 description: the ASDC model id for this resource or service model.
31823 - name: persona-model-version
31825 description: the ASDC model version for this resource or service model.
31828 - name: widget-model-id
31830 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
31833 - name: widget-model-version
31835 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
31838 - name: interface-id
31840 description: ID of interface
31845 description: MAC address for the interface
31848 - name: network-name
31850 description: Name of the network
31853 - name: vlan-id-inner
31855 description: Inner VLAN tag
31861 description: This indicates the customers VPN ID associated with this vlan
31867 summary: create or update an existing vlan
31869 Create or update an existing vlan.
31871 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31872 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
31881 description: Response codes found in [response codes](https://wiki.onap.org/).
31885 description: Unique id of VNF. This is unique across the graph.
31888 example: __VNF-ID__
31889 - name: interface-name
31891 description: Name that identifies the link aggregate interface
31894 example: __INTERFACE-NAME__
31895 - name: interface-name
31897 description: Name given to the interface
31900 example: __INTERFACE-NAME__
31901 - name: vlan-interface
31903 description: String that identifies the interface
31906 example: __VLAN-INTERFACE__
31909 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
31912 $ref: "#/definitions/vlan"
31916 summary: update an existing vlan
31918 Update an existing vlan
31920 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31921 The PUT operation will entirely replace an existing object.
31922 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31924 Other differences between PUT and PATCH are:
31926 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31927 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31928 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31929 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
31938 description: Response codes found in [response codes](https://wiki.onap.org/).
31942 description: Unique id of VNF. This is unique across the graph.
31945 example: __VNF-ID__
31946 - name: interface-name
31948 description: Name that identifies the link aggregate interface
31951 example: __INTERFACE-NAME__
31952 - name: interface-name
31954 description: Name given to the interface
31957 example: __INTERFACE-NAME__
31958 - name: vlan-interface
31960 description: String that identifies the interface
31963 example: __VLAN-INTERFACE__
31966 description: vlan object that needs to be created or updated.
31969 $ref: "#/patchDefinitions/vlan"
31973 summary: delete an existing vlan
31974 description: delete an existing vlan
31975 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
31984 description: Response codes found in [response codes](https://wiki.onap.org/).
31988 description: Unique id of VNF. This is unique across the graph.
31991 example: __VNF-ID__
31992 - name: interface-name
31994 description: Name that identifies the link aggregate interface
31997 example: __INTERFACE-NAME__
31998 - name: interface-name
32000 description: Name given to the interface
32003 example: __INTERFACE-NAME__
32004 - name: vlan-interface
32006 description: String that identifies the interface
32009 example: __VLAN-INTERFACE__
32010 - name: resource-version
32012 description: resource-version for concurrency
32015 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
32019 summary: returns vlans
32020 description: returns vlans
32021 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
32027 description: successful operation
32029 $ref: "#/getDefinitions/vlans"
32031 description: Response codes found in [response codes](https://wiki.onap.org/).
32035 description: Unique id of VNF. This is unique across the graph.
32038 example: __VNF-ID__
32039 - name: interface-name
32041 description: Name that identifies the link aggregate interface
32044 example: __INTERFACE-NAME__
32045 - name: interface-name
32047 description: Name given to the interface
32050 example: __INTERFACE-NAME__
32053 description: Name of VNF.
32058 description: Alternate name of VNF.
32063 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
32068 description: Unique identifier of service from ASDC
32071 - name: regional-resource-zone
32073 description: Regional way of organizing pservers, source of truth should define values
32076 - name: prov-status
32078 description: Trigger for operational monitoring of this resource by Service Assurance systems.
32081 - name: heat-stack-id
32083 description: Heat stack id corresponding to this instance, managed by MSO
32090 - name: is-closed-loop-disabled
32094 - name: persona-model-id
32096 description: the ASDC model id for this resource or service model.
32099 - name: persona-model-version
32101 description: the ASDC model version for this resource or service model.
32104 - name: widget-model-id
32106 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32109 - name: widget-model-version
32111 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32114 - name: interface-id
32116 description: ID of interface
32121 description: MAC address for the interface
32124 - name: network-name
32126 description: Name of the network
32129 /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:
32133 summary: see node definition for valid relationships
32134 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
32143 description: Response codes found in [response codes](https://wiki.onap.org/).
32147 description: Unique id of VNF. This is unique across the graph.
32150 example: __VNF-ID__
32151 - name: interface-name
32153 description: Name that identifies the link aggregate interface
32156 example: __INTERFACE-NAME__
32157 - name: interface-name
32159 description: Name given to the interface
32162 example: __INTERFACE-NAME__
32165 description: PCI ID used to identify the sriov-vf
32168 example: __PCI-ID__
32171 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
32174 $ref: "#/definitions/relationship"
32178 summary: delete an existing relationship
32179 description: delete an existing relationship
32180 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
32189 description: Response codes found in [response codes](https://wiki.onap.org/).
32193 description: Unique id of VNF. This is unique across the graph.
32196 example: __VNF-ID__
32197 - name: interface-name
32199 description: Name that identifies the link aggregate interface
32202 example: __INTERFACE-NAME__
32203 - name: interface-name
32205 description: Name given to the interface
32208 example: __INTERFACE-NAME__
32211 description: PCI ID used to identify the sriov-vf
32214 example: __PCI-ID__
32215 /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}:
32219 summary: returns sriov-vf
32220 description: returns sriov-vf
32221 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
32227 description: successful operation
32229 $ref: "#/getDefinitions/sriov-vf"
32231 description: Response codes found in [response codes](https://wiki.onap.org/).
32235 description: Unique id of VNF. This is unique across the graph.
32238 example: __VNF-ID__
32239 - name: interface-name
32241 description: Name that identifies the link aggregate interface
32244 example: __INTERFACE-NAME__
32245 - name: interface-name
32247 description: Name given to the interface
32250 example: __INTERFACE-NAME__
32253 description: PCI ID used to identify the sriov-vf
32256 example: __PCI-ID__
32259 description: Name of VNF.
32264 description: Alternate name of VNF.
32269 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
32274 description: Unique identifier of service from ASDC
32277 - name: regional-resource-zone
32279 description: Regional way of organizing pservers, source of truth should define values
32282 - name: prov-status
32284 description: Trigger for operational monitoring of this resource by Service Assurance systems.
32287 - name: heat-stack-id
32289 description: Heat stack id corresponding to this instance, managed by MSO
32296 - name: is-closed-loop-disabled
32300 - name: persona-model-id
32302 description: the ASDC model id for this resource or service model.
32305 - name: persona-model-version
32307 description: the ASDC model version for this resource or service model.
32310 - name: widget-model-id
32312 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32315 - name: widget-model-version
32317 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32320 - name: interface-id
32322 description: ID of interface
32327 description: MAC address for the interface
32330 - name: network-name
32332 description: Name of the network
32335 - name: vf-vlan-filter
32337 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
32340 - name: vf-mac-filter
32342 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
32345 - name: vf-vlan-strip
32347 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
32350 - name: neutron-network-id
32352 description: Neutron network id of the interface
32358 summary: create or update an existing sriov-vf
32360 Create or update an existing sriov-vf.
32362 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32363 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
32372 description: Response codes found in [response codes](https://wiki.onap.org/).
32376 description: Unique id of VNF. This is unique across the graph.
32379 example: __VNF-ID__
32380 - name: interface-name
32382 description: Name that identifies the link aggregate interface
32385 example: __INTERFACE-NAME__
32386 - name: interface-name
32388 description: Name given to the interface
32391 example: __INTERFACE-NAME__
32394 description: PCI ID used to identify the sriov-vf
32397 example: __PCI-ID__
32400 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
32403 $ref: "#/definitions/sriov-vf"
32407 summary: update an existing sriov-vf
32409 Update an existing sriov-vf
32411 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32412 The PUT operation will entirely replace an existing object.
32413 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32415 Other differences between PUT and PATCH are:
32417 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32418 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32419 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32420 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
32429 description: Response codes found in [response codes](https://wiki.onap.org/).
32433 description: Unique id of VNF. This is unique across the graph.
32436 example: __VNF-ID__
32437 - name: interface-name
32439 description: Name that identifies the link aggregate interface
32442 example: __INTERFACE-NAME__
32443 - name: interface-name
32445 description: Name given to the interface
32448 example: __INTERFACE-NAME__
32451 description: PCI ID used to identify the sriov-vf
32454 example: __PCI-ID__
32457 description: sriov-vf object that needs to be created or updated.
32460 $ref: "#/patchDefinitions/sriov-vf"
32464 summary: delete an existing sriov-vf
32465 description: delete an existing sriov-vf
32466 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
32475 description: Response codes found in [response codes](https://wiki.onap.org/).
32479 description: Unique id of VNF. This is unique across the graph.
32482 example: __VNF-ID__
32483 - name: interface-name
32485 description: Name that identifies the link aggregate interface
32488 example: __INTERFACE-NAME__
32489 - name: interface-name
32491 description: Name given to the interface
32494 example: __INTERFACE-NAME__
32497 description: PCI ID used to identify the sriov-vf
32500 example: __PCI-ID__
32501 - name: resource-version
32503 description: resource-version for concurrency
32506 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
32510 summary: returns sriov-vfs
32511 description: returns sriov-vfs
32512 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
32518 description: successful operation
32520 $ref: "#/getDefinitions/sriov-vfs"
32522 description: Response codes found in [response codes](https://wiki.onap.org/).
32526 description: Unique id of VNF. This is unique across the graph.
32529 example: __VNF-ID__
32530 - name: interface-name
32532 description: Name that identifies the link aggregate interface
32535 example: __INTERFACE-NAME__
32536 - name: interface-name
32538 description: Name given to the interface
32541 example: __INTERFACE-NAME__
32544 description: Name of VNF.
32549 description: Alternate name of VNF.
32554 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
32559 description: Unique identifier of service from ASDC
32562 - name: regional-resource-zone
32564 description: Regional way of organizing pservers, source of truth should define values
32567 - name: prov-status
32569 description: Trigger for operational monitoring of this resource by Service Assurance systems.
32572 - name: heat-stack-id
32574 description: Heat stack id corresponding to this instance, managed by MSO
32581 - name: is-closed-loop-disabled
32585 - name: persona-model-id
32587 description: the ASDC model id for this resource or service model.
32590 - name: persona-model-version
32592 description: the ASDC model version for this resource or service model.
32595 - name: widget-model-id
32597 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32600 - name: widget-model-version
32602 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32605 - name: interface-id
32607 description: ID of interface
32612 description: MAC address for the interface
32615 - name: network-name
32617 description: Name of the network
32620 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
32624 summary: see node definition for valid relationships
32625 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
32634 description: Response codes found in [response codes](https://wiki.onap.org/).
32638 description: Unique id of VNF. This is unique across the graph.
32641 example: __VNF-ID__
32642 - name: interface-name
32644 description: Name that identifies the link aggregate interface
32647 example: __INTERFACE-NAME__
32648 - name: interface-name
32650 description: Name given to the interface
32653 example: __INTERFACE-NAME__
32656 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
32659 $ref: "#/definitions/relationship"
32663 summary: delete an existing relationship
32664 description: delete an existing relationship
32665 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
32674 description: Response codes found in [response codes](https://wiki.onap.org/).
32678 description: Unique id of VNF. This is unique across the graph.
32681 example: __VNF-ID__
32682 - name: interface-name
32684 description: Name that identifies the link aggregate interface
32687 example: __INTERFACE-NAME__
32688 - name: interface-name
32690 description: Name given to the interface
32693 example: __INTERFACE-NAME__
32694 /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:
32698 summary: see node definition for valid relationships
32699 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
32708 description: Response codes found in [response codes](https://wiki.onap.org/).
32712 description: Unique id of VNF. This is unique across the graph.
32715 example: __VNF-ID__
32716 - name: interface-name
32718 description: Name that identifies the link aggregate interface
32721 example: __INTERFACE-NAME__
32722 - name: interface-name
32724 description: Name given to the interface
32727 example: __INTERFACE-NAME__
32728 - name: l3-interface-ipv4-address
32730 description: IP address
32733 example: __L3-INTERFACE-IPV4-ADDRESS__
32736 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
32739 $ref: "#/definitions/relationship"
32743 summary: delete an existing relationship
32744 description: delete an existing relationship
32745 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
32754 description: Response codes found in [response codes](https://wiki.onap.org/).
32758 description: Unique id of VNF. This is unique across the graph.
32761 example: __VNF-ID__
32762 - name: interface-name
32764 description: Name that identifies the link aggregate interface
32767 example: __INTERFACE-NAME__
32768 - name: interface-name
32770 description: Name given to the interface
32773 example: __INTERFACE-NAME__
32774 - name: l3-interface-ipv4-address
32776 description: IP address
32779 example: __L3-INTERFACE-IPV4-ADDRESS__
32780 /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}:
32784 summary: returns l3-interface-ipv4-address-list
32785 description: returns l3-interface-ipv4-address-list
32786 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
32792 description: successful operation
32794 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
32796 description: Response codes found in [response codes](https://wiki.onap.org/).
32800 description: Unique id of VNF. This is unique across the graph.
32803 example: __VNF-ID__
32804 - name: interface-name
32806 description: Name that identifies the link aggregate interface
32809 example: __INTERFACE-NAME__
32810 - name: interface-name
32812 description: Name given to the interface
32815 example: __INTERFACE-NAME__
32816 - name: l3-interface-ipv4-address
32818 description: IP address
32821 example: __L3-INTERFACE-IPV4-ADDRESS__
32824 description: Name of VNF.
32829 description: Alternate name of VNF.
32834 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
32839 description: Unique identifier of service from ASDC
32842 - name: regional-resource-zone
32844 description: Regional way of organizing pservers, source of truth should define values
32847 - name: prov-status
32849 description: Trigger for operational monitoring of this resource by Service Assurance systems.
32852 - name: heat-stack-id
32854 description: Heat stack id corresponding to this instance, managed by MSO
32861 - name: is-closed-loop-disabled
32865 - name: persona-model-id
32867 description: the ASDC model id for this resource or service model.
32870 - name: persona-model-version
32872 description: the ASDC model version for this resource or service model.
32875 - name: widget-model-id
32877 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32880 - name: widget-model-version
32882 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32885 - name: interface-id
32887 description: ID of interface
32892 description: MAC address for the interface
32895 - name: network-name
32897 description: Name of the network
32900 - name: vlan-id-inner
32902 description: Inner VLAN tag
32906 - name: neutron-network-id
32908 description: Neutron network id of the interface that address belongs to
32911 - name: neutron-subnet-id
32913 description: Neutron id of subnet that address belongs to
32919 summary: create or update an existing l3-interface-ipv4-address-list
32921 Create or update an existing l3-interface-ipv4-address-list.
32923 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32924 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
32933 description: Response codes found in [response codes](https://wiki.onap.org/).
32937 description: Unique id of VNF. This is unique across the graph.
32940 example: __VNF-ID__
32941 - name: interface-name
32943 description: Name that identifies the link aggregate interface
32946 example: __INTERFACE-NAME__
32947 - name: interface-name
32949 description: Name given to the interface
32952 example: __INTERFACE-NAME__
32953 - name: l3-interface-ipv4-address
32955 description: IP address
32958 example: __L3-INTERFACE-IPV4-ADDRESS__
32961 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
32964 $ref: "#/definitions/l3-interface-ipv4-address-list"
32968 summary: update an existing l3-interface-ipv4-address-list
32970 Update an existing l3-interface-ipv4-address-list
32972 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32973 The PUT operation will entirely replace an existing object.
32974 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32976 Other differences between PUT and PATCH are:
32978 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32979 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32980 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32981 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
32990 description: Response codes found in [response codes](https://wiki.onap.org/).
32994 description: Unique id of VNF. This is unique across the graph.
32997 example: __VNF-ID__
32998 - name: interface-name
33000 description: Name that identifies the link aggregate interface
33003 example: __INTERFACE-NAME__
33004 - name: interface-name
33006 description: Name given to the interface
33009 example: __INTERFACE-NAME__
33010 - name: l3-interface-ipv4-address
33012 description: IP address
33015 example: __L3-INTERFACE-IPV4-ADDRESS__
33018 description: l3-interface-ipv4-address-list object that needs to be created or updated.
33021 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
33025 summary: delete an existing l3-interface-ipv4-address-list
33026 description: delete an existing l3-interface-ipv4-address-list
33027 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
33036 description: Response codes found in [response codes](https://wiki.onap.org/).
33040 description: Unique id of VNF. This is unique across the graph.
33043 example: __VNF-ID__
33044 - name: interface-name
33046 description: Name that identifies the link aggregate interface
33049 example: __INTERFACE-NAME__
33050 - name: interface-name
33052 description: Name given to the interface
33055 example: __INTERFACE-NAME__
33056 - name: l3-interface-ipv4-address
33058 description: IP address
33061 example: __L3-INTERFACE-IPV4-ADDRESS__
33062 - name: resource-version
33064 description: resource-version for concurrency
33067 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
33071 summary: see node definition for valid relationships
33072 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
33081 description: Response codes found in [response codes](https://wiki.onap.org/).
33085 description: Unique id of VNF. This is unique across the graph.
33088 example: __VNF-ID__
33089 - name: interface-name
33091 description: Name that identifies the link aggregate interface
33094 example: __INTERFACE-NAME__
33095 - name: interface-name
33097 description: Name given to the interface
33100 example: __INTERFACE-NAME__
33101 - name: l3-interface-ipv6-address
33103 description: IP address
33106 example: __L3-INTERFACE-IPV6-ADDRESS__
33109 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
33112 $ref: "#/definitions/relationship"
33116 summary: delete an existing relationship
33117 description: delete an existing relationship
33118 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
33127 description: Response codes found in [response codes](https://wiki.onap.org/).
33131 description: Unique id of VNF. This is unique across the graph.
33134 example: __VNF-ID__
33135 - name: interface-name
33137 description: Name that identifies the link aggregate interface
33140 example: __INTERFACE-NAME__
33141 - name: interface-name
33143 description: Name given to the interface
33146 example: __INTERFACE-NAME__
33147 - name: l3-interface-ipv6-address
33149 description: IP address
33152 example: __L3-INTERFACE-IPV6-ADDRESS__
33153 /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}:
33157 summary: returns l3-interface-ipv6-address-list
33158 description: returns l3-interface-ipv6-address-list
33159 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
33165 description: successful operation
33167 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
33169 description: Response codes found in [response codes](https://wiki.onap.org/).
33173 description: Unique id of VNF. This is unique across the graph.
33176 example: __VNF-ID__
33177 - name: interface-name
33179 description: Name that identifies the link aggregate interface
33182 example: __INTERFACE-NAME__
33183 - name: interface-name
33185 description: Name given to the interface
33188 example: __INTERFACE-NAME__
33189 - name: l3-interface-ipv6-address
33191 description: IP address
33194 example: __L3-INTERFACE-IPV6-ADDRESS__
33197 description: Name of VNF.
33202 description: Alternate name of VNF.
33207 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
33212 description: Unique identifier of service from ASDC
33215 - name: regional-resource-zone
33217 description: Regional way of organizing pservers, source of truth should define values
33220 - name: prov-status
33222 description: Trigger for operational monitoring of this resource by Service Assurance systems.
33225 - name: heat-stack-id
33227 description: Heat stack id corresponding to this instance, managed by MSO
33234 - name: is-closed-loop-disabled
33238 - name: persona-model-id
33240 description: the ASDC model id for this resource or service model.
33243 - name: persona-model-version
33245 description: the ASDC model version for this resource or service model.
33248 - name: widget-model-id
33250 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33253 - name: widget-model-version
33255 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33258 - name: interface-id
33260 description: ID of interface
33265 description: MAC address for the interface
33268 - name: network-name
33270 description: Name of the network
33273 - name: vlan-id-inner
33275 description: Inner VLAN tag
33279 - name: neutron-network-id
33281 description: Neutron network id of the interface that address belongs to
33284 - name: neutron-subnet-id
33286 description: Neutron id of subnet that address belongs to
33292 summary: create or update an existing l3-interface-ipv6-address-list
33294 Create or update an existing l3-interface-ipv6-address-list.
33296 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33297 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
33306 description: Response codes found in [response codes](https://wiki.onap.org/).
33310 description: Unique id of VNF. This is unique across the graph.
33313 example: __VNF-ID__
33314 - name: interface-name
33316 description: Name that identifies the link aggregate interface
33319 example: __INTERFACE-NAME__
33320 - name: interface-name
33322 description: Name given to the interface
33325 example: __INTERFACE-NAME__
33326 - name: l3-interface-ipv6-address
33328 description: IP address
33331 example: __L3-INTERFACE-IPV6-ADDRESS__
33334 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
33337 $ref: "#/definitions/l3-interface-ipv6-address-list"
33341 summary: update an existing l3-interface-ipv6-address-list
33343 Update an existing l3-interface-ipv6-address-list
33345 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33346 The PUT operation will entirely replace an existing object.
33347 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33349 Other differences between PUT and PATCH are:
33351 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33352 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33353 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33354 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
33363 description: Response codes found in [response codes](https://wiki.onap.org/).
33367 description: Unique id of VNF. This is unique across the graph.
33370 example: __VNF-ID__
33371 - name: interface-name
33373 description: Name that identifies the link aggregate interface
33376 example: __INTERFACE-NAME__
33377 - name: interface-name
33379 description: Name given to the interface
33382 example: __INTERFACE-NAME__
33383 - name: l3-interface-ipv6-address
33385 description: IP address
33388 example: __L3-INTERFACE-IPV6-ADDRESS__
33391 description: l3-interface-ipv6-address-list object that needs to be created or updated.
33394 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
33398 summary: delete an existing l3-interface-ipv6-address-list
33399 description: delete an existing l3-interface-ipv6-address-list
33400 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
33409 description: Response codes found in [response codes](https://wiki.onap.org/).
33413 description: Unique id of VNF. This is unique across the graph.
33416 example: __VNF-ID__
33417 - name: interface-name
33419 description: Name that identifies the link aggregate interface
33422 example: __INTERFACE-NAME__
33423 - name: interface-name
33425 description: Name given to the interface
33428 example: __INTERFACE-NAME__
33429 - name: l3-interface-ipv6-address
33431 description: IP address
33434 example: __L3-INTERFACE-IPV6-ADDRESS__
33435 - name: resource-version
33437 description: resource-version for concurrency
33440 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
33444 summary: returns l-interface
33445 description: returns l-interface
33446 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
33452 description: successful operation
33454 $ref: "#/getDefinitions/l-interface"
33456 description: Response codes found in [response codes](https://wiki.onap.org/).
33460 description: Unique id of VNF. This is unique across the graph.
33463 example: __VNF-ID__
33464 - name: interface-name
33466 description: Name that identifies the link aggregate interface
33469 example: __INTERFACE-NAME__
33470 - name: interface-name
33472 description: Name given to the interface
33475 example: __INTERFACE-NAME__
33478 description: Name of VNF.
33483 description: Alternate name of VNF.
33488 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
33493 description: Unique identifier of service from ASDC
33496 - name: regional-resource-zone
33498 description: Regional way of organizing pservers, source of truth should define values
33501 - name: prov-status
33503 description: Trigger for operational monitoring of this resource by Service Assurance systems.
33506 - name: heat-stack-id
33508 description: Heat stack id corresponding to this instance, managed by MSO
33515 - name: is-closed-loop-disabled
33519 - name: persona-model-id
33521 description: the ASDC model id for this resource or service model.
33524 - name: persona-model-version
33526 description: the ASDC model version for this resource or service model.
33529 - name: widget-model-id
33531 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33534 - name: widget-model-version
33536 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33539 - name: interface-id
33541 description: ID of interface
33546 description: MAC address for the interface
33549 - name: network-name
33551 description: Name of the network
33557 summary: create or update an existing l-interface
33559 Create or update an existing l-interface.
33561 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33562 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
33571 description: Response codes found in [response codes](https://wiki.onap.org/).
33575 description: Unique id of VNF. This is unique across the graph.
33578 example: __VNF-ID__
33579 - name: interface-name
33581 description: Name that identifies the link aggregate interface
33584 example: __INTERFACE-NAME__
33585 - name: interface-name
33587 description: Name given to the interface
33590 example: __INTERFACE-NAME__
33593 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
33596 $ref: "#/definitions/l-interface"
33600 summary: update an existing l-interface
33602 Update an existing l-interface
33604 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33605 The PUT operation will entirely replace an existing object.
33606 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33608 Other differences between PUT and PATCH are:
33610 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33611 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33612 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33613 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
33622 description: Response codes found in [response codes](https://wiki.onap.org/).
33626 description: Unique id of VNF. This is unique across the graph.
33629 example: __VNF-ID__
33630 - name: interface-name
33632 description: Name that identifies the link aggregate interface
33635 example: __INTERFACE-NAME__
33636 - name: interface-name
33638 description: Name given to the interface
33641 example: __INTERFACE-NAME__
33644 description: l-interface object that needs to be created or updated.
33647 $ref: "#/patchDefinitions/l-interface"
33651 summary: delete an existing l-interface
33652 description: delete an existing l-interface
33653 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
33662 description: Response codes found in [response codes](https://wiki.onap.org/).
33666 description: Unique id of VNF. This is unique across the graph.
33669 example: __VNF-ID__
33670 - name: interface-name
33672 description: Name that identifies the link aggregate interface
33675 example: __INTERFACE-NAME__
33676 - name: interface-name
33678 description: Name given to the interface
33681 example: __INTERFACE-NAME__
33682 - name: resource-version
33684 description: resource-version for concurrency
33687 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
33691 summary: returns l-interfaces
33692 description: returns l-interfaces
33693 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces
33699 description: successful operation
33701 $ref: "#/getDefinitions/l-interfaces"
33703 description: Response codes found in [response codes](https://wiki.onap.org/).
33707 description: Unique id of VNF. This is unique across the graph.
33710 example: __VNF-ID__
33711 - name: interface-name
33713 description: Name that identifies the link aggregate interface
33716 example: __INTERFACE-NAME__
33719 description: Name of VNF.
33724 description: Alternate name of VNF.
33729 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
33734 description: Unique identifier of service from ASDC
33737 - name: regional-resource-zone
33739 description: Regional way of organizing pservers, source of truth should define values
33742 - name: prov-status
33744 description: Trigger for operational monitoring of this resource by Service Assurance systems.
33747 - name: heat-stack-id
33749 description: Heat stack id corresponding to this instance, managed by MSO
33756 - name: is-closed-loop-disabled
33760 - name: persona-model-id
33762 description: the ASDC model id for this resource or service model.
33765 - name: persona-model-version
33767 description: the ASDC model version for this resource or service model.
33770 - name: widget-model-id
33772 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33775 - name: widget-model-version
33777 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33780 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}:
33784 summary: returns lag-interface
33785 description: returns lag-interface
33786 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
33792 description: successful operation
33794 $ref: "#/getDefinitions/lag-interface"
33796 description: Response codes found in [response codes](https://wiki.onap.org/).
33800 description: Unique id of VNF. This is unique across the graph.
33803 example: __VNF-ID__
33804 - name: interface-name
33806 description: Name that identifies the link aggregate interface
33809 example: __INTERFACE-NAME__
33812 description: Name of VNF.
33817 description: Alternate name of VNF.
33822 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
33827 description: Unique identifier of service from ASDC
33830 - name: regional-resource-zone
33832 description: Regional way of organizing pservers, source of truth should define values
33835 - name: prov-status
33837 description: Trigger for operational monitoring of this resource by Service Assurance systems.
33840 - name: heat-stack-id
33842 description: Heat stack id corresponding to this instance, managed by MSO
33849 - name: is-closed-loop-disabled
33853 - name: persona-model-id
33855 description: the ASDC model id for this resource or service model.
33858 - name: persona-model-version
33860 description: the ASDC model version for this resource or service model.
33863 - name: widget-model-id
33865 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33868 - name: widget-model-version
33870 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33876 summary: create or update an existing lag-interface
33878 Create or update an existing lag-interface.
33880 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33881 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
33890 description: Response codes found in [response codes](https://wiki.onap.org/).
33894 description: Unique id of VNF. This is unique across the graph.
33897 example: __VNF-ID__
33898 - name: interface-name
33900 description: Name that identifies the link aggregate interface
33903 example: __INTERFACE-NAME__
33906 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
33909 $ref: "#/definitions/lag-interface"
33913 summary: update an existing lag-interface
33915 Update an existing lag-interface
33917 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33918 The PUT operation will entirely replace an existing object.
33919 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33921 Other differences between PUT and PATCH are:
33923 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33924 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33925 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33926 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
33935 description: Response codes found in [response codes](https://wiki.onap.org/).
33939 description: Unique id of VNF. This is unique across the graph.
33942 example: __VNF-ID__
33943 - name: interface-name
33945 description: Name that identifies the link aggregate interface
33948 example: __INTERFACE-NAME__
33951 description: lag-interface object that needs to be created or updated.
33954 $ref: "#/patchDefinitions/lag-interface"
33958 summary: delete an existing lag-interface
33959 description: delete an existing lag-interface
33960 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
33969 description: Response codes found in [response codes](https://wiki.onap.org/).
33973 description: Unique id of VNF. This is unique across the graph.
33976 example: __VNF-ID__
33977 - name: interface-name
33979 description: Name that identifies the link aggregate interface
33982 example: __INTERFACE-NAME__
33983 - name: resource-version
33985 description: resource-version for concurrency
33988 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces:
33992 summary: returns lag-interfaces
33993 description: returns lag-interfaces
33994 operationId: getNetworkGenericVnfsGenericVnfLagInterfaces
34000 description: successful operation
34002 $ref: "#/getDefinitions/lag-interfaces"
34004 description: Response codes found in [response codes](https://wiki.onap.org/).
34008 description: Unique id of VNF. This is unique across the graph.
34011 example: __VNF-ID__
34014 description: Name of VNF.
34019 description: Alternate name of VNF.
34024 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
34029 description: Unique identifier of service from ASDC
34032 - name: regional-resource-zone
34034 description: Regional way of organizing pservers, source of truth should define values
34037 - name: prov-status
34039 description: Trigger for operational monitoring of this resource by Service Assurance systems.
34042 - name: heat-stack-id
34044 description: Heat stack id corresponding to this instance, managed by MSO
34051 - name: is-closed-loop-disabled
34055 - name: persona-model-id
34057 description: the ASDC model id for this resource or service model.
34060 - name: persona-model-version
34062 description: the ASDC model version for this resource or service model.
34065 - name: widget-model-id
34067 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34070 - name: widget-model-version
34072 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34075 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship:
34079 summary: see node definition for valid relationships
34080 operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
34089 description: Response codes found in [response codes](https://wiki.onap.org/).
34093 description: Unique id of VNF. This is unique across the graph.
34096 example: __VNF-ID__
34097 - name: vf-module-id
34099 description: Unique ID of vf-module.
34102 example: __VF-MODULE-ID__
34105 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
34108 $ref: "#/definitions/relationship"
34112 summary: delete an existing relationship
34113 description: delete an existing relationship
34114 operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
34123 description: Response codes found in [response codes](https://wiki.onap.org/).
34127 description: Unique id of VNF. This is unique across the graph.
34130 example: __VNF-ID__
34131 - name: vf-module-id
34133 description: Unique ID of vf-module.
34136 example: __VF-MODULE-ID__
34137 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}:
34141 summary: returns vf-module
34142 description: returns vf-module
34143 operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule
34149 description: successful operation
34151 $ref: "#/getDefinitions/vf-module"
34153 description: Response codes found in [response codes](https://wiki.onap.org/).
34157 description: Unique id of VNF. This is unique across the graph.
34160 example: __VNF-ID__
34161 - name: vf-module-id
34163 description: Unique ID of vf-module.
34166 example: __VF-MODULE-ID__
34169 description: Name of VNF.
34174 description: Alternate name of VNF.
34179 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
34184 description: Unique identifier of service from ASDC
34187 - name: regional-resource-zone
34189 description: Regional way of organizing pservers, source of truth should define values
34192 - name: prov-status
34194 description: Trigger for operational monitoring of this resource by Service Assurance systems.
34197 - name: heat-stack-id
34199 description: Heat stack id corresponding to this instance, managed by MSO
34206 - name: is-closed-loop-disabled
34210 - name: persona-model-id
34212 description: the ASDC model id for this resource or service model.
34215 - name: persona-model-version
34217 description: the ASDC model version for this resource or service model.
34220 - name: widget-model-id
34222 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34225 - name: widget-model-version
34227 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34230 - name: vf-module-name
34232 description: Name of vf-module
34235 - name: heat-stack-id
34237 description: Heat stack id corresponding to this instance.
34240 - name: persona-model-id
34242 description: the ASDC model id for this resource or service model.
34245 - name: persona-model-version
34247 description: the ASDC model version for this resource or service model.
34250 - name: widget-model-id
34252 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34255 - name: widget-model-version
34257 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34260 - name: contrail-service-instance-fqdn
34262 description: the Contrail unique ID for a service-instance
34268 summary: create or update an existing vf-module
34270 Create or update an existing vf-module.
34272 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34273 operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
34282 description: Response codes found in [response codes](https://wiki.onap.org/).
34286 description: Unique id of VNF. This is unique across the graph.
34289 example: __VNF-ID__
34290 - name: vf-module-id
34292 description: Unique ID of vf-module.
34295 example: __VF-MODULE-ID__
34298 description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
34301 $ref: "#/definitions/vf-module"
34305 summary: update an existing vf-module
34307 Update an existing vf-module
34309 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34310 The PUT operation will entirely replace an existing object.
34311 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34313 Other differences between PUT and PATCH are:
34315 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34316 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34317 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34318 operationId: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
34327 description: Response codes found in [response codes](https://wiki.onap.org/).
34331 description: Unique id of VNF. This is unique across the graph.
34334 example: __VNF-ID__
34335 - name: vf-module-id
34337 description: Unique ID of vf-module.
34340 example: __VF-MODULE-ID__
34343 description: vf-module object that needs to be created or updated.
34346 $ref: "#/patchDefinitions/vf-module"
34350 summary: delete an existing vf-module
34351 description: delete an existing vf-module
34352 operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule
34361 description: Response codes found in [response codes](https://wiki.onap.org/).
34365 description: Unique id of VNF. This is unique across the graph.
34368 example: __VNF-ID__
34369 - name: vf-module-id
34371 description: Unique ID of vf-module.
34374 example: __VF-MODULE-ID__
34375 - name: resource-version
34377 description: resource-version for concurrency
34380 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules:
34384 summary: returns vf-modules
34385 description: returns vf-modules
34386 operationId: getNetworkGenericVnfsGenericVnfVfModules
34392 description: successful operation
34394 $ref: "#/getDefinitions/vf-modules"
34396 description: Response codes found in [response codes](https://wiki.onap.org/).
34400 description: Unique id of VNF. This is unique across the graph.
34403 example: __VNF-ID__
34406 description: Name of VNF.
34411 description: Alternate name of VNF.
34416 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
34421 description: Unique identifier of service from ASDC
34424 - name: regional-resource-zone
34426 description: Regional way of organizing pservers, source of truth should define values
34429 - name: prov-status
34431 description: Trigger for operational monitoring of this resource by Service Assurance systems.
34434 - name: heat-stack-id
34436 description: Heat stack id corresponding to this instance, managed by MSO
34443 - name: is-closed-loop-disabled
34447 - name: persona-model-id
34449 description: the ASDC model id for this resource or service model.
34452 - name: persona-model-version
34454 description: the ASDC model version for this resource or service model.
34457 - name: widget-model-id
34459 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34462 - name: widget-model-version
34464 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34467 /network/generic-vnfs/generic-vnf/{vnf-id}:
34471 summary: returns generic-vnf
34472 description: returns generic-vnf
34473 operationId: getNetworkGenericVnfsGenericVnf
34479 description: successful operation
34481 $ref: "#/getDefinitions/generic-vnf"
34483 description: Response codes found in [response codes](https://wiki.onap.org/).
34487 description: Unique id of VNF. This is unique across the graph.
34490 example: __VNF-ID__
34493 description: Name of VNF.
34498 description: Alternate name of VNF.
34503 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
34508 description: Unique identifier of service from ASDC
34511 - name: regional-resource-zone
34513 description: Regional way of organizing pservers, source of truth should define values
34516 - name: prov-status
34518 description: Trigger for operational monitoring of this resource by Service Assurance systems.
34521 - name: heat-stack-id
34523 description: Heat stack id corresponding to this instance, managed by MSO
34530 - name: is-closed-loop-disabled
34534 - name: persona-model-id
34536 description: the ASDC model id for this resource or service model.
34539 - name: persona-model-version
34541 description: the ASDC model version for this resource or service model.
34544 - name: widget-model-id
34546 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34549 - name: widget-model-version
34551 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34557 summary: create or update an existing generic-vnf
34559 Create or update an existing generic-vnf.
34561 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34562 operationId: createOrUpdateNetworkGenericVnfsGenericVnf
34571 description: Response codes found in [response codes](https://wiki.onap.org/).
34575 description: Unique id of VNF. This is unique across the graph.
34578 example: __VNF-ID__
34581 description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnf.json)
34584 $ref: "#/definitions/generic-vnf"
34588 summary: update an existing generic-vnf
34590 Update an existing generic-vnf
34592 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34593 The PUT operation will entirely replace an existing object.
34594 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34596 Other differences between PUT and PATCH are:
34598 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34599 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34600 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34601 operationId: UpdateNetworkGenericVnfsGenericVnf
34610 description: Response codes found in [response codes](https://wiki.onap.org/).
34614 description: Unique id of VNF. This is unique across the graph.
34617 example: __VNF-ID__
34620 description: generic-vnf object that needs to be created or updated.
34623 $ref: "#/patchDefinitions/generic-vnf"
34627 summary: delete an existing generic-vnf
34628 description: delete an existing generic-vnf
34629 operationId: deleteNetworkGenericVnfsGenericVnf
34638 description: Response codes found in [response codes](https://wiki.onap.org/).
34642 description: Unique id of VNF. This is unique across the graph.
34645 example: __VNF-ID__
34646 - name: resource-version
34648 description: resource-version for concurrency
34651 /network/generic-vnfs:
34655 summary: returns generic-vnfs
34656 description: returns generic-vnfs
34657 operationId: getNetworkGenericVnfs
34663 description: successful operation
34665 $ref: "#/getDefinitions/generic-vnfs"
34667 description: Response codes found in [response codes](https://wiki.onap.org/).
34668 /network/lag-links/lag-link/{link-name}/relationship-list/relationship:
34672 summary: see node definition for valid relationships
34673 operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship
34682 description: Response codes found in [response codes](https://wiki.onap.org/).
34686 description: Alphabetical concatenation of lag-interface names
34689 example: __LINK-NAME__
34692 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkLagLinksLagLink.json)
34695 $ref: "#/definitions/relationship"
34699 summary: delete an existing relationship
34700 description: delete an existing relationship
34701 operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship
34710 description: Response codes found in [response codes](https://wiki.onap.org/).
34714 description: Alphabetical concatenation of lag-interface names
34717 example: __LINK-NAME__
34718 /network/lag-links/lag-link/{link-name}:
34722 summary: returns lag-link
34723 description: returns lag-link
34724 operationId: getNetworkLagLinksLagLink
34730 description: successful operation
34732 $ref: "#/getDefinitions/lag-link"
34734 description: Response codes found in [response codes](https://wiki.onap.org/).
34738 description: Alphabetical concatenation of lag-interface names
34741 example: __LINK-NAME__
34745 summary: create or update an existing lag-link
34747 Create or update an existing lag-link.
34749 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34750 operationId: createOrUpdateNetworkLagLinksLagLink
34759 description: Response codes found in [response codes](https://wiki.onap.org/).
34763 description: Alphabetical concatenation of lag-interface names
34766 example: __LINK-NAME__
34769 description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkLagLinksLagLink.json)
34772 $ref: "#/definitions/lag-link"
34776 summary: update an existing lag-link
34778 Update an existing lag-link
34780 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34781 The PUT operation will entirely replace an existing object.
34782 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34784 Other differences between PUT and PATCH are:
34786 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34787 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34788 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34789 operationId: UpdateNetworkLagLinksLagLink
34798 description: Response codes found in [response codes](https://wiki.onap.org/).
34802 description: Alphabetical concatenation of lag-interface names
34805 example: __LINK-NAME__
34808 description: lag-link object that needs to be created or updated.
34811 $ref: "#/patchDefinitions/lag-link"
34815 summary: delete an existing lag-link
34816 description: delete an existing lag-link
34817 operationId: deleteNetworkLagLinksLagLink
34826 description: Response codes found in [response codes](https://wiki.onap.org/).
34830 description: Alphabetical concatenation of lag-interface names
34833 example: __LINK-NAME__
34834 - name: resource-version
34836 description: resource-version for concurrency
34839 /network/lag-links:
34843 summary: returns lag-links
34844 description: returns lag-links
34845 operationId: getNetworkLagLinks
34851 description: successful operation
34853 $ref: "#/getDefinitions/lag-links"
34855 description: Response codes found in [response codes](https://wiki.onap.org/).
34856 /network/newvces/newvce/{vnf-id2}/relationship-list/relationship:
34860 summary: see node definition for valid relationships
34861 operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship
34870 description: Response codes found in [response codes](https://wiki.onap.org/).
34874 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34877 example: __VNF-ID2__
34880 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvce.json)
34883 $ref: "#/definitions/relationship"
34887 summary: delete an existing relationship
34888 description: delete an existing relationship
34889 operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship
34898 description: Response codes found in [response codes](https://wiki.onap.org/).
34902 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34905 example: __VNF-ID2__
34906 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
34910 summary: see node definition for valid relationships
34911 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
34920 description: Response codes found in [response codes](https://wiki.onap.org/).
34924 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34927 example: __VNF-ID2__
34928 - name: interface-name
34930 description: Name given to the interface
34933 example: __INTERFACE-NAME__
34934 - name: vlan-interface
34936 description: String that identifies the interface
34939 example: __VLAN-INTERFACE__
34942 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
34945 $ref: "#/definitions/relationship"
34949 summary: delete an existing relationship
34950 description: delete an existing relationship
34951 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
34960 description: Response codes found in [response codes](https://wiki.onap.org/).
34964 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34967 example: __VNF-ID2__
34968 - name: interface-name
34970 description: Name given to the interface
34973 example: __INTERFACE-NAME__
34974 - name: vlan-interface
34976 description: String that identifies the interface
34979 example: __VLAN-INTERFACE__
34980 /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:
34984 summary: see node definition for valid relationships
34985 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
34994 description: Response codes found in [response codes](https://wiki.onap.org/).
34998 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35001 example: __VNF-ID2__
35002 - name: interface-name
35004 description: Name given to the interface
35007 example: __INTERFACE-NAME__
35008 - name: vlan-interface
35010 description: String that identifies the interface
35013 example: __VLAN-INTERFACE__
35014 - name: l3-interface-ipv4-address
35016 description: IP address
35019 example: __L3-INTERFACE-IPV4-ADDRESS__
35022 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
35025 $ref: "#/definitions/relationship"
35029 summary: delete an existing relationship
35030 description: delete an existing relationship
35031 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
35040 description: Response codes found in [response codes](https://wiki.onap.org/).
35044 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35047 example: __VNF-ID2__
35048 - name: interface-name
35050 description: Name given to the interface
35053 example: __INTERFACE-NAME__
35054 - name: vlan-interface
35056 description: String that identifies the interface
35059 example: __VLAN-INTERFACE__
35060 - name: l3-interface-ipv4-address
35062 description: IP address
35065 example: __L3-INTERFACE-IPV4-ADDRESS__
35066 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
35070 summary: returns l3-interface-ipv4-address-list
35071 description: returns l3-interface-ipv4-address-list
35072 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35078 description: successful operation
35080 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
35082 description: Response codes found in [response codes](https://wiki.onap.org/).
35086 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35089 example: __VNF-ID2__
35090 - name: interface-name
35092 description: Name given to the interface
35095 example: __INTERFACE-NAME__
35096 - name: vlan-interface
35098 description: String that identifies the interface
35101 example: __VLAN-INTERFACE__
35102 - name: l3-interface-ipv4-address
35104 description: IP address
35107 example: __L3-INTERFACE-IPV4-ADDRESS__
35110 description: Name of VNF.
35115 description: Alternate name of VNF.
35120 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
35123 - name: prov-status
35125 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
35128 - name: heat-stack-id
35130 description: Heat stack id corresponding to this instance, managed by MSO
35133 - name: interface-id
35135 description: ID of interface
35140 description: MAC address for the interface
35143 - name: network-name
35145 description: Name of the network
35148 - name: vlan-id-inner
35150 description: Inner VLAN tag
35156 description: This indicates the customers VPN ID associated with this vlan
35159 - name: vlan-id-inner
35161 description: Inner VLAN tag
35165 - name: neutron-network-id
35167 description: Neutron network id of the interface that address belongs to
35170 - name: neutron-subnet-id
35172 description: Neutron id of subnet that address belongs to
35178 summary: create or update an existing l3-interface-ipv4-address-list
35180 Create or update an existing l3-interface-ipv4-address-list.
35182 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35183 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35192 description: Response codes found in [response codes](https://wiki.onap.org/).
35196 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35199 example: __VNF-ID2__
35200 - name: interface-name
35202 description: Name given to the interface
35205 example: __INTERFACE-NAME__
35206 - name: vlan-interface
35208 description: String that identifies the interface
35211 example: __VLAN-INTERFACE__
35212 - name: l3-interface-ipv4-address
35214 description: IP address
35217 example: __L3-INTERFACE-IPV4-ADDRESS__
35220 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
35223 $ref: "#/definitions/l3-interface-ipv4-address-list"
35227 summary: update an existing l3-interface-ipv4-address-list
35229 Update an existing l3-interface-ipv4-address-list
35231 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35232 The PUT operation will entirely replace an existing object.
35233 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35235 Other differences between PUT and PATCH are:
35237 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35238 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35239 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35240 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35249 description: Response codes found in [response codes](https://wiki.onap.org/).
35253 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35256 example: __VNF-ID2__
35257 - name: interface-name
35259 description: Name given to the interface
35262 example: __INTERFACE-NAME__
35263 - name: vlan-interface
35265 description: String that identifies the interface
35268 example: __VLAN-INTERFACE__
35269 - name: l3-interface-ipv4-address
35271 description: IP address
35274 example: __L3-INTERFACE-IPV4-ADDRESS__
35277 description: l3-interface-ipv4-address-list object that needs to be created or updated.
35280 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
35284 summary: delete an existing l3-interface-ipv4-address-list
35285 description: delete an existing l3-interface-ipv4-address-list
35286 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35295 description: Response codes found in [response codes](https://wiki.onap.org/).
35299 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35302 example: __VNF-ID2__
35303 - name: interface-name
35305 description: Name given to the interface
35308 example: __INTERFACE-NAME__
35309 - name: vlan-interface
35311 description: String that identifies the interface
35314 example: __VLAN-INTERFACE__
35315 - name: l3-interface-ipv4-address
35317 description: IP address
35320 example: __L3-INTERFACE-IPV4-ADDRESS__
35321 - name: resource-version
35323 description: resource-version for concurrency
35326 /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:
35330 summary: see node definition for valid relationships
35331 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
35340 description: Response codes found in [response codes](https://wiki.onap.org/).
35344 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35347 example: __VNF-ID2__
35348 - name: interface-name
35350 description: Name given to the interface
35353 example: __INTERFACE-NAME__
35354 - name: vlan-interface
35356 description: String that identifies the interface
35359 example: __VLAN-INTERFACE__
35360 - name: l3-interface-ipv6-address
35362 description: IP address
35365 example: __L3-INTERFACE-IPV6-ADDRESS__
35368 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
35371 $ref: "#/definitions/relationship"
35375 summary: delete an existing relationship
35376 description: delete an existing relationship
35377 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
35386 description: Response codes found in [response codes](https://wiki.onap.org/).
35390 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35393 example: __VNF-ID2__
35394 - name: interface-name
35396 description: Name given to the interface
35399 example: __INTERFACE-NAME__
35400 - name: vlan-interface
35402 description: String that identifies the interface
35405 example: __VLAN-INTERFACE__
35406 - name: l3-interface-ipv6-address
35408 description: IP address
35411 example: __L3-INTERFACE-IPV6-ADDRESS__
35412 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
35416 summary: returns l3-interface-ipv6-address-list
35417 description: returns l3-interface-ipv6-address-list
35418 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35424 description: successful operation
35426 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
35428 description: Response codes found in [response codes](https://wiki.onap.org/).
35432 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35435 example: __VNF-ID2__
35436 - name: interface-name
35438 description: Name given to the interface
35441 example: __INTERFACE-NAME__
35442 - name: vlan-interface
35444 description: String that identifies the interface
35447 example: __VLAN-INTERFACE__
35448 - name: l3-interface-ipv6-address
35450 description: IP address
35453 example: __L3-INTERFACE-IPV6-ADDRESS__
35456 description: Name of VNF.
35461 description: Alternate name of VNF.
35466 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
35469 - name: prov-status
35471 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
35474 - name: heat-stack-id
35476 description: Heat stack id corresponding to this instance, managed by MSO
35479 - name: interface-id
35481 description: ID of interface
35486 description: MAC address for the interface
35489 - name: network-name
35491 description: Name of the network
35494 - name: vlan-id-inner
35496 description: Inner VLAN tag
35502 description: This indicates the customers VPN ID associated with this vlan
35505 - name: vlan-id-inner
35507 description: Inner VLAN tag
35511 - name: neutron-network-id
35513 description: Neutron network id of the interface that address belongs to
35516 - name: neutron-subnet-id
35518 description: Neutron id of subnet that address belongs to
35524 summary: create or update an existing l3-interface-ipv6-address-list
35526 Create or update an existing l3-interface-ipv6-address-list.
35528 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35529 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35538 description: Response codes found in [response codes](https://wiki.onap.org/).
35542 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35545 example: __VNF-ID2__
35546 - name: interface-name
35548 description: Name given to the interface
35551 example: __INTERFACE-NAME__
35552 - name: vlan-interface
35554 description: String that identifies the interface
35557 example: __VLAN-INTERFACE__
35558 - name: l3-interface-ipv6-address
35560 description: IP address
35563 example: __L3-INTERFACE-IPV6-ADDRESS__
35566 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
35569 $ref: "#/definitions/l3-interface-ipv6-address-list"
35573 summary: update an existing l3-interface-ipv6-address-list
35575 Update an existing l3-interface-ipv6-address-list
35577 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35578 The PUT operation will entirely replace an existing object.
35579 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35581 Other differences between PUT and PATCH are:
35583 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35584 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35585 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35586 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35595 description: Response codes found in [response codes](https://wiki.onap.org/).
35599 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35602 example: __VNF-ID2__
35603 - name: interface-name
35605 description: Name given to the interface
35608 example: __INTERFACE-NAME__
35609 - name: vlan-interface
35611 description: String that identifies the interface
35614 example: __VLAN-INTERFACE__
35615 - name: l3-interface-ipv6-address
35617 description: IP address
35620 example: __L3-INTERFACE-IPV6-ADDRESS__
35623 description: l3-interface-ipv6-address-list object that needs to be created or updated.
35626 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
35630 summary: delete an existing l3-interface-ipv6-address-list
35631 description: delete an existing l3-interface-ipv6-address-list
35632 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35641 description: Response codes found in [response codes](https://wiki.onap.org/).
35645 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35648 example: __VNF-ID2__
35649 - name: interface-name
35651 description: Name given to the interface
35654 example: __INTERFACE-NAME__
35655 - name: vlan-interface
35657 description: String that identifies the interface
35660 example: __VLAN-INTERFACE__
35661 - name: l3-interface-ipv6-address
35663 description: IP address
35666 example: __L3-INTERFACE-IPV6-ADDRESS__
35667 - name: resource-version
35669 description: resource-version for concurrency
35672 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
35676 summary: returns vlan
35677 description: returns vlan
35678 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
35684 description: successful operation
35686 $ref: "#/getDefinitions/vlan"
35688 description: Response codes found in [response codes](https://wiki.onap.org/).
35692 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35695 example: __VNF-ID2__
35696 - name: interface-name
35698 description: Name given to the interface
35701 example: __INTERFACE-NAME__
35702 - name: vlan-interface
35704 description: String that identifies the interface
35707 example: __VLAN-INTERFACE__
35710 description: Name of VNF.
35715 description: Alternate name of VNF.
35720 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
35723 - name: prov-status
35725 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
35728 - name: heat-stack-id
35730 description: Heat stack id corresponding to this instance, managed by MSO
35733 - name: interface-id
35735 description: ID of interface
35740 description: MAC address for the interface
35743 - name: network-name
35745 description: Name of the network
35748 - name: vlan-id-inner
35750 description: Inner VLAN tag
35756 description: This indicates the customers VPN ID associated with this vlan
35762 summary: create or update an existing vlan
35764 Create or update an existing vlan.
35766 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35767 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
35776 description: Response codes found in [response codes](https://wiki.onap.org/).
35780 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35783 example: __VNF-ID2__
35784 - name: interface-name
35786 description: Name given to the interface
35789 example: __INTERFACE-NAME__
35790 - name: vlan-interface
35792 description: String that identifies the interface
35795 example: __VLAN-INTERFACE__
35798 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
35801 $ref: "#/definitions/vlan"
35805 summary: update an existing vlan
35807 Update an existing vlan
35809 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35810 The PUT operation will entirely replace an existing object.
35811 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35813 Other differences between PUT and PATCH are:
35815 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35816 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35817 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35818 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
35827 description: Response codes found in [response codes](https://wiki.onap.org/).
35831 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35834 example: __VNF-ID2__
35835 - name: interface-name
35837 description: Name given to the interface
35840 example: __INTERFACE-NAME__
35841 - name: vlan-interface
35843 description: String that identifies the interface
35846 example: __VLAN-INTERFACE__
35849 description: vlan object that needs to be created or updated.
35852 $ref: "#/patchDefinitions/vlan"
35856 summary: delete an existing vlan
35857 description: delete an existing vlan
35858 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
35867 description: Response codes found in [response codes](https://wiki.onap.org/).
35871 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35874 example: __VNF-ID2__
35875 - name: interface-name
35877 description: Name given to the interface
35880 example: __INTERFACE-NAME__
35881 - name: vlan-interface
35883 description: String that identifies the interface
35886 example: __VLAN-INTERFACE__
35887 - name: resource-version
35889 description: resource-version for concurrency
35892 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans:
35896 summary: returns vlans
35897 description: returns vlans
35898 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans
35904 description: successful operation
35906 $ref: "#/getDefinitions/vlans"
35908 description: Response codes found in [response codes](https://wiki.onap.org/).
35912 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35915 example: __VNF-ID2__
35916 - name: interface-name
35918 description: Name given to the interface
35921 example: __INTERFACE-NAME__
35924 description: Name of VNF.
35929 description: Alternate name of VNF.
35934 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
35937 - name: prov-status
35939 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
35942 - name: heat-stack-id
35944 description: Heat stack id corresponding to this instance, managed by MSO
35947 - name: interface-id
35949 description: ID of interface
35954 description: MAC address for the interface
35957 - name: network-name
35959 description: Name of the network
35962 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
35966 summary: see node definition for valid relationships
35967 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
35976 description: Response codes found in [response codes](https://wiki.onap.org/).
35980 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35983 example: __VNF-ID2__
35984 - name: interface-name
35986 description: Name given to the interface
35989 example: __INTERFACE-NAME__
35992 description: PCI ID used to identify the sriov-vf
35995 example: __PCI-ID__
35998 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
36001 $ref: "#/definitions/relationship"
36005 summary: delete an existing relationship
36006 description: delete an existing relationship
36007 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
36016 description: Response codes found in [response codes](https://wiki.onap.org/).
36020 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36023 example: __VNF-ID2__
36024 - name: interface-name
36026 description: Name given to the interface
36029 example: __INTERFACE-NAME__
36032 description: PCI ID used to identify the sriov-vf
36035 example: __PCI-ID__
36036 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
36040 summary: returns sriov-vf
36041 description: returns sriov-vf
36042 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
36048 description: successful operation
36050 $ref: "#/getDefinitions/sriov-vf"
36052 description: Response codes found in [response codes](https://wiki.onap.org/).
36056 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36059 example: __VNF-ID2__
36060 - name: interface-name
36062 description: Name given to the interface
36065 example: __INTERFACE-NAME__
36068 description: PCI ID used to identify the sriov-vf
36071 example: __PCI-ID__
36074 description: Name of VNF.
36079 description: Alternate name of VNF.
36084 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
36087 - name: prov-status
36089 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
36092 - name: heat-stack-id
36094 description: Heat stack id corresponding to this instance, managed by MSO
36097 - name: interface-id
36099 description: ID of interface
36104 description: MAC address for the interface
36107 - name: network-name
36109 description: Name of the network
36112 - name: vf-vlan-filter
36114 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
36117 - name: vf-mac-filter
36119 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
36122 - name: vf-vlan-strip
36124 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
36127 - name: neutron-network-id
36129 description: Neutron network id of the interface
36135 summary: create or update an existing sriov-vf
36137 Create or update an existing sriov-vf.
36139 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36140 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
36149 description: Response codes found in [response codes](https://wiki.onap.org/).
36153 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36156 example: __VNF-ID2__
36157 - name: interface-name
36159 description: Name given to the interface
36162 example: __INTERFACE-NAME__
36165 description: PCI ID used to identify the sriov-vf
36168 example: __PCI-ID__
36171 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
36174 $ref: "#/definitions/sriov-vf"
36178 summary: update an existing sriov-vf
36180 Update an existing sriov-vf
36182 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36183 The PUT operation will entirely replace an existing object.
36184 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36186 Other differences between PUT and PATCH are:
36188 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36189 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36190 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36191 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
36200 description: Response codes found in [response codes](https://wiki.onap.org/).
36204 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36207 example: __VNF-ID2__
36208 - name: interface-name
36210 description: Name given to the interface
36213 example: __INTERFACE-NAME__
36216 description: PCI ID used to identify the sriov-vf
36219 example: __PCI-ID__
36222 description: sriov-vf object that needs to be created or updated.
36225 $ref: "#/patchDefinitions/sriov-vf"
36229 summary: delete an existing sriov-vf
36230 description: delete an existing sriov-vf
36231 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
36240 description: Response codes found in [response codes](https://wiki.onap.org/).
36244 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36247 example: __VNF-ID2__
36248 - name: interface-name
36250 description: Name given to the interface
36253 example: __INTERFACE-NAME__
36256 description: PCI ID used to identify the sriov-vf
36259 example: __PCI-ID__
36260 - name: resource-version
36262 description: resource-version for concurrency
36265 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
36269 summary: returns sriov-vfs
36270 description: returns sriov-vfs
36271 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs
36277 description: successful operation
36279 $ref: "#/getDefinitions/sriov-vfs"
36281 description: Response codes found in [response codes](https://wiki.onap.org/).
36285 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36288 example: __VNF-ID2__
36289 - name: interface-name
36291 description: Name given to the interface
36294 example: __INTERFACE-NAME__
36297 description: Name of VNF.
36302 description: Alternate name of VNF.
36307 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
36310 - name: prov-status
36312 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
36315 - name: heat-stack-id
36317 description: Heat stack id corresponding to this instance, managed by MSO
36320 - name: interface-id
36322 description: ID of interface
36327 description: MAC address for the interface
36330 - name: network-name
36332 description: Name of the network
36335 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
36339 summary: see node definition for valid relationships
36340 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
36349 description: Response codes found in [response codes](https://wiki.onap.org/).
36353 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36356 example: __VNF-ID2__
36357 - name: interface-name
36359 description: Name given to the interface
36362 example: __INTERFACE-NAME__
36365 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterface.json)
36368 $ref: "#/definitions/relationship"
36372 summary: delete an existing relationship
36373 description: delete an existing relationship
36374 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
36383 description: Response codes found in [response codes](https://wiki.onap.org/).
36387 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36390 example: __VNF-ID2__
36391 - name: interface-name
36393 description: Name given to the interface
36396 example: __INTERFACE-NAME__
36397 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
36401 summary: see node definition for valid relationships
36402 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
36411 description: Response codes found in [response codes](https://wiki.onap.org/).
36415 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36418 example: __VNF-ID2__
36419 - name: interface-name
36421 description: Name given to the interface
36424 example: __INTERFACE-NAME__
36425 - name: l3-interface-ipv4-address
36427 description: IP address
36430 example: __L3-INTERFACE-IPV4-ADDRESS__
36433 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
36436 $ref: "#/definitions/relationship"
36440 summary: delete an existing relationship
36441 description: delete an existing relationship
36442 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
36451 description: Response codes found in [response codes](https://wiki.onap.org/).
36455 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36458 example: __VNF-ID2__
36459 - name: interface-name
36461 description: Name given to the interface
36464 example: __INTERFACE-NAME__
36465 - name: l3-interface-ipv4-address
36467 description: IP address
36470 example: __L3-INTERFACE-IPV4-ADDRESS__
36471 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
36475 summary: returns l3-interface-ipv4-address-list
36476 description: returns l3-interface-ipv4-address-list
36477 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36483 description: successful operation
36485 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
36487 description: Response codes found in [response codes](https://wiki.onap.org/).
36491 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36494 example: __VNF-ID2__
36495 - name: interface-name
36497 description: Name given to the interface
36500 example: __INTERFACE-NAME__
36501 - name: l3-interface-ipv4-address
36503 description: IP address
36506 example: __L3-INTERFACE-IPV4-ADDRESS__
36509 description: Name of VNF.
36514 description: Alternate name of VNF.
36519 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
36522 - name: prov-status
36524 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
36527 - name: heat-stack-id
36529 description: Heat stack id corresponding to this instance, managed by MSO
36532 - name: interface-id
36534 description: ID of interface
36539 description: MAC address for the interface
36542 - name: network-name
36544 description: Name of the network
36547 - name: vlan-id-inner
36549 description: Inner VLAN tag
36553 - name: neutron-network-id
36555 description: Neutron network id of the interface that address belongs to
36558 - name: neutron-subnet-id
36560 description: Neutron id of subnet that address belongs to
36566 summary: create or update an existing l3-interface-ipv4-address-list
36568 Create or update an existing l3-interface-ipv4-address-list.
36570 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36571 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36580 description: Response codes found in [response codes](https://wiki.onap.org/).
36584 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36587 example: __VNF-ID2__
36588 - name: interface-name
36590 description: Name given to the interface
36593 example: __INTERFACE-NAME__
36594 - name: l3-interface-ipv4-address
36596 description: IP address
36599 example: __L3-INTERFACE-IPV4-ADDRESS__
36602 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
36605 $ref: "#/definitions/l3-interface-ipv4-address-list"
36609 summary: update an existing l3-interface-ipv4-address-list
36611 Update an existing l3-interface-ipv4-address-list
36613 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36614 The PUT operation will entirely replace an existing object.
36615 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36617 Other differences between PUT and PATCH are:
36619 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36620 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36621 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36622 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36631 description: Response codes found in [response codes](https://wiki.onap.org/).
36635 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36638 example: __VNF-ID2__
36639 - name: interface-name
36641 description: Name given to the interface
36644 example: __INTERFACE-NAME__
36645 - name: l3-interface-ipv4-address
36647 description: IP address
36650 example: __L3-INTERFACE-IPV4-ADDRESS__
36653 description: l3-interface-ipv4-address-list object that needs to be created or updated.
36656 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
36660 summary: delete an existing l3-interface-ipv4-address-list
36661 description: delete an existing l3-interface-ipv4-address-list
36662 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36671 description: Response codes found in [response codes](https://wiki.onap.org/).
36675 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36678 example: __VNF-ID2__
36679 - name: interface-name
36681 description: Name given to the interface
36684 example: __INTERFACE-NAME__
36685 - name: l3-interface-ipv4-address
36687 description: IP address
36690 example: __L3-INTERFACE-IPV4-ADDRESS__
36691 - name: resource-version
36693 description: resource-version for concurrency
36696 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
36700 summary: see node definition for valid relationships
36701 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
36710 description: Response codes found in [response codes](https://wiki.onap.org/).
36714 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36717 example: __VNF-ID2__
36718 - name: interface-name
36720 description: Name given to the interface
36723 example: __INTERFACE-NAME__
36724 - name: l3-interface-ipv6-address
36726 description: IP address
36729 example: __L3-INTERFACE-IPV6-ADDRESS__
36732 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
36735 $ref: "#/definitions/relationship"
36739 summary: delete an existing relationship
36740 description: delete an existing relationship
36741 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
36750 description: Response codes found in [response codes](https://wiki.onap.org/).
36754 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36757 example: __VNF-ID2__
36758 - name: interface-name
36760 description: Name given to the interface
36763 example: __INTERFACE-NAME__
36764 - name: l3-interface-ipv6-address
36766 description: IP address
36769 example: __L3-INTERFACE-IPV6-ADDRESS__
36770 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
36774 summary: returns l3-interface-ipv6-address-list
36775 description: returns l3-interface-ipv6-address-list
36776 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36782 description: successful operation
36784 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
36786 description: Response codes found in [response codes](https://wiki.onap.org/).
36790 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36793 example: __VNF-ID2__
36794 - name: interface-name
36796 description: Name given to the interface
36799 example: __INTERFACE-NAME__
36800 - name: l3-interface-ipv6-address
36802 description: IP address
36805 example: __L3-INTERFACE-IPV6-ADDRESS__
36808 description: Name of VNF.
36813 description: Alternate name of VNF.
36818 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
36821 - name: prov-status
36823 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
36826 - name: heat-stack-id
36828 description: Heat stack id corresponding to this instance, managed by MSO
36831 - name: interface-id
36833 description: ID of interface
36838 description: MAC address for the interface
36841 - name: network-name
36843 description: Name of the network
36846 - name: vlan-id-inner
36848 description: Inner VLAN tag
36852 - name: neutron-network-id
36854 description: Neutron network id of the interface that address belongs to
36857 - name: neutron-subnet-id
36859 description: Neutron id of subnet that address belongs to
36865 summary: create or update an existing l3-interface-ipv6-address-list
36867 Create or update an existing l3-interface-ipv6-address-list.
36869 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36870 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36879 description: Response codes found in [response codes](https://wiki.onap.org/).
36883 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36886 example: __VNF-ID2__
36887 - name: interface-name
36889 description: Name given to the interface
36892 example: __INTERFACE-NAME__
36893 - name: l3-interface-ipv6-address
36895 description: IP address
36898 example: __L3-INTERFACE-IPV6-ADDRESS__
36901 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
36904 $ref: "#/definitions/l3-interface-ipv6-address-list"
36908 summary: update an existing l3-interface-ipv6-address-list
36910 Update an existing l3-interface-ipv6-address-list
36912 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36913 The PUT operation will entirely replace an existing object.
36914 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36916 Other differences between PUT and PATCH are:
36918 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36919 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36920 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36921 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36930 description: Response codes found in [response codes](https://wiki.onap.org/).
36934 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36937 example: __VNF-ID2__
36938 - name: interface-name
36940 description: Name given to the interface
36943 example: __INTERFACE-NAME__
36944 - name: l3-interface-ipv6-address
36946 description: IP address
36949 example: __L3-INTERFACE-IPV6-ADDRESS__
36952 description: l3-interface-ipv6-address-list object that needs to be created or updated.
36955 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
36959 summary: delete an existing l3-interface-ipv6-address-list
36960 description: delete an existing l3-interface-ipv6-address-list
36961 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36970 description: Response codes found in [response codes](https://wiki.onap.org/).
36974 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36977 example: __VNF-ID2__
36978 - name: interface-name
36980 description: Name given to the interface
36983 example: __INTERFACE-NAME__
36984 - name: l3-interface-ipv6-address
36986 description: IP address
36989 example: __L3-INTERFACE-IPV6-ADDRESS__
36990 - name: resource-version
36992 description: resource-version for concurrency
36995 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}:
36999 summary: returns l-interface
37000 description: returns l-interface
37001 operationId: getNetworkNewvcesNewvceLInterfacesLInterface
37007 description: successful operation
37009 $ref: "#/getDefinitions/l-interface"
37011 description: Response codes found in [response codes](https://wiki.onap.org/).
37015 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37018 example: __VNF-ID2__
37019 - name: interface-name
37021 description: Name given to the interface
37024 example: __INTERFACE-NAME__
37027 description: Name of VNF.
37032 description: Alternate name of VNF.
37037 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
37040 - name: prov-status
37042 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
37045 - name: heat-stack-id
37047 description: Heat stack id corresponding to this instance, managed by MSO
37050 - name: interface-id
37052 description: ID of interface
37057 description: MAC address for the interface
37060 - name: network-name
37062 description: Name of the network
37068 summary: create or update an existing l-interface
37070 Create or update an existing l-interface.
37072 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37073 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface
37082 description: Response codes found in [response codes](https://wiki.onap.org/).
37086 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37089 example: __VNF-ID2__
37090 - name: interface-name
37092 description: Name given to the interface
37095 example: __INTERFACE-NAME__
37098 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterface.json)
37101 $ref: "#/definitions/l-interface"
37105 summary: update an existing l-interface
37107 Update an existing l-interface
37109 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37110 The PUT operation will entirely replace an existing object.
37111 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37113 Other differences between PUT and PATCH are:
37115 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37116 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37117 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37118 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterface
37127 description: Response codes found in [response codes](https://wiki.onap.org/).
37131 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37134 example: __VNF-ID2__
37135 - name: interface-name
37137 description: Name given to the interface
37140 example: __INTERFACE-NAME__
37143 description: l-interface object that needs to be created or updated.
37146 $ref: "#/patchDefinitions/l-interface"
37150 summary: delete an existing l-interface
37151 description: delete an existing l-interface
37152 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface
37161 description: Response codes found in [response codes](https://wiki.onap.org/).
37165 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37168 example: __VNF-ID2__
37169 - name: interface-name
37171 description: Name given to the interface
37174 example: __INTERFACE-NAME__
37175 - name: resource-version
37177 description: resource-version for concurrency
37180 /network/newvces/newvce/{vnf-id2}/l-interfaces:
37184 summary: returns l-interfaces
37185 description: returns l-interfaces
37186 operationId: getNetworkNewvcesNewvceLInterfaces
37192 description: successful operation
37194 $ref: "#/getDefinitions/l-interfaces"
37196 description: Response codes found in [response codes](https://wiki.onap.org/).
37200 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37203 example: __VNF-ID2__
37206 description: Name of VNF.
37211 description: Alternate name of VNF.
37216 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
37219 - name: prov-status
37221 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
37224 - name: heat-stack-id
37226 description: Heat stack id corresponding to this instance, managed by MSO
37229 /network/newvces/newvce/{vnf-id2}:
37233 summary: returns newvce
37234 description: returns newvce
37235 operationId: getNetworkNewvcesNewvce
37241 description: successful operation
37243 $ref: "#/getDefinitions/newvce"
37245 description: Response codes found in [response codes](https://wiki.onap.org/).
37249 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37252 example: __VNF-ID2__
37255 description: Name of VNF.
37260 description: Alternate name of VNF.
37265 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
37268 - name: prov-status
37270 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
37273 - name: heat-stack-id
37275 description: Heat stack id corresponding to this instance, managed by MSO
37281 summary: create or update an existing newvce
37283 Create or update an existing newvce.
37285 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37286 operationId: createOrUpdateNetworkNewvcesNewvce
37295 description: Response codes found in [response codes](https://wiki.onap.org/).
37299 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37302 example: __VNF-ID2__
37305 description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvce.json)
37308 $ref: "#/definitions/newvce"
37312 summary: update an existing newvce
37314 Update an existing newvce
37316 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37317 The PUT operation will entirely replace an existing object.
37318 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37320 Other differences between PUT and PATCH are:
37322 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37323 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37324 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37325 operationId: UpdateNetworkNewvcesNewvce
37334 description: Response codes found in [response codes](https://wiki.onap.org/).
37338 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37341 example: __VNF-ID2__
37344 description: newvce object that needs to be created or updated.
37347 $ref: "#/patchDefinitions/newvce"
37351 summary: delete an existing newvce
37352 description: delete an existing newvce
37353 operationId: deleteNetworkNewvcesNewvce
37362 description: Response codes found in [response codes](https://wiki.onap.org/).
37366 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37369 example: __VNF-ID2__
37370 - name: resource-version
37372 description: resource-version for concurrency
37379 summary: returns newvces
37380 description: returns newvces
37381 operationId: getNetworkNewvces
37387 description: successful operation
37389 $ref: "#/getDefinitions/newvces"
37391 description: Response codes found in [response codes](https://wiki.onap.org/).
37392 /network/pnfs/pnf/{pnf-name}/relationship-list/relationship:
37396 summary: see node definition for valid relationships
37397 operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship
37406 description: Response codes found in [response codes](https://wiki.onap.org/).
37410 description: unique name of Physical Network Function.
37413 example: __PNF-NAME__
37416 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnf.json)
37419 $ref: "#/definitions/relationship"
37423 summary: delete an existing relationship
37424 description: delete an existing relationship
37425 operationId: deleteNetworkPnfsPnfRelationshipListRelationship
37434 description: Response codes found in [response codes](https://wiki.onap.org/).
37438 description: unique name of Physical Network Function.
37441 example: __PNF-NAME__
37442 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
37446 summary: see node definition for valid relationships
37447 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
37456 description: Response codes found in [response codes](https://wiki.onap.org/).
37460 description: unique name of Physical Network Function.
37463 example: __PNF-NAME__
37464 - name: interface-name
37466 description: Name that identifies the physical interface
37469 example: __INTERFACE-NAME__
37472 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterface.json)
37475 $ref: "#/definitions/relationship"
37479 summary: delete an existing relationship
37480 description: delete an existing relationship
37481 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
37490 description: Response codes found in [response codes](https://wiki.onap.org/).
37494 description: unique name of Physical Network Function.
37497 example: __PNF-NAME__
37498 - name: interface-name
37500 description: Name that identifies the physical interface
37503 example: __INTERFACE-NAME__
37504 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
37508 summary: see node definition for valid relationships
37509 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
37518 description: Response codes found in [response codes](https://wiki.onap.org/).
37522 description: unique name of Physical Network Function.
37525 example: __PNF-NAME__
37526 - name: interface-name
37528 description: Name that identifies the physical interface
37531 example: __INTERFACE-NAME__
37532 - name: interface-name
37534 description: Name given to the interface
37537 example: __INTERFACE-NAME__
37538 - name: vlan-interface
37540 description: String that identifies the interface
37543 example: __VLAN-INTERFACE__
37546 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
37549 $ref: "#/definitions/relationship"
37553 summary: delete an existing relationship
37554 description: delete an existing relationship
37555 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
37564 description: Response codes found in [response codes](https://wiki.onap.org/).
37568 description: unique name of Physical Network Function.
37571 example: __PNF-NAME__
37572 - name: interface-name
37574 description: Name that identifies the physical interface
37577 example: __INTERFACE-NAME__
37578 - name: interface-name
37580 description: Name given to the interface
37583 example: __INTERFACE-NAME__
37584 - name: vlan-interface
37586 description: String that identifies the interface
37589 example: __VLAN-INTERFACE__
37590 /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:
37594 summary: see node definition for valid relationships
37595 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
37604 description: Response codes found in [response codes](https://wiki.onap.org/).
37608 description: unique name of Physical Network Function.
37611 example: __PNF-NAME__
37612 - name: interface-name
37614 description: Name that identifies the physical interface
37617 example: __INTERFACE-NAME__
37618 - name: interface-name
37620 description: Name given to the interface
37623 example: __INTERFACE-NAME__
37624 - name: vlan-interface
37626 description: String that identifies the interface
37629 example: __VLAN-INTERFACE__
37630 - name: l3-interface-ipv4-address
37632 description: IP address
37635 example: __L3-INTERFACE-IPV4-ADDRESS__
37638 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
37641 $ref: "#/definitions/relationship"
37645 summary: delete an existing relationship
37646 description: delete an existing relationship
37647 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
37656 description: Response codes found in [response codes](https://wiki.onap.org/).
37660 description: unique name of Physical Network Function.
37663 example: __PNF-NAME__
37664 - name: interface-name
37666 description: Name that identifies the physical interface
37669 example: __INTERFACE-NAME__
37670 - name: interface-name
37672 description: Name given to the interface
37675 example: __INTERFACE-NAME__
37676 - name: vlan-interface
37678 description: String that identifies the interface
37681 example: __VLAN-INTERFACE__
37682 - name: l3-interface-ipv4-address
37684 description: IP address
37687 example: __L3-INTERFACE-IPV4-ADDRESS__
37688 /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}:
37692 summary: returns l3-interface-ipv4-address-list
37693 description: returns l3-interface-ipv4-address-list
37694 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37700 description: successful operation
37702 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
37704 description: Response codes found in [response codes](https://wiki.onap.org/).
37708 description: unique name of Physical Network Function.
37711 example: __PNF-NAME__
37712 - name: interface-name
37714 description: Name that identifies the physical interface
37717 example: __INTERFACE-NAME__
37718 - name: interface-name
37720 description: Name given to the interface
37723 example: __INTERFACE-NAME__
37724 - name: vlan-interface
37726 description: String that identifies the interface
37729 example: __VLAN-INTERFACE__
37730 - name: l3-interface-ipv4-address
37732 description: IP address
37735 example: __L3-INTERFACE-IPV4-ADDRESS__
37736 - name: orchestration-status
37738 description: orchestration-status is the status of orchestration on the PNF.
37741 - name: interface-id
37743 description: ID of interface
37748 description: MAC address for the interface
37751 - name: network-name
37753 description: Name of the network
37756 - name: vlan-id-inner
37758 description: Inner VLAN tag
37764 description: This indicates the customers VPN ID associated with this vlan
37767 - name: vlan-id-inner
37769 description: Inner VLAN tag
37773 - name: neutron-network-id
37775 description: Neutron network id of the interface that address belongs to
37778 - name: neutron-subnet-id
37780 description: Neutron id of subnet that address belongs to
37786 summary: create or update an existing l3-interface-ipv4-address-list
37788 Create or update an existing l3-interface-ipv4-address-list.
37790 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37791 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37800 description: Response codes found in [response codes](https://wiki.onap.org/).
37804 description: unique name of Physical Network Function.
37807 example: __PNF-NAME__
37808 - name: interface-name
37810 description: Name that identifies the physical interface
37813 example: __INTERFACE-NAME__
37814 - name: interface-name
37816 description: Name given to the interface
37819 example: __INTERFACE-NAME__
37820 - name: vlan-interface
37822 description: String that identifies the interface
37825 example: __VLAN-INTERFACE__
37826 - name: l3-interface-ipv4-address
37828 description: IP address
37831 example: __L3-INTERFACE-IPV4-ADDRESS__
37834 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
37837 $ref: "#/definitions/l3-interface-ipv4-address-list"
37841 summary: update an existing l3-interface-ipv4-address-list
37843 Update an existing l3-interface-ipv4-address-list
37845 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37846 The PUT operation will entirely replace an existing object.
37847 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37849 Other differences between PUT and PATCH are:
37851 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37852 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37853 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37854 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37863 description: Response codes found in [response codes](https://wiki.onap.org/).
37867 description: unique name of Physical Network Function.
37870 example: __PNF-NAME__
37871 - name: interface-name
37873 description: Name that identifies the physical interface
37876 example: __INTERFACE-NAME__
37877 - name: interface-name
37879 description: Name given to the interface
37882 example: __INTERFACE-NAME__
37883 - name: vlan-interface
37885 description: String that identifies the interface
37888 example: __VLAN-INTERFACE__
37889 - name: l3-interface-ipv4-address
37891 description: IP address
37894 example: __L3-INTERFACE-IPV4-ADDRESS__
37897 description: l3-interface-ipv4-address-list object that needs to be created or updated.
37900 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
37904 summary: delete an existing l3-interface-ipv4-address-list
37905 description: delete an existing l3-interface-ipv4-address-list
37906 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37915 description: Response codes found in [response codes](https://wiki.onap.org/).
37919 description: unique name of Physical Network Function.
37922 example: __PNF-NAME__
37923 - name: interface-name
37925 description: Name that identifies the physical interface
37928 example: __INTERFACE-NAME__
37929 - name: interface-name
37931 description: Name given to the interface
37934 example: __INTERFACE-NAME__
37935 - name: vlan-interface
37937 description: String that identifies the interface
37940 example: __VLAN-INTERFACE__
37941 - name: l3-interface-ipv4-address
37943 description: IP address
37946 example: __L3-INTERFACE-IPV4-ADDRESS__
37947 - name: resource-version
37949 description: resource-version for concurrency
37952 /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:
37956 summary: see node definition for valid relationships
37957 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
37966 description: Response codes found in [response codes](https://wiki.onap.org/).
37970 description: unique name of Physical Network Function.
37973 example: __PNF-NAME__
37974 - name: interface-name
37976 description: Name that identifies the physical interface
37979 example: __INTERFACE-NAME__
37980 - name: interface-name
37982 description: Name given to the interface
37985 example: __INTERFACE-NAME__
37986 - name: vlan-interface
37988 description: String that identifies the interface
37991 example: __VLAN-INTERFACE__
37992 - name: l3-interface-ipv6-address
37994 description: IP address
37997 example: __L3-INTERFACE-IPV6-ADDRESS__
38000 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
38003 $ref: "#/definitions/relationship"
38007 summary: delete an existing relationship
38008 description: delete an existing relationship
38009 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
38018 description: Response codes found in [response codes](https://wiki.onap.org/).
38022 description: unique name of Physical Network Function.
38025 example: __PNF-NAME__
38026 - name: interface-name
38028 description: Name that identifies the physical interface
38031 example: __INTERFACE-NAME__
38032 - name: interface-name
38034 description: Name given to the interface
38037 example: __INTERFACE-NAME__
38038 - name: vlan-interface
38040 description: String that identifies the interface
38043 example: __VLAN-INTERFACE__
38044 - name: l3-interface-ipv6-address
38046 description: IP address
38049 example: __L3-INTERFACE-IPV6-ADDRESS__
38050 /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}:
38054 summary: returns l3-interface-ipv6-address-list
38055 description: returns l3-interface-ipv6-address-list
38056 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38062 description: successful operation
38064 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
38066 description: Response codes found in [response codes](https://wiki.onap.org/).
38070 description: unique name of Physical Network Function.
38073 example: __PNF-NAME__
38074 - name: interface-name
38076 description: Name that identifies the physical interface
38079 example: __INTERFACE-NAME__
38080 - name: interface-name
38082 description: Name given to the interface
38085 example: __INTERFACE-NAME__
38086 - name: vlan-interface
38088 description: String that identifies the interface
38091 example: __VLAN-INTERFACE__
38092 - name: l3-interface-ipv6-address
38094 description: IP address
38097 example: __L3-INTERFACE-IPV6-ADDRESS__
38098 - name: orchestration-status
38100 description: orchestration-status is the status of orchestration on the PNF.
38103 - name: interface-id
38105 description: ID of interface
38110 description: MAC address for the interface
38113 - name: network-name
38115 description: Name of the network
38118 - name: vlan-id-inner
38120 description: Inner VLAN tag
38126 description: This indicates the customers VPN ID associated with this vlan
38129 - name: vlan-id-inner
38131 description: Inner VLAN tag
38135 - name: neutron-network-id
38137 description: Neutron network id of the interface that address belongs to
38140 - name: neutron-subnet-id
38142 description: Neutron id of subnet that address belongs to
38148 summary: create or update an existing l3-interface-ipv6-address-list
38150 Create or update an existing l3-interface-ipv6-address-list.
38152 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38153 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38162 description: Response codes found in [response codes](https://wiki.onap.org/).
38166 description: unique name of Physical Network Function.
38169 example: __PNF-NAME__
38170 - name: interface-name
38172 description: Name that identifies the physical interface
38175 example: __INTERFACE-NAME__
38176 - name: interface-name
38178 description: Name given to the interface
38181 example: __INTERFACE-NAME__
38182 - name: vlan-interface
38184 description: String that identifies the interface
38187 example: __VLAN-INTERFACE__
38188 - name: l3-interface-ipv6-address
38190 description: IP address
38193 example: __L3-INTERFACE-IPV6-ADDRESS__
38196 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
38199 $ref: "#/definitions/l3-interface-ipv6-address-list"
38203 summary: update an existing l3-interface-ipv6-address-list
38205 Update an existing l3-interface-ipv6-address-list
38207 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38208 The PUT operation will entirely replace an existing object.
38209 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38211 Other differences between PUT and PATCH are:
38213 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38214 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38215 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38216 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38225 description: Response codes found in [response codes](https://wiki.onap.org/).
38229 description: unique name of Physical Network Function.
38232 example: __PNF-NAME__
38233 - name: interface-name
38235 description: Name that identifies the physical interface
38238 example: __INTERFACE-NAME__
38239 - name: interface-name
38241 description: Name given to the interface
38244 example: __INTERFACE-NAME__
38245 - name: vlan-interface
38247 description: String that identifies the interface
38250 example: __VLAN-INTERFACE__
38251 - name: l3-interface-ipv6-address
38253 description: IP address
38256 example: __L3-INTERFACE-IPV6-ADDRESS__
38259 description: l3-interface-ipv6-address-list object that needs to be created or updated.
38262 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
38266 summary: delete an existing l3-interface-ipv6-address-list
38267 description: delete an existing l3-interface-ipv6-address-list
38268 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38277 description: Response codes found in [response codes](https://wiki.onap.org/).
38281 description: unique name of Physical Network Function.
38284 example: __PNF-NAME__
38285 - name: interface-name
38287 description: Name that identifies the physical interface
38290 example: __INTERFACE-NAME__
38291 - name: interface-name
38293 description: Name given to the interface
38296 example: __INTERFACE-NAME__
38297 - name: vlan-interface
38299 description: String that identifies the interface
38302 example: __VLAN-INTERFACE__
38303 - name: l3-interface-ipv6-address
38305 description: IP address
38308 example: __L3-INTERFACE-IPV6-ADDRESS__
38309 - name: resource-version
38311 description: resource-version for concurrency
38314 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
38318 summary: returns vlan
38319 description: returns vlan
38320 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
38326 description: successful operation
38328 $ref: "#/getDefinitions/vlan"
38330 description: Response codes found in [response codes](https://wiki.onap.org/).
38334 description: unique name of Physical Network Function.
38337 example: __PNF-NAME__
38338 - name: interface-name
38340 description: Name that identifies the physical interface
38343 example: __INTERFACE-NAME__
38344 - name: interface-name
38346 description: Name given to the interface
38349 example: __INTERFACE-NAME__
38350 - name: vlan-interface
38352 description: String that identifies the interface
38355 example: __VLAN-INTERFACE__
38356 - name: orchestration-status
38358 description: orchestration-status is the status of orchestration on the PNF.
38361 - name: interface-id
38363 description: ID of interface
38368 description: MAC address for the interface
38371 - name: network-name
38373 description: Name of the network
38376 - name: vlan-id-inner
38378 description: Inner VLAN tag
38384 description: This indicates the customers VPN ID associated with this vlan
38390 summary: create or update an existing vlan
38392 Create or update an existing vlan.
38394 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38395 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
38404 description: Response codes found in [response codes](https://wiki.onap.org/).
38408 description: unique name of Physical Network Function.
38411 example: __PNF-NAME__
38412 - name: interface-name
38414 description: Name that identifies the physical interface
38417 example: __INTERFACE-NAME__
38418 - name: interface-name
38420 description: Name given to the interface
38423 example: __INTERFACE-NAME__
38424 - name: vlan-interface
38426 description: String that identifies the interface
38429 example: __VLAN-INTERFACE__
38432 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
38435 $ref: "#/definitions/vlan"
38439 summary: update an existing vlan
38441 Update an existing vlan
38443 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38444 The PUT operation will entirely replace an existing object.
38445 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38447 Other differences between PUT and PATCH are:
38449 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38450 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38451 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38452 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
38461 description: Response codes found in [response codes](https://wiki.onap.org/).
38465 description: unique name of Physical Network Function.
38468 example: __PNF-NAME__
38469 - name: interface-name
38471 description: Name that identifies the physical interface
38474 example: __INTERFACE-NAME__
38475 - name: interface-name
38477 description: Name given to the interface
38480 example: __INTERFACE-NAME__
38481 - name: vlan-interface
38483 description: String that identifies the interface
38486 example: __VLAN-INTERFACE__
38489 description: vlan object that needs to be created or updated.
38492 $ref: "#/patchDefinitions/vlan"
38496 summary: delete an existing vlan
38497 description: delete an existing vlan
38498 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
38507 description: Response codes found in [response codes](https://wiki.onap.org/).
38511 description: unique name of Physical Network Function.
38514 example: __PNF-NAME__
38515 - name: interface-name
38517 description: Name that identifies the physical interface
38520 example: __INTERFACE-NAME__
38521 - name: interface-name
38523 description: Name given to the interface
38526 example: __INTERFACE-NAME__
38527 - name: vlan-interface
38529 description: String that identifies the interface
38532 example: __VLAN-INTERFACE__
38533 - name: resource-version
38535 description: resource-version for concurrency
38538 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
38542 summary: returns vlans
38543 description: returns vlans
38544 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans
38550 description: successful operation
38552 $ref: "#/getDefinitions/vlans"
38554 description: Response codes found in [response codes](https://wiki.onap.org/).
38558 description: unique name of Physical Network Function.
38561 example: __PNF-NAME__
38562 - name: interface-name
38564 description: Name that identifies the physical interface
38567 example: __INTERFACE-NAME__
38568 - name: interface-name
38570 description: Name given to the interface
38573 example: __INTERFACE-NAME__
38574 - name: orchestration-status
38576 description: orchestration-status is the status of orchestration on the PNF.
38579 - name: interface-id
38581 description: ID of interface
38586 description: MAC address for the interface
38589 - name: network-name
38591 description: Name of the network
38594 /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:
38598 summary: see node definition for valid relationships
38599 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
38608 description: Response codes found in [response codes](https://wiki.onap.org/).
38612 description: unique name of Physical Network Function.
38615 example: __PNF-NAME__
38616 - name: interface-name
38618 description: Name that identifies the physical interface
38621 example: __INTERFACE-NAME__
38622 - name: interface-name
38624 description: Name given to the interface
38627 example: __INTERFACE-NAME__
38630 description: PCI ID used to identify the sriov-vf
38633 example: __PCI-ID__
38636 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
38639 $ref: "#/definitions/relationship"
38643 summary: delete an existing relationship
38644 description: delete an existing relationship
38645 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
38654 description: Response codes found in [response codes](https://wiki.onap.org/).
38658 description: unique name of Physical Network Function.
38661 example: __PNF-NAME__
38662 - name: interface-name
38664 description: Name that identifies the physical interface
38667 example: __INTERFACE-NAME__
38668 - name: interface-name
38670 description: Name given to the interface
38673 example: __INTERFACE-NAME__
38676 description: PCI ID used to identify the sriov-vf
38679 example: __PCI-ID__
38680 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
38684 summary: returns sriov-vf
38685 description: returns sriov-vf
38686 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38692 description: successful operation
38694 $ref: "#/getDefinitions/sriov-vf"
38696 description: Response codes found in [response codes](https://wiki.onap.org/).
38700 description: unique name of Physical Network Function.
38703 example: __PNF-NAME__
38704 - name: interface-name
38706 description: Name that identifies the physical interface
38709 example: __INTERFACE-NAME__
38710 - name: interface-name
38712 description: Name given to the interface
38715 example: __INTERFACE-NAME__
38718 description: PCI ID used to identify the sriov-vf
38721 example: __PCI-ID__
38722 - name: orchestration-status
38724 description: orchestration-status is the status of orchestration on the PNF.
38727 - name: interface-id
38729 description: ID of interface
38734 description: MAC address for the interface
38737 - name: network-name
38739 description: Name of the network
38742 - name: vf-vlan-filter
38744 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
38747 - name: vf-mac-filter
38749 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
38752 - name: vf-vlan-strip
38754 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
38757 - name: neutron-network-id
38759 description: Neutron network id of the interface
38765 summary: create or update an existing sriov-vf
38767 Create or update an existing sriov-vf.
38769 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38770 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38779 description: Response codes found in [response codes](https://wiki.onap.org/).
38783 description: unique name of Physical Network Function.
38786 example: __PNF-NAME__
38787 - name: interface-name
38789 description: Name that identifies the physical interface
38792 example: __INTERFACE-NAME__
38793 - name: interface-name
38795 description: Name given to the interface
38798 example: __INTERFACE-NAME__
38801 description: PCI ID used to identify the sriov-vf
38804 example: __PCI-ID__
38807 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
38810 $ref: "#/definitions/sriov-vf"
38814 summary: update an existing sriov-vf
38816 Update an existing sriov-vf
38818 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38819 The PUT operation will entirely replace an existing object.
38820 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38822 Other differences between PUT and PATCH are:
38824 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38825 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38826 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38827 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38836 description: Response codes found in [response codes](https://wiki.onap.org/).
38840 description: unique name of Physical Network Function.
38843 example: __PNF-NAME__
38844 - name: interface-name
38846 description: Name that identifies the physical interface
38849 example: __INTERFACE-NAME__
38850 - name: interface-name
38852 description: Name given to the interface
38855 example: __INTERFACE-NAME__
38858 description: PCI ID used to identify the sriov-vf
38861 example: __PCI-ID__
38864 description: sriov-vf object that needs to be created or updated.
38867 $ref: "#/patchDefinitions/sriov-vf"
38871 summary: delete an existing sriov-vf
38872 description: delete an existing sriov-vf
38873 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38882 description: Response codes found in [response codes](https://wiki.onap.org/).
38886 description: unique name of Physical Network Function.
38889 example: __PNF-NAME__
38890 - name: interface-name
38892 description: Name that identifies the physical interface
38895 example: __INTERFACE-NAME__
38896 - name: interface-name
38898 description: Name given to the interface
38901 example: __INTERFACE-NAME__
38904 description: PCI ID used to identify the sriov-vf
38907 example: __PCI-ID__
38908 - name: resource-version
38910 description: resource-version for concurrency
38913 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
38917 summary: returns sriov-vfs
38918 description: returns sriov-vfs
38919 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
38925 description: successful operation
38927 $ref: "#/getDefinitions/sriov-vfs"
38929 description: Response codes found in [response codes](https://wiki.onap.org/).
38933 description: unique name of Physical Network Function.
38936 example: __PNF-NAME__
38937 - name: interface-name
38939 description: Name that identifies the physical interface
38942 example: __INTERFACE-NAME__
38943 - name: interface-name
38945 description: Name given to the interface
38948 example: __INTERFACE-NAME__
38949 - name: orchestration-status
38951 description: orchestration-status is the status of orchestration on the PNF.
38954 - name: interface-id
38956 description: ID of interface
38961 description: MAC address for the interface
38964 - name: network-name
38966 description: Name of the network
38969 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
38973 summary: see node definition for valid relationships
38974 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
38983 description: Response codes found in [response codes](https://wiki.onap.org/).
38987 description: unique name of Physical Network Function.
38990 example: __PNF-NAME__
38991 - name: interface-name
38993 description: Name that identifies the physical interface
38996 example: __INTERFACE-NAME__
38997 - name: interface-name
38999 description: Name given to the interface
39002 example: __INTERFACE-NAME__
39005 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
39008 $ref: "#/definitions/relationship"
39012 summary: delete an existing relationship
39013 description: delete an existing relationship
39014 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
39023 description: Response codes found in [response codes](https://wiki.onap.org/).
39027 description: unique name of Physical Network Function.
39030 example: __PNF-NAME__
39031 - name: interface-name
39033 description: Name that identifies the physical interface
39036 example: __INTERFACE-NAME__
39037 - name: interface-name
39039 description: Name given to the interface
39042 example: __INTERFACE-NAME__
39043 /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:
39047 summary: see node definition for valid relationships
39048 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
39057 description: Response codes found in [response codes](https://wiki.onap.org/).
39061 description: unique name of Physical Network Function.
39064 example: __PNF-NAME__
39065 - name: interface-name
39067 description: Name that identifies the physical interface
39070 example: __INTERFACE-NAME__
39071 - name: interface-name
39073 description: Name given to the interface
39076 example: __INTERFACE-NAME__
39077 - name: l3-interface-ipv4-address
39079 description: IP address
39082 example: __L3-INTERFACE-IPV4-ADDRESS__
39085 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
39088 $ref: "#/definitions/relationship"
39092 summary: delete an existing relationship
39093 description: delete an existing relationship
39094 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
39103 description: Response codes found in [response codes](https://wiki.onap.org/).
39107 description: unique name of Physical Network Function.
39110 example: __PNF-NAME__
39111 - name: interface-name
39113 description: Name that identifies the physical interface
39116 example: __INTERFACE-NAME__
39117 - name: interface-name
39119 description: Name given to the interface
39122 example: __INTERFACE-NAME__
39123 - name: l3-interface-ipv4-address
39125 description: IP address
39128 example: __L3-INTERFACE-IPV4-ADDRESS__
39129 /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}:
39133 summary: returns l3-interface-ipv4-address-list
39134 description: returns l3-interface-ipv4-address-list
39135 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39141 description: successful operation
39143 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
39145 description: Response codes found in [response codes](https://wiki.onap.org/).
39149 description: unique name of Physical Network Function.
39152 example: __PNF-NAME__
39153 - name: interface-name
39155 description: Name that identifies the physical interface
39158 example: __INTERFACE-NAME__
39159 - name: interface-name
39161 description: Name given to the interface
39164 example: __INTERFACE-NAME__
39165 - name: l3-interface-ipv4-address
39167 description: IP address
39170 example: __L3-INTERFACE-IPV4-ADDRESS__
39171 - name: orchestration-status
39173 description: orchestration-status is the status of orchestration on the PNF.
39176 - name: interface-id
39178 description: ID of interface
39183 description: MAC address for the interface
39186 - name: network-name
39188 description: Name of the network
39191 - name: vlan-id-inner
39193 description: Inner VLAN tag
39197 - name: neutron-network-id
39199 description: Neutron network id of the interface that address belongs to
39202 - name: neutron-subnet-id
39204 description: Neutron id of subnet that address belongs to
39210 summary: create or update an existing l3-interface-ipv4-address-list
39212 Create or update an existing l3-interface-ipv4-address-list.
39214 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39215 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39224 description: Response codes found in [response codes](https://wiki.onap.org/).
39228 description: unique name of Physical Network Function.
39231 example: __PNF-NAME__
39232 - name: interface-name
39234 description: Name that identifies the physical interface
39237 example: __INTERFACE-NAME__
39238 - name: interface-name
39240 description: Name given to the interface
39243 example: __INTERFACE-NAME__
39244 - name: l3-interface-ipv4-address
39246 description: IP address
39249 example: __L3-INTERFACE-IPV4-ADDRESS__
39252 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
39255 $ref: "#/definitions/l3-interface-ipv4-address-list"
39259 summary: update an existing l3-interface-ipv4-address-list
39261 Update an existing l3-interface-ipv4-address-list
39263 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39264 The PUT operation will entirely replace an existing object.
39265 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39267 Other differences between PUT and PATCH are:
39269 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39270 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39271 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39272 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39281 description: Response codes found in [response codes](https://wiki.onap.org/).
39285 description: unique name of Physical Network Function.
39288 example: __PNF-NAME__
39289 - name: interface-name
39291 description: Name that identifies the physical interface
39294 example: __INTERFACE-NAME__
39295 - name: interface-name
39297 description: Name given to the interface
39300 example: __INTERFACE-NAME__
39301 - name: l3-interface-ipv4-address
39303 description: IP address
39306 example: __L3-INTERFACE-IPV4-ADDRESS__
39309 description: l3-interface-ipv4-address-list object that needs to be created or updated.
39312 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
39316 summary: delete an existing l3-interface-ipv4-address-list
39317 description: delete an existing l3-interface-ipv4-address-list
39318 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39327 description: Response codes found in [response codes](https://wiki.onap.org/).
39331 description: unique name of Physical Network Function.
39334 example: __PNF-NAME__
39335 - name: interface-name
39337 description: Name that identifies the physical interface
39340 example: __INTERFACE-NAME__
39341 - name: interface-name
39343 description: Name given to the interface
39346 example: __INTERFACE-NAME__
39347 - name: l3-interface-ipv4-address
39349 description: IP address
39352 example: __L3-INTERFACE-IPV4-ADDRESS__
39353 - name: resource-version
39355 description: resource-version for concurrency
39358 /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:
39362 summary: see node definition for valid relationships
39363 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
39372 description: Response codes found in [response codes](https://wiki.onap.org/).
39376 description: unique name of Physical Network Function.
39379 example: __PNF-NAME__
39380 - name: interface-name
39382 description: Name that identifies the physical interface
39385 example: __INTERFACE-NAME__
39386 - name: interface-name
39388 description: Name given to the interface
39391 example: __INTERFACE-NAME__
39392 - name: l3-interface-ipv6-address
39394 description: IP address
39397 example: __L3-INTERFACE-IPV6-ADDRESS__
39400 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
39403 $ref: "#/definitions/relationship"
39407 summary: delete an existing relationship
39408 description: delete an existing relationship
39409 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
39418 description: Response codes found in [response codes](https://wiki.onap.org/).
39422 description: unique name of Physical Network Function.
39425 example: __PNF-NAME__
39426 - name: interface-name
39428 description: Name that identifies the physical interface
39431 example: __INTERFACE-NAME__
39432 - name: interface-name
39434 description: Name given to the interface
39437 example: __INTERFACE-NAME__
39438 - name: l3-interface-ipv6-address
39440 description: IP address
39443 example: __L3-INTERFACE-IPV6-ADDRESS__
39444 /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}:
39448 summary: returns l3-interface-ipv6-address-list
39449 description: returns l3-interface-ipv6-address-list
39450 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39456 description: successful operation
39458 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
39460 description: Response codes found in [response codes](https://wiki.onap.org/).
39464 description: unique name of Physical Network Function.
39467 example: __PNF-NAME__
39468 - name: interface-name
39470 description: Name that identifies the physical interface
39473 example: __INTERFACE-NAME__
39474 - name: interface-name
39476 description: Name given to the interface
39479 example: __INTERFACE-NAME__
39480 - name: l3-interface-ipv6-address
39482 description: IP address
39485 example: __L3-INTERFACE-IPV6-ADDRESS__
39486 - name: orchestration-status
39488 description: orchestration-status is the status of orchestration on the PNF.
39491 - name: interface-id
39493 description: ID of interface
39498 description: MAC address for the interface
39501 - name: network-name
39503 description: Name of the network
39506 - name: vlan-id-inner
39508 description: Inner VLAN tag
39512 - name: neutron-network-id
39514 description: Neutron network id of the interface that address belongs to
39517 - name: neutron-subnet-id
39519 description: Neutron id of subnet that address belongs to
39525 summary: create or update an existing l3-interface-ipv6-address-list
39527 Create or update an existing l3-interface-ipv6-address-list.
39529 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39530 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39539 description: Response codes found in [response codes](https://wiki.onap.org/).
39543 description: unique name of Physical Network Function.
39546 example: __PNF-NAME__
39547 - name: interface-name
39549 description: Name that identifies the physical interface
39552 example: __INTERFACE-NAME__
39553 - name: interface-name
39555 description: Name given to the interface
39558 example: __INTERFACE-NAME__
39559 - name: l3-interface-ipv6-address
39561 description: IP address
39564 example: __L3-INTERFACE-IPV6-ADDRESS__
39567 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
39570 $ref: "#/definitions/l3-interface-ipv6-address-list"
39574 summary: update an existing l3-interface-ipv6-address-list
39576 Update an existing l3-interface-ipv6-address-list
39578 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39579 The PUT operation will entirely replace an existing object.
39580 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39582 Other differences between PUT and PATCH are:
39584 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39585 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39586 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39587 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39596 description: Response codes found in [response codes](https://wiki.onap.org/).
39600 description: unique name of Physical Network Function.
39603 example: __PNF-NAME__
39604 - name: interface-name
39606 description: Name that identifies the physical interface
39609 example: __INTERFACE-NAME__
39610 - name: interface-name
39612 description: Name given to the interface
39615 example: __INTERFACE-NAME__
39616 - name: l3-interface-ipv6-address
39618 description: IP address
39621 example: __L3-INTERFACE-IPV6-ADDRESS__
39624 description: l3-interface-ipv6-address-list object that needs to be created or updated.
39627 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
39631 summary: delete an existing l3-interface-ipv6-address-list
39632 description: delete an existing l3-interface-ipv6-address-list
39633 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39642 description: Response codes found in [response codes](https://wiki.onap.org/).
39646 description: unique name of Physical Network Function.
39649 example: __PNF-NAME__
39650 - name: interface-name
39652 description: Name that identifies the physical interface
39655 example: __INTERFACE-NAME__
39656 - name: interface-name
39658 description: Name given to the interface
39661 example: __INTERFACE-NAME__
39662 - name: l3-interface-ipv6-address
39664 description: IP address
39667 example: __L3-INTERFACE-IPV6-ADDRESS__
39668 - name: resource-version
39670 description: resource-version for concurrency
39673 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
39677 summary: returns l-interface
39678 description: returns l-interface
39679 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
39685 description: successful operation
39687 $ref: "#/getDefinitions/l-interface"
39689 description: Response codes found in [response codes](https://wiki.onap.org/).
39693 description: unique name of Physical Network Function.
39696 example: __PNF-NAME__
39697 - name: interface-name
39699 description: Name that identifies the physical interface
39702 example: __INTERFACE-NAME__
39703 - name: interface-name
39705 description: Name given to the interface
39708 example: __INTERFACE-NAME__
39709 - name: orchestration-status
39711 description: orchestration-status is the status of orchestration on the PNF.
39714 - name: interface-id
39716 description: ID of interface
39721 description: MAC address for the interface
39724 - name: network-name
39726 description: Name of the network
39732 summary: create or update an existing l-interface
39734 Create or update an existing l-interface.
39736 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39737 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
39746 description: Response codes found in [response codes](https://wiki.onap.org/).
39750 description: unique name of Physical Network Function.
39753 example: __PNF-NAME__
39754 - name: interface-name
39756 description: Name that identifies the physical interface
39759 example: __INTERFACE-NAME__
39760 - name: interface-name
39762 description: Name given to the interface
39765 example: __INTERFACE-NAME__
39768 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
39771 $ref: "#/definitions/l-interface"
39775 summary: update an existing l-interface
39777 Update an existing l-interface
39779 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39780 The PUT operation will entirely replace an existing object.
39781 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39783 Other differences between PUT and PATCH are:
39785 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39786 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39787 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39788 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
39797 description: Response codes found in [response codes](https://wiki.onap.org/).
39801 description: unique name of Physical Network Function.
39804 example: __PNF-NAME__
39805 - name: interface-name
39807 description: Name that identifies the physical interface
39810 example: __INTERFACE-NAME__
39811 - name: interface-name
39813 description: Name given to the interface
39816 example: __INTERFACE-NAME__
39819 description: l-interface object that needs to be created or updated.
39822 $ref: "#/patchDefinitions/l-interface"
39826 summary: delete an existing l-interface
39827 description: delete an existing l-interface
39828 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
39837 description: Response codes found in [response codes](https://wiki.onap.org/).
39841 description: unique name of Physical Network Function.
39844 example: __PNF-NAME__
39845 - name: interface-name
39847 description: Name that identifies the physical interface
39850 example: __INTERFACE-NAME__
39851 - name: interface-name
39853 description: Name given to the interface
39856 example: __INTERFACE-NAME__
39857 - name: resource-version
39859 description: resource-version for concurrency
39862 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
39866 summary: returns l-interfaces
39867 description: returns l-interfaces
39868 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces
39874 description: successful operation
39876 $ref: "#/getDefinitions/l-interfaces"
39878 description: Response codes found in [response codes](https://wiki.onap.org/).
39882 description: unique name of Physical Network Function.
39885 example: __PNF-NAME__
39886 - name: interface-name
39888 description: Name that identifies the physical interface
39891 example: __INTERFACE-NAME__
39892 - name: orchestration-status
39894 description: orchestration-status is the status of orchestration on the PNF.
39897 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}:
39901 summary: returns p-interface
39902 description: returns p-interface
39903 operationId: getNetworkPnfsPnfPInterfacesPInterface
39909 description: successful operation
39911 $ref: "#/getDefinitions/p-interface"
39913 description: Response codes found in [response codes](https://wiki.onap.org/).
39917 description: unique name of Physical Network Function.
39920 example: __PNF-NAME__
39921 - name: interface-name
39923 description: Name that identifies the physical interface
39926 example: __INTERFACE-NAME__
39927 - name: orchestration-status
39929 description: orchestration-status is the status of orchestration on the PNF.
39935 summary: create or update an existing p-interface
39937 Create or update an existing p-interface.
39939 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39940 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterface
39949 description: Response codes found in [response codes](https://wiki.onap.org/).
39953 description: unique name of Physical Network Function.
39956 example: __PNF-NAME__
39957 - name: interface-name
39959 description: Name that identifies the physical interface
39962 example: __INTERFACE-NAME__
39965 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterface.json)
39968 $ref: "#/definitions/p-interface"
39972 summary: update an existing p-interface
39974 Update an existing p-interface
39976 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39977 The PUT operation will entirely replace an existing object.
39978 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39980 Other differences between PUT and PATCH are:
39982 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39983 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39984 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39985 operationId: UpdateNetworkPnfsPnfPInterfacesPInterface
39994 description: Response codes found in [response codes](https://wiki.onap.org/).
39998 description: unique name of Physical Network Function.
40001 example: __PNF-NAME__
40002 - name: interface-name
40004 description: Name that identifies the physical interface
40007 example: __INTERFACE-NAME__
40010 description: p-interface object that needs to be created or updated.
40013 $ref: "#/patchDefinitions/p-interface"
40017 summary: delete an existing p-interface
40018 description: delete an existing p-interface
40019 operationId: deleteNetworkPnfsPnfPInterfacesPInterface
40028 description: Response codes found in [response codes](https://wiki.onap.org/).
40032 description: unique name of Physical Network Function.
40035 example: __PNF-NAME__
40036 - name: interface-name
40038 description: Name that identifies the physical interface
40041 example: __INTERFACE-NAME__
40042 - name: resource-version
40044 description: resource-version for concurrency
40047 /network/pnfs/pnf/{pnf-name}/p-interfaces:
40051 summary: returns p-interfaces
40052 description: returns p-interfaces
40053 operationId: getNetworkPnfsPnfPInterfaces
40059 description: successful operation
40061 $ref: "#/getDefinitions/p-interfaces"
40063 description: Response codes found in [response codes](https://wiki.onap.org/).
40067 description: unique name of Physical Network Function.
40070 example: __PNF-NAME__
40071 - name: orchestration-status
40073 description: orchestration-status is the status of orchestration on the PNF.
40076 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
40080 summary: see node definition for valid relationships
40081 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
40090 description: Response codes found in [response codes](https://wiki.onap.org/).
40094 description: unique name of Physical Network Function.
40097 example: __PNF-NAME__
40098 - name: interface-name
40100 description: Name that identifies the link aggregate interface
40103 example: __INTERFACE-NAME__
40106 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterface.json)
40109 $ref: "#/definitions/relationship"
40113 summary: delete an existing relationship
40114 description: delete an existing relationship
40115 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
40124 description: Response codes found in [response codes](https://wiki.onap.org/).
40128 description: unique name of Physical Network Function.
40131 example: __PNF-NAME__
40132 - name: interface-name
40134 description: Name that identifies the link aggregate interface
40137 example: __INTERFACE-NAME__
40138 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
40142 summary: see node definition for valid relationships
40143 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
40152 description: Response codes found in [response codes](https://wiki.onap.org/).
40156 description: unique name of Physical Network Function.
40159 example: __PNF-NAME__
40160 - name: interface-name
40162 description: Name that identifies the link aggregate interface
40165 example: __INTERFACE-NAME__
40166 - name: interface-name
40168 description: Name given to the interface
40171 example: __INTERFACE-NAME__
40172 - name: vlan-interface
40174 description: String that identifies the interface
40177 example: __VLAN-INTERFACE__
40180 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
40183 $ref: "#/definitions/relationship"
40187 summary: delete an existing relationship
40188 description: delete an existing relationship
40189 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
40198 description: Response codes found in [response codes](https://wiki.onap.org/).
40202 description: unique name of Physical Network Function.
40205 example: __PNF-NAME__
40206 - name: interface-name
40208 description: Name that identifies the link aggregate interface
40211 example: __INTERFACE-NAME__
40212 - name: interface-name
40214 description: Name given to the interface
40217 example: __INTERFACE-NAME__
40218 - name: vlan-interface
40220 description: String that identifies the interface
40223 example: __VLAN-INTERFACE__
40224 /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:
40228 summary: see node definition for valid relationships
40229 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
40238 description: Response codes found in [response codes](https://wiki.onap.org/).
40242 description: unique name of Physical Network Function.
40245 example: __PNF-NAME__
40246 - name: interface-name
40248 description: Name that identifies the link aggregate interface
40251 example: __INTERFACE-NAME__
40252 - name: interface-name
40254 description: Name given to the interface
40257 example: __INTERFACE-NAME__
40258 - name: vlan-interface
40260 description: String that identifies the interface
40263 example: __VLAN-INTERFACE__
40264 - name: l3-interface-ipv4-address
40266 description: IP address
40269 example: __L3-INTERFACE-IPV4-ADDRESS__
40272 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
40275 $ref: "#/definitions/relationship"
40279 summary: delete an existing relationship
40280 description: delete an existing relationship
40281 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
40290 description: Response codes found in [response codes](https://wiki.onap.org/).
40294 description: unique name of Physical Network Function.
40297 example: __PNF-NAME__
40298 - name: interface-name
40300 description: Name that identifies the link aggregate interface
40303 example: __INTERFACE-NAME__
40304 - name: interface-name
40306 description: Name given to the interface
40309 example: __INTERFACE-NAME__
40310 - name: vlan-interface
40312 description: String that identifies the interface
40315 example: __VLAN-INTERFACE__
40316 - name: l3-interface-ipv4-address
40318 description: IP address
40321 example: __L3-INTERFACE-IPV4-ADDRESS__
40322 /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}:
40326 summary: returns l3-interface-ipv4-address-list
40327 description: returns l3-interface-ipv4-address-list
40328 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
40334 description: successful operation
40336 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
40338 description: Response codes found in [response codes](https://wiki.onap.org/).
40342 description: unique name of Physical Network Function.
40345 example: __PNF-NAME__
40346 - name: interface-name
40348 description: Name that identifies the link aggregate interface
40351 example: __INTERFACE-NAME__
40352 - name: interface-name
40354 description: Name given to the interface
40357 example: __INTERFACE-NAME__
40358 - name: vlan-interface
40360 description: String that identifies the interface
40363 example: __VLAN-INTERFACE__
40364 - name: l3-interface-ipv4-address
40366 description: IP address
40369 example: __L3-INTERFACE-IPV4-ADDRESS__
40370 - name: orchestration-status
40372 description: orchestration-status is the status of orchestration on the PNF.
40375 - name: interface-id
40377 description: ID of interface
40382 description: MAC address for the interface
40385 - name: network-name
40387 description: Name of the network
40390 - name: vlan-id-inner
40392 description: Inner VLAN tag
40398 description: This indicates the customers VPN ID associated with this vlan
40401 - name: vlan-id-inner
40403 description: Inner VLAN tag
40407 - name: neutron-network-id
40409 description: Neutron network id of the interface that address belongs to
40412 - name: neutron-subnet-id
40414 description: Neutron id of subnet that address belongs to
40420 summary: create or update an existing l3-interface-ipv4-address-list
40422 Create or update an existing l3-interface-ipv4-address-list.
40424 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40425 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
40434 description: Response codes found in [response codes](https://wiki.onap.org/).
40438 description: unique name of Physical Network Function.
40441 example: __PNF-NAME__
40442 - name: interface-name
40444 description: Name that identifies the link aggregate interface
40447 example: __INTERFACE-NAME__
40448 - name: interface-name
40450 description: Name given to the interface
40453 example: __INTERFACE-NAME__
40454 - name: vlan-interface
40456 description: String that identifies the interface
40459 example: __VLAN-INTERFACE__
40460 - name: l3-interface-ipv4-address
40462 description: IP address
40465 example: __L3-INTERFACE-IPV4-ADDRESS__
40468 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
40471 $ref: "#/definitions/l3-interface-ipv4-address-list"
40475 summary: update an existing l3-interface-ipv4-address-list
40477 Update an existing l3-interface-ipv4-address-list
40479 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40480 The PUT operation will entirely replace an existing object.
40481 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40483 Other differences between PUT and PATCH are:
40485 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40486 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40487 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40488 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
40497 description: Response codes found in [response codes](https://wiki.onap.org/).
40501 description: unique name of Physical Network Function.
40504 example: __PNF-NAME__
40505 - name: interface-name
40507 description: Name that identifies the link aggregate interface
40510 example: __INTERFACE-NAME__
40511 - name: interface-name
40513 description: Name given to the interface
40516 example: __INTERFACE-NAME__
40517 - name: vlan-interface
40519 description: String that identifies the interface
40522 example: __VLAN-INTERFACE__
40523 - name: l3-interface-ipv4-address
40525 description: IP address
40528 example: __L3-INTERFACE-IPV4-ADDRESS__
40531 description: l3-interface-ipv4-address-list object that needs to be created or updated.
40534 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
40538 summary: delete an existing l3-interface-ipv4-address-list
40539 description: delete an existing l3-interface-ipv4-address-list
40540 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
40549 description: Response codes found in [response codes](https://wiki.onap.org/).
40553 description: unique name of Physical Network Function.
40556 example: __PNF-NAME__
40557 - name: interface-name
40559 description: Name that identifies the link aggregate interface
40562 example: __INTERFACE-NAME__
40563 - name: interface-name
40565 description: Name given to the interface
40568 example: __INTERFACE-NAME__
40569 - name: vlan-interface
40571 description: String that identifies the interface
40574 example: __VLAN-INTERFACE__
40575 - name: l3-interface-ipv4-address
40577 description: IP address
40580 example: __L3-INTERFACE-IPV4-ADDRESS__
40581 - name: resource-version
40583 description: resource-version for concurrency
40586 /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:
40590 summary: see node definition for valid relationships
40591 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
40600 description: Response codes found in [response codes](https://wiki.onap.org/).
40604 description: unique name of Physical Network Function.
40607 example: __PNF-NAME__
40608 - name: interface-name
40610 description: Name that identifies the link aggregate interface
40613 example: __INTERFACE-NAME__
40614 - name: interface-name
40616 description: Name given to the interface
40619 example: __INTERFACE-NAME__
40620 - name: vlan-interface
40622 description: String that identifies the interface
40625 example: __VLAN-INTERFACE__
40626 - name: l3-interface-ipv6-address
40628 description: IP address
40631 example: __L3-INTERFACE-IPV6-ADDRESS__
40634 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
40637 $ref: "#/definitions/relationship"
40641 summary: delete an existing relationship
40642 description: delete an existing relationship
40643 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
40652 description: Response codes found in [response codes](https://wiki.onap.org/).
40656 description: unique name of Physical Network Function.
40659 example: __PNF-NAME__
40660 - name: interface-name
40662 description: Name that identifies the link aggregate interface
40665 example: __INTERFACE-NAME__
40666 - name: interface-name
40668 description: Name given to the interface
40671 example: __INTERFACE-NAME__
40672 - name: vlan-interface
40674 description: String that identifies the interface
40677 example: __VLAN-INTERFACE__
40678 - name: l3-interface-ipv6-address
40680 description: IP address
40683 example: __L3-INTERFACE-IPV6-ADDRESS__
40684 /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}:
40688 summary: returns l3-interface-ipv6-address-list
40689 description: returns l3-interface-ipv6-address-list
40690 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
40696 description: successful operation
40698 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
40700 description: Response codes found in [response codes](https://wiki.onap.org/).
40704 description: unique name of Physical Network Function.
40707 example: __PNF-NAME__
40708 - name: interface-name
40710 description: Name that identifies the link aggregate interface
40713 example: __INTERFACE-NAME__
40714 - name: interface-name
40716 description: Name given to the interface
40719 example: __INTERFACE-NAME__
40720 - name: vlan-interface
40722 description: String that identifies the interface
40725 example: __VLAN-INTERFACE__
40726 - name: l3-interface-ipv6-address
40728 description: IP address
40731 example: __L3-INTERFACE-IPV6-ADDRESS__
40732 - name: orchestration-status
40734 description: orchestration-status is the status of orchestration on the PNF.
40737 - name: interface-id
40739 description: ID of interface
40744 description: MAC address for the interface
40747 - name: network-name
40749 description: Name of the network
40752 - name: vlan-id-inner
40754 description: Inner VLAN tag
40760 description: This indicates the customers VPN ID associated with this vlan
40763 - name: vlan-id-inner
40765 description: Inner VLAN tag
40769 - name: neutron-network-id
40771 description: Neutron network id of the interface that address belongs to
40774 - name: neutron-subnet-id
40776 description: Neutron id of subnet that address belongs to
40782 summary: create or update an existing l3-interface-ipv6-address-list
40784 Create or update an existing l3-interface-ipv6-address-list.
40786 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40787 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
40796 description: Response codes found in [response codes](https://wiki.onap.org/).
40800 description: unique name of Physical Network Function.
40803 example: __PNF-NAME__
40804 - name: interface-name
40806 description: Name that identifies the link aggregate interface
40809 example: __INTERFACE-NAME__
40810 - name: interface-name
40812 description: Name given to the interface
40815 example: __INTERFACE-NAME__
40816 - name: vlan-interface
40818 description: String that identifies the interface
40821 example: __VLAN-INTERFACE__
40822 - name: l3-interface-ipv6-address
40824 description: IP address
40827 example: __L3-INTERFACE-IPV6-ADDRESS__
40830 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
40833 $ref: "#/definitions/l3-interface-ipv6-address-list"
40837 summary: update an existing l3-interface-ipv6-address-list
40839 Update an existing l3-interface-ipv6-address-list
40841 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40842 The PUT operation will entirely replace an existing object.
40843 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40845 Other differences between PUT and PATCH are:
40847 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40848 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40849 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40850 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
40859 description: Response codes found in [response codes](https://wiki.onap.org/).
40863 description: unique name of Physical Network Function.
40866 example: __PNF-NAME__
40867 - name: interface-name
40869 description: Name that identifies the link aggregate interface
40872 example: __INTERFACE-NAME__
40873 - name: interface-name
40875 description: Name given to the interface
40878 example: __INTERFACE-NAME__
40879 - name: vlan-interface
40881 description: String that identifies the interface
40884 example: __VLAN-INTERFACE__
40885 - name: l3-interface-ipv6-address
40887 description: IP address
40890 example: __L3-INTERFACE-IPV6-ADDRESS__
40893 description: l3-interface-ipv6-address-list object that needs to be created or updated.
40896 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
40900 summary: delete an existing l3-interface-ipv6-address-list
40901 description: delete an existing l3-interface-ipv6-address-list
40902 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
40911 description: Response codes found in [response codes](https://wiki.onap.org/).
40915 description: unique name of Physical Network Function.
40918 example: __PNF-NAME__
40919 - name: interface-name
40921 description: Name that identifies the link aggregate interface
40924 example: __INTERFACE-NAME__
40925 - name: interface-name
40927 description: Name given to the interface
40930 example: __INTERFACE-NAME__
40931 - name: vlan-interface
40933 description: String that identifies the interface
40936 example: __VLAN-INTERFACE__
40937 - name: l3-interface-ipv6-address
40939 description: IP address
40942 example: __L3-INTERFACE-IPV6-ADDRESS__
40943 - name: resource-version
40945 description: resource-version for concurrency
40948 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
40952 summary: returns vlan
40953 description: returns vlan
40954 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
40960 description: successful operation
40962 $ref: "#/getDefinitions/vlan"
40964 description: Response codes found in [response codes](https://wiki.onap.org/).
40968 description: unique name of Physical Network Function.
40971 example: __PNF-NAME__
40972 - name: interface-name
40974 description: Name that identifies the link aggregate interface
40977 example: __INTERFACE-NAME__
40978 - name: interface-name
40980 description: Name given to the interface
40983 example: __INTERFACE-NAME__
40984 - name: vlan-interface
40986 description: String that identifies the interface
40989 example: __VLAN-INTERFACE__
40990 - name: orchestration-status
40992 description: orchestration-status is the status of orchestration on the PNF.
40995 - name: interface-id
40997 description: ID of interface
41002 description: MAC address for the interface
41005 - name: network-name
41007 description: Name of the network
41010 - name: vlan-id-inner
41012 description: Inner VLAN tag
41018 description: This indicates the customers VPN ID associated with this vlan
41024 summary: create or update an existing vlan
41026 Create or update an existing vlan.
41028 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
41029 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
41038 description: Response codes found in [response codes](https://wiki.onap.org/).
41042 description: unique name of Physical Network Function.
41045 example: __PNF-NAME__
41046 - name: interface-name
41048 description: Name that identifies the link aggregate interface
41051 example: __INTERFACE-NAME__
41052 - name: interface-name
41054 description: Name given to the interface
41057 example: __INTERFACE-NAME__
41058 - name: vlan-interface
41060 description: String that identifies the interface
41063 example: __VLAN-INTERFACE__
41066 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
41069 $ref: "#/definitions/vlan"
41073 summary: update an existing vlan
41075 Update an existing vlan
41077 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41078 The PUT operation will entirely replace an existing object.
41079 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
41081 Other differences between PUT and PATCH are:
41083 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
41084 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41085 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41086 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
41095 description: Response codes found in [response codes](https://wiki.onap.org/).
41099 description: unique name of Physical Network Function.
41102 example: __PNF-NAME__
41103 - name: interface-name
41105 description: Name that identifies the link aggregate interface
41108 example: __INTERFACE-NAME__
41109 - name: interface-name
41111 description: Name given to the interface
41114 example: __INTERFACE-NAME__
41115 - name: vlan-interface
41117 description: String that identifies the interface
41120 example: __VLAN-INTERFACE__
41123 description: vlan object that needs to be created or updated.
41126 $ref: "#/patchDefinitions/vlan"
41130 summary: delete an existing vlan
41131 description: delete an existing vlan
41132 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
41141 description: Response codes found in [response codes](https://wiki.onap.org/).
41145 description: unique name of Physical Network Function.
41148 example: __PNF-NAME__
41149 - name: interface-name
41151 description: Name that identifies the link aggregate interface
41154 example: __INTERFACE-NAME__
41155 - name: interface-name
41157 description: Name given to the interface
41160 example: __INTERFACE-NAME__
41161 - name: vlan-interface
41163 description: String that identifies the interface
41166 example: __VLAN-INTERFACE__
41167 - name: resource-version
41169 description: resource-version for concurrency
41172 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
41176 summary: returns vlans
41177 description: returns vlans
41178 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
41184 description: successful operation
41186 $ref: "#/getDefinitions/vlans"
41188 description: Response codes found in [response codes](https://wiki.onap.org/).
41192 description: unique name of Physical Network Function.
41195 example: __PNF-NAME__
41196 - name: interface-name
41198 description: Name that identifies the link aggregate interface
41201 example: __INTERFACE-NAME__
41202 - name: interface-name
41204 description: Name given to the interface
41207 example: __INTERFACE-NAME__
41208 - name: orchestration-status
41210 description: orchestration-status is the status of orchestration on the PNF.
41213 - name: interface-id
41215 description: ID of interface
41220 description: MAC address for the interface
41223 - name: network-name
41225 description: Name of the network
41228 /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:
41232 summary: see node definition for valid relationships
41233 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
41242 description: Response codes found in [response codes](https://wiki.onap.org/).
41246 description: unique name of Physical Network Function.
41249 example: __PNF-NAME__
41250 - name: interface-name
41252 description: Name that identifies the link aggregate interface
41255 example: __INTERFACE-NAME__
41256 - name: interface-name
41258 description: Name given to the interface
41261 example: __INTERFACE-NAME__
41264 description: PCI ID used to identify the sriov-vf
41267 example: __PCI-ID__
41270 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
41273 $ref: "#/definitions/relationship"
41277 summary: delete an existing relationship
41278 description: delete an existing relationship
41279 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
41288 description: Response codes found in [response codes](https://wiki.onap.org/).
41292 description: unique name of Physical Network Function.
41295 example: __PNF-NAME__
41296 - name: interface-name
41298 description: Name that identifies the link aggregate interface
41301 example: __INTERFACE-NAME__
41302 - name: interface-name
41304 description: Name given to the interface
41307 example: __INTERFACE-NAME__
41310 description: PCI ID used to identify the sriov-vf
41313 example: __PCI-ID__
41314 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
41318 summary: returns sriov-vf
41319 description: returns sriov-vf
41320 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
41326 description: successful operation
41328 $ref: "#/getDefinitions/sriov-vf"
41330 description: Response codes found in [response codes](https://wiki.onap.org/).
41334 description: unique name of Physical Network Function.
41337 example: __PNF-NAME__
41338 - name: interface-name
41340 description: Name that identifies the link aggregate interface
41343 example: __INTERFACE-NAME__
41344 - name: interface-name
41346 description: Name given to the interface
41349 example: __INTERFACE-NAME__
41352 description: PCI ID used to identify the sriov-vf
41355 example: __PCI-ID__
41356 - name: orchestration-status
41358 description: orchestration-status is the status of orchestration on the PNF.
41361 - name: interface-id
41363 description: ID of interface
41368 description: MAC address for the interface
41371 - name: network-name
41373 description: Name of the network
41376 - name: vf-vlan-filter
41378 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
41381 - name: vf-mac-filter
41383 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
41386 - name: vf-vlan-strip
41388 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
41391 - name: neutron-network-id
41393 description: Neutron network id of the interface
41399 summary: create or update an existing sriov-vf
41401 Create or update an existing sriov-vf.
41403 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
41404 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
41413 description: Response codes found in [response codes](https://wiki.onap.org/).
41417 description: unique name of Physical Network Function.
41420 example: __PNF-NAME__
41421 - name: interface-name
41423 description: Name that identifies the link aggregate interface
41426 example: __INTERFACE-NAME__
41427 - name: interface-name
41429 description: Name given to the interface
41432 example: __INTERFACE-NAME__
41435 description: PCI ID used to identify the sriov-vf
41438 example: __PCI-ID__
41441 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
41444 $ref: "#/definitions/sriov-vf"
41448 summary: update an existing sriov-vf
41450 Update an existing sriov-vf
41452 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41453 The PUT operation will entirely replace an existing object.
41454 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
41456 Other differences between PUT and PATCH are:
41458 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
41459 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41460 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41461 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
41470 description: Response codes found in [response codes](https://wiki.onap.org/).
41474 description: unique name of Physical Network Function.
41477 example: __PNF-NAME__
41478 - name: interface-name
41480 description: Name that identifies the link aggregate interface
41483 example: __INTERFACE-NAME__
41484 - name: interface-name
41486 description: Name given to the interface
41489 example: __INTERFACE-NAME__
41492 description: PCI ID used to identify the sriov-vf
41495 example: __PCI-ID__
41498 description: sriov-vf object that needs to be created or updated.
41501 $ref: "#/patchDefinitions/sriov-vf"
41505 summary: delete an existing sriov-vf
41506 description: delete an existing sriov-vf
41507 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
41516 description: Response codes found in [response codes](https://wiki.onap.org/).
41520 description: unique name of Physical Network Function.
41523 example: __PNF-NAME__
41524 - name: interface-name
41526 description: Name that identifies the link aggregate interface
41529 example: __INTERFACE-NAME__
41530 - name: interface-name
41532 description: Name given to the interface
41535 example: __INTERFACE-NAME__
41538 description: PCI ID used to identify the sriov-vf
41541 example: __PCI-ID__
41542 - name: resource-version
41544 description: resource-version for concurrency
41547 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
41551 summary: returns sriov-vfs
41552 description: returns sriov-vfs
41553 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
41559 description: successful operation
41561 $ref: "#/getDefinitions/sriov-vfs"
41563 description: Response codes found in [response codes](https://wiki.onap.org/).
41567 description: unique name of Physical Network Function.
41570 example: __PNF-NAME__
41571 - name: interface-name
41573 description: Name that identifies the link aggregate interface
41576 example: __INTERFACE-NAME__
41577 - name: interface-name
41579 description: Name given to the interface
41582 example: __INTERFACE-NAME__
41583 - name: orchestration-status
41585 description: orchestration-status is the status of orchestration on the PNF.
41588 - name: interface-id
41590 description: ID of interface
41595 description: MAC address for the interface
41598 - name: network-name
41600 description: Name of the network
41603 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
41607 summary: see node definition for valid relationships
41608 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
41617 description: Response codes found in [response codes](https://wiki.onap.org/).
41621 description: unique name of Physical Network Function.
41624 example: __PNF-NAME__
41625 - name: interface-name
41627 description: Name that identifies the link aggregate interface
41630 example: __INTERFACE-NAME__
41631 - name: interface-name
41633 description: Name given to the interface
41636 example: __INTERFACE-NAME__
41639 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
41642 $ref: "#/definitions/relationship"
41646 summary: delete an existing relationship
41647 description: delete an existing relationship
41648 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
41657 description: Response codes found in [response codes](https://wiki.onap.org/).
41661 description: unique name of Physical Network Function.
41664 example: __PNF-NAME__
41665 - name: interface-name
41667 description: Name that identifies the link aggregate interface
41670 example: __INTERFACE-NAME__
41671 - name: interface-name
41673 description: Name given to the interface
41676 example: __INTERFACE-NAME__
41677 /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:
41681 summary: see node definition for valid relationships
41682 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
41691 description: Response codes found in [response codes](https://wiki.onap.org/).
41695 description: unique name of Physical Network Function.
41698 example: __PNF-NAME__
41699 - name: interface-name
41701 description: Name that identifies the link aggregate interface
41704 example: __INTERFACE-NAME__
41705 - name: interface-name
41707 description: Name given to the interface
41710 example: __INTERFACE-NAME__
41711 - name: l3-interface-ipv4-address
41713 description: IP address
41716 example: __L3-INTERFACE-IPV4-ADDRESS__
41719 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
41722 $ref: "#/definitions/relationship"
41726 summary: delete an existing relationship
41727 description: delete an existing relationship
41728 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
41737 description: Response codes found in [response codes](https://wiki.onap.org/).
41741 description: unique name of Physical Network Function.
41744 example: __PNF-NAME__
41745 - name: interface-name
41747 description: Name that identifies the link aggregate interface
41750 example: __INTERFACE-NAME__
41751 - name: interface-name
41753 description: Name given to the interface
41756 example: __INTERFACE-NAME__
41757 - name: l3-interface-ipv4-address
41759 description: IP address
41762 example: __L3-INTERFACE-IPV4-ADDRESS__
41763 /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}:
41767 summary: returns l3-interface-ipv4-address-list
41768 description: returns l3-interface-ipv4-address-list
41769 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
41775 description: successful operation
41777 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
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 link aggregate interface
41792 example: __INTERFACE-NAME__
41793 - name: interface-name
41795 description: Name given to the interface
41798 example: __INTERFACE-NAME__
41799 - name: l3-interface-ipv4-address
41801 description: IP address
41804 example: __L3-INTERFACE-IPV4-ADDRESS__
41805 - name: orchestration-status
41807 description: orchestration-status is the status of orchestration on the PNF.
41810 - name: interface-id
41812 description: ID of interface
41817 description: MAC address for the interface
41820 - name: network-name
41822 description: Name of the network
41825 - name: vlan-id-inner
41827 description: Inner VLAN tag
41831 - name: neutron-network-id
41833 description: Neutron network id of the interface that address belongs to
41836 - name: neutron-subnet-id
41838 description: Neutron id of subnet that address belongs to
41844 summary: create or update an existing l3-interface-ipv4-address-list
41846 Create or update an existing l3-interface-ipv4-address-list.
41848 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
41849 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
41858 description: Response codes found in [response codes](https://wiki.onap.org/).
41862 description: unique name of Physical Network Function.
41865 example: __PNF-NAME__
41866 - name: interface-name
41868 description: Name that identifies the link aggregate interface
41871 example: __INTERFACE-NAME__
41872 - name: interface-name
41874 description: Name given to the interface
41877 example: __INTERFACE-NAME__
41878 - name: l3-interface-ipv4-address
41880 description: IP address
41883 example: __L3-INTERFACE-IPV4-ADDRESS__
41886 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
41889 $ref: "#/definitions/l3-interface-ipv4-address-list"
41893 summary: update an existing l3-interface-ipv4-address-list
41895 Update an existing l3-interface-ipv4-address-list
41897 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41898 The PUT operation will entirely replace an existing object.
41899 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
41901 Other differences between PUT and PATCH are:
41903 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
41904 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41905 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41906 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
41915 description: Response codes found in [response codes](https://wiki.onap.org/).
41919 description: unique name of Physical Network Function.
41922 example: __PNF-NAME__
41923 - name: interface-name
41925 description: Name that identifies the link aggregate interface
41928 example: __INTERFACE-NAME__
41929 - name: interface-name
41931 description: Name given to the interface
41934 example: __INTERFACE-NAME__
41935 - name: l3-interface-ipv4-address
41937 description: IP address
41940 example: __L3-INTERFACE-IPV4-ADDRESS__
41943 description: l3-interface-ipv4-address-list object that needs to be created or updated.
41946 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
41950 summary: delete an existing l3-interface-ipv4-address-list
41951 description: delete an existing l3-interface-ipv4-address-list
41952 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
41961 description: Response codes found in [response codes](https://wiki.onap.org/).
41965 description: unique name of Physical Network Function.
41968 example: __PNF-NAME__
41969 - name: interface-name
41971 description: Name that identifies the link aggregate interface
41974 example: __INTERFACE-NAME__
41975 - name: interface-name
41977 description: Name given to the interface
41980 example: __INTERFACE-NAME__
41981 - name: l3-interface-ipv4-address
41983 description: IP address
41986 example: __L3-INTERFACE-IPV4-ADDRESS__
41987 - name: resource-version
41989 description: resource-version for concurrency
41992 /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:
41996 summary: see node definition for valid relationships
41997 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
42006 description: Response codes found in [response codes](https://wiki.onap.org/).
42010 description: unique name of Physical Network Function.
42013 example: __PNF-NAME__
42014 - name: interface-name
42016 description: Name that identifies the link aggregate interface
42019 example: __INTERFACE-NAME__
42020 - name: interface-name
42022 description: Name given to the interface
42025 example: __INTERFACE-NAME__
42026 - name: l3-interface-ipv6-address
42028 description: IP address
42031 example: __L3-INTERFACE-IPV6-ADDRESS__
42034 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
42037 $ref: "#/definitions/relationship"
42041 summary: delete an existing relationship
42042 description: delete an existing relationship
42043 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
42052 description: Response codes found in [response codes](https://wiki.onap.org/).
42056 description: unique name of Physical Network Function.
42059 example: __PNF-NAME__
42060 - name: interface-name
42062 description: Name that identifies the link aggregate interface
42065 example: __INTERFACE-NAME__
42066 - name: interface-name
42068 description: Name given to the interface
42071 example: __INTERFACE-NAME__
42072 - name: l3-interface-ipv6-address
42074 description: IP address
42077 example: __L3-INTERFACE-IPV6-ADDRESS__
42078 /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}:
42082 summary: returns l3-interface-ipv6-address-list
42083 description: returns l3-interface-ipv6-address-list
42084 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
42090 description: successful operation
42092 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
42094 description: Response codes found in [response codes](https://wiki.onap.org/).
42098 description: unique name of Physical Network Function.
42101 example: __PNF-NAME__
42102 - name: interface-name
42104 description: Name that identifies the link aggregate interface
42107 example: __INTERFACE-NAME__
42108 - name: interface-name
42110 description: Name given to the interface
42113 example: __INTERFACE-NAME__
42114 - name: l3-interface-ipv6-address
42116 description: IP address
42119 example: __L3-INTERFACE-IPV6-ADDRESS__
42120 - name: orchestration-status
42122 description: orchestration-status is the status of orchestration on the PNF.
42125 - name: interface-id
42127 description: ID of interface
42132 description: MAC address for the interface
42135 - name: network-name
42137 description: Name of the network
42140 - name: vlan-id-inner
42142 description: Inner VLAN tag
42146 - name: neutron-network-id
42148 description: Neutron network id of the interface that address belongs to
42151 - name: neutron-subnet-id
42153 description: Neutron id of subnet that address belongs to
42159 summary: create or update an existing l3-interface-ipv6-address-list
42161 Create or update an existing l3-interface-ipv6-address-list.
42163 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
42164 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
42173 description: Response codes found in [response codes](https://wiki.onap.org/).
42177 description: unique name of Physical Network Function.
42180 example: __PNF-NAME__
42181 - name: interface-name
42183 description: Name that identifies the link aggregate interface
42186 example: __INTERFACE-NAME__
42187 - name: interface-name
42189 description: Name given to the interface
42192 example: __INTERFACE-NAME__
42193 - name: l3-interface-ipv6-address
42195 description: IP address
42198 example: __L3-INTERFACE-IPV6-ADDRESS__
42201 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
42204 $ref: "#/definitions/l3-interface-ipv6-address-list"
42208 summary: update an existing l3-interface-ipv6-address-list
42210 Update an existing l3-interface-ipv6-address-list
42212 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42213 The PUT operation will entirely replace an existing object.
42214 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
42216 Other differences between PUT and PATCH are:
42218 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
42219 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42220 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42221 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
42230 description: Response codes found in [response codes](https://wiki.onap.org/).
42234 description: unique name of Physical Network Function.
42237 example: __PNF-NAME__
42238 - name: interface-name
42240 description: Name that identifies the link aggregate interface
42243 example: __INTERFACE-NAME__
42244 - name: interface-name
42246 description: Name given to the interface
42249 example: __INTERFACE-NAME__
42250 - name: l3-interface-ipv6-address
42252 description: IP address
42255 example: __L3-INTERFACE-IPV6-ADDRESS__
42258 description: l3-interface-ipv6-address-list object that needs to be created or updated.
42261 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
42265 summary: delete an existing l3-interface-ipv6-address-list
42266 description: delete an existing l3-interface-ipv6-address-list
42267 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
42276 description: Response codes found in [response codes](https://wiki.onap.org/).
42280 description: unique name of Physical Network Function.
42283 example: __PNF-NAME__
42284 - name: interface-name
42286 description: Name that identifies the link aggregate interface
42289 example: __INTERFACE-NAME__
42290 - name: interface-name
42292 description: Name given to the interface
42295 example: __INTERFACE-NAME__
42296 - name: l3-interface-ipv6-address
42298 description: IP address
42301 example: __L3-INTERFACE-IPV6-ADDRESS__
42302 - name: resource-version
42304 description: resource-version for concurrency
42307 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
42311 summary: returns l-interface
42312 description: returns l-interface
42313 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
42319 description: successful operation
42321 $ref: "#/getDefinitions/l-interface"
42323 description: Response codes found in [response codes](https://wiki.onap.org/).
42327 description: unique name of Physical Network Function.
42330 example: __PNF-NAME__
42331 - name: interface-name
42333 description: Name that identifies the link aggregate interface
42336 example: __INTERFACE-NAME__
42337 - name: interface-name
42339 description: Name given to the interface
42342 example: __INTERFACE-NAME__
42343 - name: orchestration-status
42345 description: orchestration-status is the status of orchestration on the PNF.
42348 - name: interface-id
42350 description: ID of interface
42355 description: MAC address for the interface
42358 - name: network-name
42360 description: Name of the network
42366 summary: create or update an existing l-interface
42368 Create or update an existing l-interface.
42370 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
42371 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
42380 description: Response codes found in [response codes](https://wiki.onap.org/).
42384 description: unique name of Physical Network Function.
42387 example: __PNF-NAME__
42388 - name: interface-name
42390 description: Name that identifies the link aggregate interface
42393 example: __INTERFACE-NAME__
42394 - name: interface-name
42396 description: Name given to the interface
42399 example: __INTERFACE-NAME__
42402 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
42405 $ref: "#/definitions/l-interface"
42409 summary: update an existing l-interface
42411 Update an existing l-interface
42413 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42414 The PUT operation will entirely replace an existing object.
42415 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
42417 Other differences between PUT and PATCH are:
42419 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
42420 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42421 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42422 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
42431 description: Response codes found in [response codes](https://wiki.onap.org/).
42435 description: unique name of Physical Network Function.
42438 example: __PNF-NAME__
42439 - name: interface-name
42441 description: Name that identifies the link aggregate interface
42444 example: __INTERFACE-NAME__
42445 - name: interface-name
42447 description: Name given to the interface
42450 example: __INTERFACE-NAME__
42453 description: l-interface object that needs to be created or updated.
42456 $ref: "#/patchDefinitions/l-interface"
42460 summary: delete an existing l-interface
42461 description: delete an existing l-interface
42462 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
42471 description: Response codes found in [response codes](https://wiki.onap.org/).
42475 description: unique name of Physical Network Function.
42478 example: __PNF-NAME__
42479 - name: interface-name
42481 description: Name that identifies the link aggregate interface
42484 example: __INTERFACE-NAME__
42485 - name: interface-name
42487 description: Name given to the interface
42490 example: __INTERFACE-NAME__
42491 - name: resource-version
42493 description: resource-version for concurrency
42496 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
42500 summary: returns l-interfaces
42501 description: returns l-interfaces
42502 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces
42508 description: successful operation
42510 $ref: "#/getDefinitions/l-interfaces"
42512 description: Response codes found in [response codes](https://wiki.onap.org/).
42516 description: unique name of Physical Network Function.
42519 example: __PNF-NAME__
42520 - name: interface-name
42522 description: Name that identifies the link aggregate interface
42525 example: __INTERFACE-NAME__
42526 - name: orchestration-status
42528 description: orchestration-status is the status of orchestration on the PNF.
42531 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}:
42535 summary: returns lag-interface
42536 description: returns lag-interface
42537 operationId: getNetworkPnfsPnfLagInterfacesLagInterface
42543 description: successful operation
42545 $ref: "#/getDefinitions/lag-interface"
42547 description: Response codes found in [response codes](https://wiki.onap.org/).
42551 description: unique name of Physical Network Function.
42554 example: __PNF-NAME__
42555 - name: interface-name
42557 description: Name that identifies the link aggregate interface
42560 example: __INTERFACE-NAME__
42561 - name: orchestration-status
42563 description: orchestration-status is the status of orchestration on the PNF.
42569 summary: create or update an existing lag-interface
42571 Create or update an existing lag-interface.
42573 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
42574 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface
42583 description: Response codes found in [response codes](https://wiki.onap.org/).
42587 description: unique name of Physical Network Function.
42590 example: __PNF-NAME__
42591 - name: interface-name
42593 description: Name that identifies the link aggregate interface
42596 example: __INTERFACE-NAME__
42599 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterface.json)
42602 $ref: "#/definitions/lag-interface"
42606 summary: update an existing lag-interface
42608 Update an existing lag-interface
42610 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42611 The PUT operation will entirely replace an existing object.
42612 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
42614 Other differences between PUT and PATCH are:
42616 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
42617 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42618 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42619 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterface
42628 description: Response codes found in [response codes](https://wiki.onap.org/).
42632 description: unique name of Physical Network Function.
42635 example: __PNF-NAME__
42636 - name: interface-name
42638 description: Name that identifies the link aggregate interface
42641 example: __INTERFACE-NAME__
42644 description: lag-interface object that needs to be created or updated.
42647 $ref: "#/patchDefinitions/lag-interface"
42651 summary: delete an existing lag-interface
42652 description: delete an existing lag-interface
42653 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface
42662 description: Response codes found in [response codes](https://wiki.onap.org/).
42666 description: unique name of Physical Network Function.
42669 example: __PNF-NAME__
42670 - name: interface-name
42672 description: Name that identifies the link aggregate interface
42675 example: __INTERFACE-NAME__
42676 - name: resource-version
42678 description: resource-version for concurrency
42681 /network/pnfs/pnf/{pnf-name}/lag-interfaces:
42685 summary: returns lag-interfaces
42686 description: returns lag-interfaces
42687 operationId: getNetworkPnfsPnfLagInterfaces
42693 description: successful operation
42695 $ref: "#/getDefinitions/lag-interfaces"
42697 description: Response codes found in [response codes](https://wiki.onap.org/).
42701 description: unique name of Physical Network Function.
42704 example: __PNF-NAME__
42705 - name: orchestration-status
42707 description: orchestration-status is the status of orchestration on the PNF.
42710 /network/pnfs/pnf/{pnf-name}:
42714 summary: returns pnf
42715 description: returns pnf
42716 operationId: getNetworkPnfsPnf
42722 description: successful operation
42724 $ref: "#/getDefinitions/pnf"
42726 description: Response codes found in [response codes](https://wiki.onap.org/).
42730 description: unique name of Physical Network Function.
42733 example: __PNF-NAME__
42734 - name: orchestration-status
42736 description: orchestration-status is the status of orchestration on the PNF.
42742 summary: create or update an existing pnf
42744 Create or update an existing pnf.
42746 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
42747 operationId: createOrUpdateNetworkPnfsPnf
42756 description: Response codes found in [response codes](https://wiki.onap.org/).
42760 description: unique name of Physical Network Function.
42763 example: __PNF-NAME__
42766 description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnf.json)
42769 $ref: "#/definitions/pnf"
42773 summary: update an existing pnf
42775 Update an existing pnf
42777 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42778 The PUT operation will entirely replace an existing object.
42779 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
42781 Other differences between PUT and PATCH are:
42783 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
42784 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42785 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42786 operationId: UpdateNetworkPnfsPnf
42795 description: Response codes found in [response codes](https://wiki.onap.org/).
42799 description: unique name of Physical Network Function.
42802 example: __PNF-NAME__
42805 description: pnf object that needs to be created or updated.
42808 $ref: "#/patchDefinitions/pnf"
42812 summary: delete an existing pnf
42813 description: delete an existing pnf
42814 operationId: deleteNetworkPnfsPnf
42823 description: Response codes found in [response codes](https://wiki.onap.org/).
42827 description: unique name of Physical Network Function.
42830 example: __PNF-NAME__
42831 - name: resource-version
42833 description: resource-version for concurrency
42840 summary: returns pnfs
42841 description: returns pnfs
42842 operationId: getNetworkPnfs
42848 description: successful operation
42850 $ref: "#/getDefinitions/pnfs"
42852 description: Response codes found in [response codes](https://wiki.onap.org/).
42853 /network/physical-links/physical-link/{link-name}/relationship-list/relationship:
42857 summary: see node definition for valid relationships
42858 operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
42867 description: Response codes found in [response codes](https://wiki.onap.org/).
42871 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
42874 example: __LINK-NAME__
42877 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPhysicalLinksPhysicalLink.json)
42880 $ref: "#/definitions/relationship"
42884 summary: delete an existing relationship
42885 description: delete an existing relationship
42886 operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
42895 description: Response codes found in [response codes](https://wiki.onap.org/).
42899 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
42902 example: __LINK-NAME__
42903 /network/physical-links/physical-link/{link-name}:
42907 summary: returns physical-link
42908 description: returns physical-link
42909 operationId: getNetworkPhysicalLinksPhysicalLink
42915 description: successful operation
42917 $ref: "#/getDefinitions/physical-link"
42919 description: Response codes found in [response codes](https://wiki.onap.org/).
42923 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
42926 example: __LINK-NAME__
42929 description: Circuit it
42935 summary: create or update an existing physical-link
42937 Create or update an existing physical-link.
42939 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
42940 operationId: createOrUpdateNetworkPhysicalLinksPhysicalLink
42949 description: Response codes found in [response codes](https://wiki.onap.org/).
42953 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
42956 example: __LINK-NAME__
42959 description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPhysicalLinksPhysicalLink.json)
42962 $ref: "#/definitions/physical-link"
42966 summary: update an existing physical-link
42968 Update an existing physical-link
42970 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42971 The PUT operation will entirely replace an existing object.
42972 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
42974 Other differences between PUT and PATCH are:
42976 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
42977 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42978 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42979 operationId: UpdateNetworkPhysicalLinksPhysicalLink
42988 description: Response codes found in [response codes](https://wiki.onap.org/).
42992 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
42995 example: __LINK-NAME__
42998 description: physical-link object that needs to be created or updated.
43001 $ref: "#/patchDefinitions/physical-link"
43005 summary: delete an existing physical-link
43006 description: delete an existing physical-link
43007 operationId: deleteNetworkPhysicalLinksPhysicalLink
43016 description: Response codes found in [response codes](https://wiki.onap.org/).
43020 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
43023 example: __LINK-NAME__
43024 - name: resource-version
43026 description: resource-version for concurrency
43029 /network/physical-links:
43033 summary: returns physical-links
43034 description: returns physical-links
43035 operationId: getNetworkPhysicalLinks
43041 description: successful operation
43043 $ref: "#/getDefinitions/physical-links"
43045 description: Response codes found in [response codes](https://wiki.onap.org/).
43046 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship:
43050 summary: see node definition for valid relationships
43051 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
43060 description: Response codes found in [response codes](https://wiki.onap.org/).
43062 - name: ipsec-configuration-id
43064 description: UUID of this configuration
43067 example: __IPSEC-CONFIGURATION-ID__
43070 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkIpsecConfigurationsIpsecConfiguration.json)
43073 $ref: "#/definitions/relationship"
43077 summary: delete an existing relationship
43078 description: delete an existing relationship
43079 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
43088 description: Response codes found in [response codes](https://wiki.onap.org/).
43090 - name: ipsec-configuration-id
43092 description: UUID of this configuration
43095 example: __IPSEC-CONFIGURATION-ID__
43096 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship:
43100 summary: see node definition for valid relationships
43101 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
43110 description: Response codes found in [response codes](https://wiki.onap.org/).
43112 - name: ipsec-configuration-id
43114 description: UUID of this configuration
43117 example: __IPSEC-CONFIGURATION-ID__
43118 - name: vig-address-type
43120 description: indicates whether the VIG is for AVPN or INTERNET
43123 example: __VIG-ADDRESS-TYPE__
43126 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
43129 $ref: "#/definitions/relationship"
43133 summary: delete an existing relationship
43134 description: delete an existing relationship
43135 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
43144 description: Response codes found in [response codes](https://wiki.onap.org/).
43146 - name: ipsec-configuration-id
43148 description: UUID of this configuration
43151 example: __IPSEC-CONFIGURATION-ID__
43152 - name: vig-address-type
43154 description: indicates whether the VIG is for AVPN or INTERNET
43157 example: __VIG-ADDRESS-TYPE__
43158 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}:
43162 summary: returns vig-server
43163 description: returns vig-server
43164 operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
43170 description: successful operation
43172 $ref: "#/getDefinitions/vig-server"
43174 description: Response codes found in [response codes](https://wiki.onap.org/).
43176 - name: ipsec-configuration-id
43178 description: UUID of this configuration
43181 example: __IPSEC-CONFIGURATION-ID__
43182 - name: vig-address-type
43184 description: indicates whether the VIG is for AVPN or INTERNET
43187 example: __VIG-ADDRESS-TYPE__
43191 summary: create or update an existing vig-server
43193 Create or update an existing vig-server.
43195 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
43196 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
43205 description: Response codes found in [response codes](https://wiki.onap.org/).
43207 - name: ipsec-configuration-id
43209 description: UUID of this configuration
43212 example: __IPSEC-CONFIGURATION-ID__
43213 - name: vig-address-type
43215 description: indicates whether the VIG is for AVPN or INTERNET
43218 example: __VIG-ADDRESS-TYPE__
43221 description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
43224 $ref: "#/definitions/vig-server"
43228 summary: update an existing vig-server
43230 Update an existing vig-server
43232 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43233 The PUT operation will entirely replace an existing object.
43234 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
43236 Other differences between PUT and PATCH are:
43238 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
43239 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43240 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43241 operationId: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
43250 description: Response codes found in [response codes](https://wiki.onap.org/).
43252 - name: ipsec-configuration-id
43254 description: UUID of this configuration
43257 example: __IPSEC-CONFIGURATION-ID__
43258 - name: vig-address-type
43260 description: indicates whether the VIG is for AVPN or INTERNET
43263 example: __VIG-ADDRESS-TYPE__
43266 description: vig-server object that needs to be created or updated.
43269 $ref: "#/patchDefinitions/vig-server"
43273 summary: delete an existing vig-server
43274 description: delete an existing vig-server
43275 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
43284 description: Response codes found in [response codes](https://wiki.onap.org/).
43286 - name: ipsec-configuration-id
43288 description: UUID of this configuration
43291 example: __IPSEC-CONFIGURATION-ID__
43292 - name: vig-address-type
43294 description: indicates whether the VIG is for AVPN or INTERNET
43297 example: __VIG-ADDRESS-TYPE__
43298 - name: resource-version
43300 description: resource-version for concurrency
43303 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers:
43307 summary: returns vig-servers
43308 description: returns vig-servers
43309 operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers
43315 description: successful operation
43317 $ref: "#/getDefinitions/vig-servers"
43319 description: Response codes found in [response codes](https://wiki.onap.org/).
43321 - name: ipsec-configuration-id
43323 description: UUID of this configuration
43326 example: __IPSEC-CONFIGURATION-ID__
43327 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}:
43331 summary: returns ipsec-configuration
43332 description: returns ipsec-configuration
43333 operationId: getNetworkIpsecConfigurationsIpsecConfiguration
43339 description: successful operation
43341 $ref: "#/getDefinitions/ipsec-configuration"
43343 description: Response codes found in [response codes](https://wiki.onap.org/).
43345 - name: ipsec-configuration-id
43347 description: UUID of this configuration
43350 example: __IPSEC-CONFIGURATION-ID__
43354 summary: create or update an existing ipsec-configuration
43356 Create or update an existing ipsec-configuration.
43358 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
43359 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration
43368 description: Response codes found in [response codes](https://wiki.onap.org/).
43370 - name: ipsec-configuration-id
43372 description: UUID of this configuration
43375 example: __IPSEC-CONFIGURATION-ID__
43378 description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkIpsecConfigurationsIpsecConfiguration.json)
43381 $ref: "#/definitions/ipsec-configuration"
43385 summary: update an existing ipsec-configuration
43387 Update an existing ipsec-configuration
43389 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43390 The PUT operation will entirely replace an existing object.
43391 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
43393 Other differences between PUT and PATCH are:
43395 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
43396 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43397 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43398 operationId: UpdateNetworkIpsecConfigurationsIpsecConfiguration
43407 description: Response codes found in [response codes](https://wiki.onap.org/).
43409 - name: ipsec-configuration-id
43411 description: UUID of this configuration
43414 example: __IPSEC-CONFIGURATION-ID__
43417 description: ipsec-configuration object that needs to be created or updated.
43420 $ref: "#/patchDefinitions/ipsec-configuration"
43424 summary: delete an existing ipsec-configuration
43425 description: delete an existing ipsec-configuration
43426 operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration
43435 description: Response codes found in [response codes](https://wiki.onap.org/).
43437 - name: ipsec-configuration-id
43439 description: UUID of this configuration
43442 example: __IPSEC-CONFIGURATION-ID__
43443 - name: resource-version
43445 description: resource-version for concurrency
43448 /network/ipsec-configurations:
43452 summary: returns ipsec-configurations
43453 description: returns ipsec-configurations
43454 operationId: getNetworkIpsecConfigurations
43460 description: successful operation
43462 $ref: "#/getDefinitions/ipsec-configurations"
43464 description: Response codes found in [response codes](https://wiki.onap.org/).
43465 /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship:
43469 summary: see node definition for valid relationships
43470 operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
43479 description: Response codes found in [response codes](https://wiki.onap.org/).
43481 - name: route-table-reference-id
43483 description: Route Table Reference id, UUID assigned to this instance.
43486 example: __ROUTE-TABLE-REFERENCE-ID__
43489 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkRouteTableReferencesRouteTableReference.json)
43492 $ref: "#/definitions/relationship"
43496 summary: delete an existing relationship
43497 description: delete an existing relationship
43498 operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
43507 description: Response codes found in [response codes](https://wiki.onap.org/).
43509 - name: route-table-reference-id
43511 description: Route Table Reference id, UUID assigned to this instance.
43514 example: __ROUTE-TABLE-REFERENCE-ID__
43515 /network/route-table-references/route-table-reference/{route-table-reference-id}:
43519 summary: returns route-table-reference
43520 description: returns route-table-reference
43521 operationId: getNetworkRouteTableReferencesRouteTableReference
43527 description: successful operation
43529 $ref: "#/getDefinitions/route-table-reference"
43531 description: Response codes found in [response codes](https://wiki.onap.org/).
43533 - name: route-table-reference-id
43535 description: Route Table Reference id, UUID assigned to this instance.
43538 example: __ROUTE-TABLE-REFERENCE-ID__
43539 - name: route-table-reference-fqdn
43541 description: FQDN entry in the route table.
43547 summary: create or update an existing route-table-reference
43549 Create or update an existing route-table-reference.
43551 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
43552 operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference
43561 description: Response codes found in [response codes](https://wiki.onap.org/).
43563 - name: route-table-reference-id
43565 description: Route Table Reference id, UUID assigned to this instance.
43568 example: __ROUTE-TABLE-REFERENCE-ID__
43571 description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkRouteTableReferencesRouteTableReference.json)
43574 $ref: "#/definitions/route-table-reference"
43578 summary: update an existing route-table-reference
43580 Update an existing route-table-reference
43582 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43583 The PUT operation will entirely replace an existing object.
43584 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
43586 Other differences between PUT and PATCH are:
43588 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
43589 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43590 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43591 operationId: UpdateNetworkRouteTableReferencesRouteTableReference
43600 description: Response codes found in [response codes](https://wiki.onap.org/).
43602 - name: route-table-reference-id
43604 description: Route Table Reference id, UUID assigned to this instance.
43607 example: __ROUTE-TABLE-REFERENCE-ID__
43610 description: route-table-reference object that needs to be created or updated.
43613 $ref: "#/patchDefinitions/route-table-reference"
43617 summary: delete an existing route-table-reference
43618 description: delete an existing route-table-reference
43619 operationId: deleteNetworkRouteTableReferencesRouteTableReference
43628 description: Response codes found in [response codes](https://wiki.onap.org/).
43630 - name: route-table-reference-id
43632 description: Route Table Reference id, UUID assigned to this instance.
43635 example: __ROUTE-TABLE-REFERENCE-ID__
43636 - name: resource-version
43638 description: resource-version for concurrency
43641 /network/route-table-references:
43645 summary: returns route-table-references
43646 description: returns route-table-references
43647 operationId: getNetworkRouteTableReferences
43653 description: successful operation
43655 $ref: "#/getDefinitions/route-table-references"
43657 description: Response codes found in [response codes](https://wiki.onap.org/).
43672 $ref: "#/definitions/action-data"
43681 APIs that are more action related than REST (e.g., notify, update).
43685 $ref: "#/definitions/update"
43688 $ref: "#/definitions/notify"
43691 Represents a slice or partial piece of a resource that gets separately allotted
43692 ###### Related Nodes
43693 - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
43694 - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
43695 - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
43696 - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
43697 - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
43698 - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
43699 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
43700 - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
43706 description: Allotted Resource id UUID assigned to this instance.
43709 description: The descriptive information assigned to this allotted resource instance
43712 description: Link back to more information in the controller
43715 description: the ASDC model id for this resource or service model.
43716 persona-model-version:
43718 description: the ASDC model version for this resource or service model.
43721 description: the ASDC model version for this resource or service model.
43722 persona-model-customization-id:
43724 description: captures the id of all the configuration used to customize the resource for the service.
43727 description: Concurrency value
43731 $ref: "#/definitions/tunnel-xconnect"
43735 $ref: "#/definitions/relationship"
43736 allotted-resources:
43738 This object is used to store slices of services being offered
43743 $ref: "#/definitions/allotted-resource"
43746 Availability zone, a collection of compute hosts/pservers
43747 ###### Related Nodes
43748 - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
43749 - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
43750 - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
43751 - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
43752 - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
43753 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
43754 - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
43755 - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
43756 - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
43758 - availability-zone-name
43761 availability-zone-name:
43763 description: Name of the availability zone. Unique across a cloud region
43766 description: Type of hypervisor. Source of truth should define valid values.
43769 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
43772 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43776 $ref: "#/definitions/relationship"
43777 availability-zones:
43779 Collection of availability zones
43784 $ref: "#/definitions/availability-zone"
43785 az-and-dvs-switches:
43789 $ref: "#/definitions/dvs-switches"
43792 $ref: "#/definitions/availability-zone"
43795 Namespace for business related constructs
43800 $ref: "#/definitions/connector"
43804 $ref: "#/definitions/customer"
43807 ###### Related Nodes
43808 - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
43814 description: unique identifier of probe
43817 description: identifier of probe
43820 description: type of probe
43823 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43827 $ref: "#/definitions/relationship"
43828 classes-of-service:
43830 class-of-service of probe
43835 $ref: "#/definitions/class-of-service"
43836 cloud-infrastructure:
43838 Namespace for cloud infrastructure.
43843 $ref: "#/definitions/complex"
43847 $ref: "#/definitions/cloud-region"
43851 $ref: "#/definitions/network-profile"
43855 $ref: "#/definitions/pserver"
43856 virtual-data-centers:
43859 $ref: "#/definitions/virtual-data-center"
43862 cloud-region designates an installation of a cloud cluster or region or instantiation.
43863 ###### Related Nodes
43864 - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
43865 - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
43866 - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
43867 - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
43868 - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
43869 - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
43870 - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
43871 - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
43872 - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
43873 - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
43874 - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
43875 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
43876 - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
43877 - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
43884 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
43887 description: Identifier used by the vendor for the region. Second part of composite key
43890 description: Type of the cloud (e.g., openstack)
43891 owner-defined-type:
43893 description: Cloud-owner defined type indicator (e.g., DCP, LCP)
43894 cloud-region-version:
43896 description: Software version employed at the site
43899 description: URL of the keystone identity service
43902 description: Zone where the cloud is homed
43905 description: complex name for cloud-region instance
43908 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43912 $ref: "#/definitions/volume-group"
43916 $ref: "#/definitions/tenant"
43920 $ref: "#/definitions/flavor"
43924 $ref: "#/definitions/group-assignment"
43928 $ref: "#/definitions/snapshot"
43932 $ref: "#/definitions/image"
43936 $ref: "#/definitions/dvs-switch"
43940 $ref: "#/definitions/oam-network"
43941 availability-zones:
43944 $ref: "#/definitions/availability-zone"
43948 $ref: "#/definitions/relationship"
43954 $ref: "#/definitions/cloud-region"
43957 Collection of physical locations that can house cloud-regions.
43958 ###### Related Nodes
43959 - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
43960 - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
43961 - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
43962 - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
43963 - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
43964 - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
43965 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
43966 - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
43967 - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
43968 - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
43969 - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE
43970 - COMPLEX is DELETED when these are DELETED CTAG-POOL
43972 - physical-location-id
43973 - physical-location-type
43980 physical-location-id:
43982 description: Unique identifier for physical location, e.g., CLLI
43985 description: Data center code which can be an alternate way to identify a complex
43988 description: Gamma complex name for LCP instance.
43991 description: URL of the keystone identity service
43994 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
43995 physical-location-type:
43997 description: Type, e.g., central office, data center.
44023 $ref: "#/definitions/ctag-pool"
44027 $ref: "#/definitions/relationship"
44030 Collection of physical locations that can house cloud-regions.
44035 $ref: "#/definitions/complex"
44038 Port Mirror Configuration.
44039 ###### Related Nodes
44040 - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
44041 - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
44042 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
44043 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
44044 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
44045 - CONFIGURATION is DELETED when these are DELETED METADATUM
44046 - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
44049 - configuration-type
44050 - configuration-sub-type
44051 - orchestration-status
44052 - operational-status
44053 - configuration-selflink
44054 - model-customization-id
44058 description: UUID assigned to configuration.
44061 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
44062 configuration-name:
44064 description: Name of the configuration.
44065 configuration-type:
44067 description: port-mirroring-configuration.
44068 configuration-sub-type:
44070 description: vprobe, pprobe.
44071 model-invariant-id:
44073 description: the ASDC model id for this resource or service model.
44076 description: the ASDC model version for this resource or service model.
44077 orchestration-status:
44079 description: Orchestration status of the configuration.
44080 operational-status:
44082 description: Indicator for whether the resource is considered operational.
44083 configuration-selflink:
44085 description: URL to endpoint where AAI can get more details from SDN-GC.
44086 model-customization-id:
44088 description: id of the configuration used to customize the resource
44091 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44095 $ref: "#/definitions/relationship"
44099 $ref: "#/definitions/metadatum"
44102 Collection of configurations
44107 $ref: "#/definitions/configuration"
44110 Collection of resource instances used to connect a variety of disparate inventory widgets
44111 ###### Related Nodes
44112 - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
44113 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
44114 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
44115 - CONNECTOR is DELETED when these are DELETED METADATUM
44117 - resource-instance-id
44119 resource-instance-id:
44121 description: Unique id of resource instance.
44124 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44127 description: the ASDC model id for this resource or service model.
44128 persona-model-version:
44130 description: the ASDC model version for this resource or service model.
44133 description: the ASDC model version for this resource or service model.
44136 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
44137 widget-model-version:
44139 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
44143 $ref: "#/definitions/relationship"
44147 $ref: "#/definitions/metadatum"
44150 Collection of resource instances used to connect a variety of disparate inventory widgets
44155 $ref: "#/definitions/connector"
44156 constrained-element-set:
44158 This is how we would capture constraints defining allowed sets of elements.
44159 ###### Related Nodes
44160 - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
44161 - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
44162 - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
44163 - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
44165 - constrained-element-set-uuid
44169 constrained-element-set-uuid:
44177 element-choice-sets:
44180 $ref: "#/definitions/element-choice-set"
44184 $ref: "#/definitions/relationship"
44185 constrained-element-sets:
44187 constrained-element-set:
44190 $ref: "#/definitions/constrained-element-set"
44193 ###### Related Nodes
44194 - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
44204 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44208 $ref: "#/definitions/relationship"
44214 $ref: "#/definitions/ctag-assignment"
44217 A collection of C tags (vlan tags) grouped for a specific purpose.
44218 ###### Related Nodes
44219 - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
44220 - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
44221 - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
44224 - availability-zone-name
44225 - ctag-pool-purpose
44229 description: The Target provider edge router
44230 availability-zone-name:
44232 description: Name of the availability zone
44235 description: Describes what the intended purpose of this pool is.
44238 description: Comma separated list of ctags
44241 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44245 $ref: "#/definitions/relationship"
44251 $ref: "#/definitions/ctag-pool"
44254 customer identifiers to provide linkage back to BSS information.
44255 ###### Related Nodes
44256 - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
44257 - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
44259 - global-customer-id
44263 global-customer-id:
44265 description: Global customer id used across ECOMP to uniquely identify customer.
44268 description: Subscriber name, an alternate way to retrieve a customer.
44271 description: Subscriber type, a way to provide VID with only the INFRA customers.
44274 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44275 service-subscriptions:
44278 $ref: "#/definitions/service-subscription"
44282 $ref: "#/definitions/relationship"
44285 Collection of customer identifiers to provide linkage back to BSS information.
44290 $ref: "#/definitions/customer"
44298 description: See mis-na-virtualization-platform.yang
44301 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44305 $ref: "#/definitions/relationship"
44311 $ref: "#/definitions/cvlan-tag-entry"
44314 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.
44315 ###### Related Nodes
44316 - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
44317 - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
44324 description: DVS switch name
44327 description: URL used to reach the vcenter
44330 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44334 $ref: "#/definitions/relationship"
44337 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
44342 $ref: "#/definitions/dvs-switch"
44345 Internal map to define the properties of an edge and interpret the map EdgeRules
44363 edge-tag-query-request:
44374 $ref: "#/definitions/start-node-filter"
44375 include-node-filter:
44378 $ref: "#/definitions/include-node-filter"
44382 $ref: "#/definitions/secondary-filter"
44383 edge-tag-query-result:
44385 tagged-inventory-item-list:
44388 $ref: "#/definitions/tagged-inventory-item-list"
44389 element-choice-set:
44391 This is how we would capture constraints defining allowed sets of elements.
44392 ###### Related Nodes
44393 - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
44394 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
44395 - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
44397 - element-choice-set-uuid
44398 - element-choice-set-name
44400 element-choice-set-uuid:
44402 element-choice-set-name:
44411 $ref: "#/definitions/model-element"
44415 $ref: "#/definitions/relationship"
44416 element-choice-sets:
44418 element-choice-set:
44421 $ref: "#/definitions/element-choice-set"
44424 Metadata for entitlement group.
44425 ###### Related Nodes
44426 - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
44427 - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
44434 description: Unique ID for the entitlement group the resource comes from, should be uuid.
44437 description: Unique ID of an entitlement resource.
44440 description: Concurrency value
44444 $ref: "#/definitions/relationship"
44447 Entitlements, keyed by group-uuid and resource-uuid, related to license management
44452 $ref: "#/definitions/entitlement"
44455 Persist EMS address information used by EMS driver.
44456 ###### Related Nodes
44457 - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
44458 - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
44464 description: Unique ID of EMS.
44467 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44468 esr-system-info-list:
44470 $ref: "#/definitions/esr-system-info-list"
44473 $ref: "#/definitions/relationship-list"
44479 $ref: "#/definitions/esr-ems"
44482 Persist common address information of external systems.
44483 ###### Related Nodes
44484 - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
44485 - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
44486 - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
44487 - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
44489 - esr-system-info-id
44494 esr-system-info-id:
44496 description: Unique ID of esr system info.
44499 description: name of external system.
44502 description: type of external systems.
44505 description: vendor of external systems.
44508 description: version of external systems.
44511 description: url used to access external systems.
44514 description: username used to access external systems.
44517 description: password used to access external systems.
44520 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
44523 description: protocol of third party SDNC, for example netconf/snmp.
44526 description: ca file content if enabled ssl on auth-url.
44529 description: Whether to verify VIM's certificate.
44532 description: service IP of ftp server.
44535 description: service port of ftp server.
44538 description: domain info for authentication.
44541 description: default tenant of VIM.
44544 description: ftp passive mode or not.
44547 description: resource or performance data file path.
44550 description: the status of external system.
44553 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44557 $ref: "#/definitions/relationship"
44558 esr-system-info-list:
44560 Collection of persistent block-level external system auth info.
44565 $ref: "#/definitions/esr-system-info"
44566 esr-thirdparty-sdnc:
44568 Persist SDNC address information used by ONAP SDNC.
44569 ###### Related Nodes
44570 - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
44571 - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
44572 - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
44574 - thirdparty-sdnc-id
44576 thirdparty-sdnc-id:
44578 description: Unique ID of SDNC.
44581 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
44584 description: password used to access SDNC server.
44587 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44588 esr-system-info-list:
44590 $ref: "#/definitions/esr-system-info-list"
44593 $ref: "#/definitions/relationship-list"
44594 esr-thirdparty-sdnc-list:
44596 esr-thirdparty-sdnc:
44599 $ref: "#/definitions/esr-thirdparty-sdnc"
44602 Persist VNFM address information used by VF-C.
44603 ###### Related Nodes
44604 - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
44605 - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
44611 description: Unique ID of VNFM.
44614 description: indecate the VIM to deploy VNF.
44617 description: certificate url of VNFM.
44620 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44621 esr-system-info-list:
44623 $ref: "#/definitions/esr-system-info-list"
44626 $ref: "#/definitions/relationship-list"
44632 $ref: "#/definitions/esr-vnfm"
44635 evc object is an optional child object of the Configuration object.
44636 ###### Related Nodes
44637 - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
44643 description: Unique/key field for the evc object
44644 forwarding-path-topology:
44646 description: Point-to-Point, Multi-Point
44649 description: Commited Information Rate
44652 description: CIR units
44653 connection-diversity-group-id:
44655 description: Diversity Group ID
44658 description: formerly Performance Group
44659 esp-evc-circuit-id:
44661 description: EVC Circuit ID of ESP EVC
44664 description: Committed Information Rate (For ESP)
44667 description: CIR units (For ESP)
44670 description: Identifies ESP
44671 collector-pop-clli:
44673 description: Collector POP CLLI (from the hostname of the access pnf)
44674 inter-connect-type-ingress:
44676 description: Interconnect type on ingress side of EVC.
44677 tagmode-access-ingress:
44679 description: tagode for collector side of EVC
44680 tagmode-access-egress:
44682 description: tagMode for network side of EVC
44686 $ref: "#/definitions/relationship"
44689 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44695 $ref: "#/definitions/evc"
44698 Namespace for external system.
44702 $ref: "#/definitions/esr-ems-list"
44705 $ref: "#/definitions/esr-vnfm-list"
44706 esr-thirdparty-sdnc-list:
44708 $ref: "#/definitions/esr-thirdparty-sdnc-list"
44711 Extra properties for inventory item for response list
44719 ###### Related Nodes
44720 - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
44721 - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
44722 - FLAVOR cannot be deleted if linked to VSERVER
44730 description: Flavor id, expected to be unique across cloud-region.
44733 description: Flavor name
44737 description: Number of CPUs
44741 description: Amount of memory
44745 description: Disk space
44749 description: Amount of ephemeral disk space
44752 description: amount of swap space allocation
44755 description: whether flavor is available to all users or private to the tenant it was created in.
44758 description: URL to endpoint where AAI can get more details
44761 description: Boolean as to whether this flavor is no longer enabled
44764 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44768 $ref: "#/definitions/relationship"
44771 Collection of openstack flavors.
44776 $ref: "#/definitions/flavor"
44779 Entity describing a sequenced segment of forwarding path
44780 ###### Related Nodes
44781 - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
44782 - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
44783 - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
44784 - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
44785 - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
44786 - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
44793 description: Unique ID of this segmentation
44796 description: ingress, intermediate, egress
44800 $ref: "#/definitions/relationship"
44803 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44806 forwarder object is an optional child object of the Configuration object.
44807 ###### Related Nodes
44808 - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
44814 description: Key for forwarder-evc object
44817 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
44820 description: Internal VLAN.
44823 description: SVLAN value for ingress of egress forwarder.
44826 description: CVLAN value for ingress of egress forwarder.
44830 $ref: "#/definitions/relationship"
44833 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44839 $ref: "#/definitions/forwarder-evc"
44845 $ref: "#/definitions/forwarder"
44848 Entity that describes the sequenced forwarding path between interfaces of services or resources
44849 ###### Related Nodes
44850 - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
44851 - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
44852 - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
44853 - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
44854 - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
44856 - forwarding-path-id
44857 - forwarding-path-name
44859 forwarding-path-id:
44861 description: Unique ID of this FP
44862 forwarding-path-name:
44864 description: Name of the FP
44868 $ref: "#/definitions/relationship"
44871 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44874 description: the self link for this FP
44878 $ref: "#/definitions/forwarder"
44884 $ref: "#/definitions/forwarding-path"
44887 General purpose VNF
44888 ###### Related Nodes
44889 - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
44890 - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
44891 - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
44892 - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
44893 - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
44894 - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
44895 - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
44896 - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
44897 - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
44898 - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
44899 - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
44900 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
44901 - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
44902 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
44903 - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
44904 - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
44905 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
44906 - GENERIC-VNF is DELETED when these are DELETED VNFC,LAG-INTERFACE,L-INTERFACE,VF-MODULE
44912 - is-closed-loop-disabled
44916 description: Unique id of VNF. This is unique across the graph.
44919 description: Name of VNF.
44922 description: Alternate name of VNF.
44925 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
44928 description: Unique identifier of service from ASDC
44929 regional-resource-zone:
44931 description: Regional way of organizing pservers, source of truth should define values
44934 description: Trigger for operational monitoring of this resource by Service Assurance systems.
44937 description: Indicator for whether the resource is considered operational
44940 description: License key
44943 description: Client should send valid enumerated value
44944 orchestration-status:
44946 description: Orchestration status of this VNF, used by MSO.
44949 description: Heat stack id corresponding to this instance, managed by MSO
44952 description: Corresponds to the SDN-C catalog id used to configure this VCE
44955 description: identifier of managed by company or customer
44958 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
44959 ipv4-loopback0-address:
44961 description: v4 Loopback0 address
44964 description: v6 Loopback address
44965 management-v6-address:
44967 description: v6 management address
44971 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors
44974 description: units associated with vcpu, used for VNFs with no vservers/flavors
44978 description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors
44981 description: units associated with vmemory, used for VNFs with no vservers/flavors
44985 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors
44988 description: units associated with vdisk, used for VNFs with no vservers/flavors
44991 is-closed-loop-disabled:
44995 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44998 description: details regarding the generic-vnf operation
44999 encrypted-access-flag:
45001 description: indicates whether generic-vnf access uses SSH
45004 description: the ASDC model id for this resource or service model.
45005 persona-model-version:
45007 description: the ASDC model version for this resource or service model.
45010 description: the ASDC model version for this resource or service model.
45013 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
45014 widget-model-version:
45016 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
45019 description: as-number of the VNF
45020 regional-resource-subzone:
45022 description: represents sub zone of the rr plane
45026 $ref: "#/definitions/relationship"
45030 $ref: "#/definitions/l-interface"
45034 $ref: "#/definitions/lag-interface"
45038 $ref: "#/definitions/vf-module"
45046 $ref: "#/definitions/generic-vnf"
45049 Openstack group-assignment used to store exclusivity groups (EG).
45050 ###### Related Nodes
45051 - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
45052 - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
45053 - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
45061 description: Group id, expected to be unique across cloud-region.
45064 description: Group type - the type of group this instance refers to
45067 description: Group name - name assigned to the group
45070 description: Group description - description of the group
45073 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45077 $ref: "#/definitions/relationship"
45080 Collection of openstack group assignments
45085 $ref: "#/definitions/group-assignment"
45088 ###### Related Nodes
45089 - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
45097 description: host-route id
45100 description: subnet prefix
45103 description: Could be ip-address, hostname, or service-instance
45106 description: Should be ip-address, hostname, or service-instance to match next-hop
45109 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45113 $ref: "#/definitions/relationship"
45119 $ref: "#/definitions/host-route"
45123 ###### Related Nodes
45124 - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
45125 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
45126 - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
45127 - IMAGE cannot be deleted if linked to VSERVER
45128 - IMAGE is DELETED when these are DELETED METADATUM
45138 description: Image id, expected to be unique across cloud region
45141 description: Image name
45142 image-architecture:
45144 description: Operating system architecture.
45147 description: The common name of the operating system distribution in lowercase
45150 description: The operating system version as specified by the distributor.
45153 description: The application that the image instantiates.
45154 application-vendor:
45156 description: The vendor of the application.
45157 application-version:
45159 description: The version of the application.
45162 description: URL to endpoint where AAI can get more details
45165 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45169 $ref: "#/definitions/relationship"
45173 $ref: "#/definitions/metadatum"
45176 Collectio of Openstack images.
45181 $ref: "#/definitions/image"
45182 include-node-filter:
45188 InstanceFilter for performing a named-query or model query
45191 InstanceFilters for performing a named-query or model query
45196 $ref: "#/definitions/instance-filter"
45199 General mechanism for grouping instances
45200 ###### Related Nodes
45201 - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
45202 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
45203 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
45204 - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
45205 - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
45213 description: Instance Group ID, UUID assigned to this instance.
45216 description: Descriptive text to help identify the usage of this instance-group
45219 description: Only valid value today is lower case ha for high availability
45222 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
45225 description: Concurrency value
45229 $ref: "#/definitions/relationship"
45232 Collection of openstack route table references
45237 $ref: "#/definitions/instance-group"
45242 $ref: "#/definitions/search"
45245 $ref: "#/definitions/actions"
45246 cloud-infrastructure:
45248 $ref: "#/definitions/cloud-infrastructure"
45251 $ref: "#/definitions/business"
45252 service-design-and-creation:
45254 $ref: "#/definitions/service-design-and-creation"
45257 $ref: "#/definitions/network"
45260 $ref: "#/definitions/aai-internal"
45263 inventory-item-type:
45265 inventory-item-link:
45267 inventory-item-data:
45270 $ref: "#/definitions/inventory-item-data"
45271 tagged-inventory-item-list:
45274 $ref: "#/definitions/tagged-inventory-item-list"
45275 inventory-item-data:
45281 inventory-response-item:
45283 Inventory item for response list
45289 $ref: "#/definitions/extra-properties"
45290 inventory-response-items:
45292 $ref: "#/definitions/inventory-response-items"
45293 inventory-response-items:
45295 Container for inventory items in response list
45297 inventory-response-item:
45300 $ref: "#/definitions/inventory-response-item"
45301 ipsec-configuration:
45303 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
45304 ###### Related Nodes
45305 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
45306 - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
45307 - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
45309 - ipsec-configuration-id
45311 ipsec-configuration-id:
45313 description: UUID of this configuration
45314 requested-vig-address-type:
45316 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
45317 requested-encryption-strength:
45319 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
45320 requested-dmz-type:
45322 description: can offer a shared DMZ or a DMZ specific to a customer
45323 shared-dmz-network-address:
45325 description: Network address of shared DMZ
45326 requested-customer-name:
45328 description: If the DMZ is a custom DMZ, this field will indicate the customer information
45331 description: can be 1 or 2
45332 ikev1-authentication:
45334 description: Contains values like md5, sha1, sha256, sha384
45337 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
45340 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
45343 description: Group name defined in VIG for clients using aggressive mode
45346 description: pre-shared key for the above group name
45349 description: Lifetime for IKEv1 SA
45350 ipsec-authentication:
45352 description: md5, sha1, sha256, sha384
45355 description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
45358 description: Life time for IPSec SA
45361 description: enable PFS or not
45364 description: user ID for xAuth, sm-user, ,nmteHostName
45365 xauth-user-password:
45367 description: Encrypted using the Juniper $9$ algorithm
45370 description: The time between DPD probe
45373 description: Maximum number of DPD before claiming the tunnel is down
45376 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45380 $ref: "#/definitions/relationship"
45384 $ref: "#/definitions/vig-server"
45385 ipsec-configurations:
45387 ipsec-configuration:
45390 $ref: "#/definitions/ipsec-configuration"
45399 Logical interfaces, e.g., a vnic.
45400 ###### Related Nodes
45401 - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
45402 - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
45403 - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
45404 - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
45405 - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
45406 - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
45407 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
45408 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
45409 - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
45410 - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
45411 - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
45412 - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
45418 description: Name given to the interface
45421 description: E.g., CUSTOMER, UPLINK, etc.
45424 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
45427 description: URL to endpoint where AAI can get more details
45430 description: ID of interface
45433 description: MAC address for the interface
45436 description: Name of the network
45439 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
45442 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45446 $ref: "#/definitions/vlan"
45450 $ref: "#/definitions/sriov-vf"
45454 $ref: "#/definitions/relationship"
45455 l3-interface-ipv4-address-list:
45458 $ref: "#/definitions/l3-interface-ipv4-address-list"
45459 l3-interface-ipv6-address-list:
45462 $ref: "#/definitions/l3-interface-ipv6-address-list"
45465 Collection of logical interfaces.
45470 $ref: "#/definitions/l-interface"
45471 l3-interface-ipv4-address-list:
45474 ###### Related Nodes
45475 - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
45476 - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
45477 - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
45478 - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
45480 - l3-interface-ipv4-address
45482 l3-interface-ipv4-address:
45484 description: IP address
45485 l3-interface-ipv4-prefix-length:
45488 description: Prefix length, 32 for single address
45492 description: Inner VLAN tag
45496 description: Outer VLAN tag
45499 description: Indicator of fixed or floating address
45502 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45503 neutron-network-id:
45505 description: Neutron network id of the interface that address belongs to
45508 description: Neutron id of subnet that address belongs to
45512 $ref: "#/definitions/relationship"
45513 l3-interface-ipv6-address-list:
45516 ###### Related Nodes
45517 - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
45518 - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
45519 - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
45520 - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
45522 - l3-interface-ipv6-address
45524 l3-interface-ipv6-address:
45526 description: IP address
45527 l3-interface-ipv6-prefix-length:
45530 description: Prefix length, 128 for single address
45534 description: Inner VLAN tag
45538 description: Outer VLAN tag
45541 description: Indicator of fixed or floating address
45544 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45545 neutron-network-id:
45547 description: Neutron network id of the interface that address belongs to
45550 description: Neutron id of subnet that address belongs to
45554 $ref: "#/definitions/relationship"
45557 Generic network definition
45558 ###### Related Nodes
45559 - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
45560 - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
45561 - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
45562 - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
45563 - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
45564 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
45565 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
45566 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
45567 - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
45568 - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
45569 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
45570 - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
45571 - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
45572 - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
45573 - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
45578 - is-provider-network
45579 - is-shared-network
45580 - is-external-network
45584 description: Network ID, should be uuid. Unique across A&AI.
45587 description: Name of the network, governed by some naming convention..
45590 description: Type of the network - who defines these values?
45593 description: Role the network plans - who defines these values?
45594 network-technology:
45596 description: Network technology - who defines these values?
45597 neutron-network-id:
45599 description: Neutron network id of this Interface
45604 description: Unique identifier of service from ASDC
45605 network-role-instance:
45608 description: network role instance
45611 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45612 orchestration-status:
45614 description: Orchestration status of this VNF, mastered by MSO
45617 description: Heat stack id corresponding to this instance, managed by MSO
45620 description: Corresponds to the SDN-C catalog id used to configure this VCE
45621 contrail-network-fqdn:
45623 description: Contrail FQDN for the network
45626 description: the ASDC model id for this resource or service model.
45627 persona-model-version:
45629 description: the ASDC model version for this resource or service model.
45632 description: the ASDC model version for this resource or service model.
45635 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
45636 widget-model-version:
45638 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
45639 physical-network-name:
45641 description: Name associated with the physical network.
45642 is-provider-network:
45646 is-external-network:
45651 $ref: "#/definitions/subnet"
45655 $ref: "#/definitions/ctag-assignment"
45656 segmentation-assignments:
45659 $ref: "#/definitions/segmentation-assignment"
45663 $ref: "#/definitions/relationship"
45664 description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
45670 $ref: "#/definitions/l3-network"
45673 Link aggregate interface
45674 ###### Related Nodes
45675 - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
45676 - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
45677 - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
45678 - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
45679 - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
45680 - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
45681 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
45682 - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
45683 - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK
45689 description: Name that identifies the link aggregate interface
45692 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45695 description: Captures the numeric part of the speed
45698 description: Captures the units corresponding to the speed
45702 $ref: "#/definitions/relationship"
45706 $ref: "#/definitions/l-interface"
45709 Collection of link aggregate interfaces.
45714 $ref: "#/definitions/lag-interface"
45717 LAG links can connect lag-interfaces
45718 ###### Related Nodes
45719 - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
45720 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
45726 description: Alphabetical concatenation of lag-interface names
45729 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45733 $ref: "#/definitions/relationship"
45736 Collection of link aggregation connections
45741 $ref: "#/definitions/lag-link"
45744 Metadata for license group.
45745 ###### Related Nodes
45746 - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
45747 - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
45754 description: Unique ID for the license group the resource belongs to, should be uuid.
45757 description: Unique ID of a license resource.
45760 description: Concurrency value
45764 $ref: "#/definitions/relationship"
45767 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
45772 $ref: "#/definitions/license"
45775 describes a line-of-business
45776 ###### Related Nodes
45777 - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
45779 - line-of-business-name
45781 line-of-business-name:
45783 description: Name of the line-of-business (product)
45786 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45790 $ref: "#/definitions/relationship"
45793 Collection of lines-of-business
45798 $ref: "#/definitions/line-of-business"
45801 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
45802 ###### Related Nodes
45803 - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
45804 - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
45805 - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
45806 - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
45807 - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
45808 - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
45809 - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
45810 - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
45811 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
45812 - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
45813 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
45820 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
45823 description: Type of logical link, e.g., evc
45826 description: Captures the numeric part of the speed
45829 description: Captures the units corresponding to the speed
45832 description: v4, v6, or ds for dual stack
45835 description: For example, static or BGP
45838 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45841 description: the ASDC model id for this resource or service model.
45842 persona-model-version:
45844 description: the ASDC model version for this resource or service model.
45847 description: the ASDC model version for this resource or service model.
45850 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
45851 widget-model-version:
45853 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
45854 operational-status:
45856 description: Indication of operational status of the logical link.
45859 description: Indication of the network use of the logical link.
45862 description: Alias or alternate name (CLCI or D1 name).
45865 description: UUID of the logical-link, SDNC generates this.
45869 $ref: "#/definitions/relationship"
45872 Collection of logical connections
45877 $ref: "#/definitions/logical-link"
45880 Collection of metadatum (key/value pairs)
45885 $ref: "#/definitions/metadatum"
45889 ###### Related Nodes
45890 - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
45891 - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
45892 - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
45893 - TO model( metadatum org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
45904 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45907 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models
45908 ###### Related Nodes
45909 - TO model( model-element isA model, MANY2ONE)
45910 - TO model-element (CHILD of model, model startsWith model-element, ONE2MANY)
45911 - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
45912 - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
45913 - FROM model-element( model-element isA model, MANY2ONE)
45914 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
45915 - MODEL cannot be deleted if linked to NAMED-QUERY,NAMED-QUERY-ELEMENT
45916 - MODEL is DELETED when these are DELETED METADATUM
45917 - MODEL deletion means associated objects of these types are also DELETED:MODEL-ELEMENT
45919 - model-name-version-id
45925 model-name-version-id:
45927 description: Unique identifier corresponding to one version of a model in ASDC
45930 description: Type of the model, e.g., service, resource, widget, etc.
45933 description: Name of the model, which can change from version to version.
45936 description: Invariant unique ID which does not change from version to version
45939 description: Version
45942 description: Description
45945 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
45949 $ref: "#/definitions/model-element"
45953 $ref: "#/definitions/metadatum"
45957 $ref: "#/definitions/relationship"
45958 model-and-named-query-search:
45960 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
45964 $ref: "#/definitions/query-parameters"
45967 $ref: "#/definitions/instance-filters"
45972 This is how we would capture constraints defining allowed sets of elements.
45973 ###### Related Nodes
45974 - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
45975 - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
45976 - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
45978 - model-constraint-uuid
45979 - constrained-element-set-uuid-to-replace
45981 model-constraint-uuid:
45983 constrained-element-set-uuid-to-replace:
45985 constrained-element-sets:
45988 $ref: "#/definitions/constrained-element-set"
45994 $ref: "#/definitions/model-constraint"
45997 Defines how other models combine to make up a higher-level model.
45998 ###### Related Nodes
45999 - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
46000 - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
46001 - TO model( model-element isA model, MANY2ONE)
46002 - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
46003 - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
46004 - FROM model (PARENT of model-element, model startsWith model-element)
46005 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
46006 - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
46008 - model-element-uuid
46009 - new-data-del-flag
46012 model-element-uuid:
46016 description: Indicates whether this element was created as part of instantiation from this model
46019 description: How many of this type of element are required/allowed
46024 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46028 $ref: "#/definitions/model-element"
46029 description: Defines how other models combine to make up a higher-level model
46033 $ref: "#/definitions/model-constraint"
46034 description: Describes new constraints on this model element that are not part of that model's definition
46038 $ref: "#/definitions/relationship"
46044 $ref: "#/definitions/model-element"
46047 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
46048 ###### Related Nodes
46049 - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
46050 - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
46051 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
46052 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
46053 - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
46054 - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
46062 description: Unique identifier corresponding to one version of a model in ASDC
46065 description: Name of the model, which can change from version to version.
46068 description: Version
46071 description: Description
46074 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46078 $ref: "#/definitions/model-element"
46082 $ref: "#/definitions/metadatum"
46086 $ref: "#/definitions/relationship"
46092 $ref: "#/definitions/model-ver"
46095 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
46100 $ref: "#/definitions/model"
46101 multicast-configuration:
46103 ###### Related Nodes
46104 - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
46106 - multicast-configuration-id
46107 - multicast-protocol
46110 multicast-configuration-id:
46112 description: Unique id of multicast configuration.
46113 multicast-protocol:
46115 description: protocol of multicast configuration
46118 description: rp type of multicast configuration
46121 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46125 $ref: "#/definitions/relationship"
46126 multicast-configurations:
46128 multicast configuration of generic-vnf ip-address
46130 multicast-configuration:
46133 $ref: "#/definitions/multicast-configuration"
46139 $ref: "#/definitions/named-query"
46143 ###### Related Nodes
46144 - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
46145 - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
46146 - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
46147 - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
46151 - named-query-version
46157 named-query-version:
46159 required-input-param:
46165 named-query-elements:
46168 $ref: "#/definitions/named-query-element"
46172 $ref: "#/definitions/relationship"
46173 named-query-element:
46176 ###### Related Nodes
46177 - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
46178 - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
46179 - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
46180 - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
46181 - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
46182 - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
46183 - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
46185 - named-query-element-uuid
46187 named-query-element-uuid:
46189 property-collect-list:
46193 property-limit-desc:
46197 named-query-elements:
46200 $ref: "#/definitions/named-query-element"
46204 $ref: "#/definitions/related-lookup"
46205 property-constraints:
46208 $ref: "#/definitions/property-constraint"
46212 $ref: "#/definitions/relationship"
46213 named-query-elements:
46215 named-query-element:
46218 $ref: "#/definitions/named-query-element"
46221 Namespace for network inventory resources.
46226 $ref: "#/definitions/logical-link"
46230 $ref: "#/definitions/site-pair-set"
46234 $ref: "#/definitions/vpn-binding"
46238 $ref: "#/definitions/vpls-pe"
46239 multicast-configurations:
46242 $ref: "#/definitions/multicast-configuration"
46246 $ref: "#/definitions/vce"
46250 $ref: "#/definitions/vnfc"
46254 $ref: "#/definitions/l3-network"
46258 $ref: "#/definitions/network-policy"
46262 $ref: "#/definitions/generic-vnf"
46266 $ref: "#/definitions/lag-link"
46270 $ref: "#/definitions/newvce"
46274 $ref: "#/definitions/pnf"
46278 $ref: "#/definitions/physical-link"
46279 ipsec-configurations:
46282 $ref: "#/definitions/ipsec-configuration"
46283 route-table-references:
46286 $ref: "#/definitions/route-table-reference"
46292 $ref: "#/definitions/network-policy"
46295 ###### Related Nodes
46296 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
46298 - network-policy-id
46302 description: UUID representing unique key to this instance
46303 network-policy-fqdn:
46305 description: Contrail FQDN for the policy
46308 description: ID for the openStack Heat instance
46311 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46315 $ref: "#/definitions/relationship"
46318 Network profile populated by SDN-GP for SNMP
46319 ###### Related Nodes
46320 - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
46326 description: Unique name of network profile.
46329 description: Encrypted SNMP community string
46332 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46336 $ref: "#/definitions/relationship"
46339 Collection of network profiles
46344 $ref: "#/definitions/network-profile"
46347 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
46348 ###### Related Nodes
46349 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
46350 - NEWVCE is DELETED when these are DELETED L-INTERFACE
46358 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
46361 description: Name of VNF.
46364 description: Alternate name of VNF.
46367 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
46370 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
46373 description: Indicator for whether the resource is considered operational
46376 description: License key
46379 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).
46382 description: Client should send valid enumerated value.
46385 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46386 ipv4-loopback0-address:
46388 description: v4 Loopback0 address
46389 orchestration-status:
46391 description: Orchestration status of this VNF, mastered by MSO.
46394 description: Heat stack id corresponding to this instance, managed by MSO
46397 description: Corresponds to the SDN-C catalog id used to configure this VCE
46401 $ref: "#/definitions/relationship"
46405 $ref: "#/definitions/l-interface"
46408 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
46413 $ref: "#/definitions/newvce"
46414 notification-event:
46418 notification-event-header:
46420 $ref: "#/definitions/notification-event-header"
46421 notification-event-header:
46462 $ref: "#/definitions/key-data"
46467 OAM network, to be deprecated shortly. Do not use for new purposes.
46468 ###### Related Nodes
46469 - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
46470 - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
46471 - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
46479 description: UUID of the network. Unique across a cloud-region
46482 description: Name of the network.
46486 description: cvlan-id
46487 ipv4-oam-gateway-address:
46489 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
46490 ipv4-oam-gateway-address-prefix-length:
46493 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
46496 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46500 $ref: "#/definitions/relationship"
46503 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
46508 $ref: "#/definitions/oam-network"
46509 operational-environment:
46511 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
46512 ###### Related Nodes
46513 - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
46514 - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
46516 - operational-environment-id
46517 - operational-environment-name
46518 - operational-environment-type
46519 - operational-environment-status
46523 operational-environment-id:
46525 description: UUID of an operational environment
46526 operational-environment-name:
46528 description: Operational Environment name
46529 operational-environment-type:
46531 description: Operational Environment Type.
46532 operational-environment-status:
46534 description: Status
46537 description: Tenant Context.
46540 description: Workload Context.
46543 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46547 $ref: "#/definitions/relationship"
46548 operational-environments:
46550 a logical partition of the cloud which allows to have multiple environments in the production AIC.
46552 operational-environment:
46555 $ref: "#/definitions/operational-environment"
46558 Allows for legacy POST of old-style and new-style models
46560 - model-invariant-id
46561 - model-name-version-id
46567 model-invariant-id:
46569 description: Unique identifier corresponding to the main definition of a model in ASDC
46570 model-name-version-id:
46572 description: Unique identifier corresponding to one version of a model in ASDC
46575 description: Type of the model, e.g., service, resource, widget, etc.
46578 description: Name of the model, which can change from version to version.
46581 description: Invariant unique ID which does not change from version to version
46584 description: Version
46587 description: Description
46590 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46593 $ref: "#/definitions/model-vers"
46596 $ref: "#/definitions/relationship-list"
46599 Collection of owning-entities
46604 $ref: "#/definitions/owning-entity"
46607 describes an owning-entity
46608 ###### Related Nodes
46609 - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
46612 - owning-entity-name
46616 description: UUID of an owning entity
46617 owning-entity-name:
46619 description: Owning entity name
46622 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46626 $ref: "#/definitions/relationship"
46629 Physical interface (e.g., nic)
46630 ###### Related Nodes
46631 - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
46632 - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
46633 - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
46634 - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
46635 - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
46636 - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
46637 - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
46638 - P-INTERFACE is DELETED when these are DELETED L-INTERFACE
46639 - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
46645 description: Name that identifies the physical interface
46648 description: Captures the numeric part of the speed
46651 description: Captures the units corresponding to the speed
46654 description: Nature of the services and connectivity on this port.
46655 equipment-identifier:
46657 description: CLEI or other specification for p-interface hardware.
46660 description: Role specification for p-interface hardware.
46663 description: Indicates the physical properties of the interface.
46666 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46670 $ref: "#/definitions/relationship"
46674 $ref: "#/definitions/l-interface"
46677 Collection of physical interfaces.
46682 $ref: "#/definitions/p-interface"
46685 Collection of physical connections, typically between p-interfaces
46686 ###### Related Nodes
46687 - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
46693 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
46696 description: Captures the numeric part of the speed
46699 description: Captures the units corresponding to the speed
46702 description: Circuit it
46705 description: Dual access mode (e.g., primary, secondary
46708 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
46709 service-provider-name:
46711 description: Name of the service Provider on this link.
46714 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46718 $ref: "#/definitions/relationship"
46721 Collection of physical connections, typically between p-interfaces
46726 $ref: "#/definitions/physical-link"
46729 describes a platform
46730 ###### Related Nodes
46731 - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
46737 description: Name of the platform
46740 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46744 $ref: "#/definitions/relationship"
46747 Collection of platforms
46752 $ref: "#/definitions/platform"
46755 PNF represents a physical network function. typically equipment used in the D1 world.
46756 ###### Related Nodes
46757 - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
46758 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
46759 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
46760 - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
46761 - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
46768 description: unique name of Physical Network Function.
46771 description: name of Physical Network Function.
46774 description: source of name2
46777 description: id of pnf
46780 description: Equipment type. Source of truth should define valid values.
46783 description: Equipment vendor. Source of truth should define valid values.
46786 description: Equipment model. Source of truth should define valid values.
46789 description: identifier of managed by company or customer
46792 description: ipv4-oam-address with new naming convention for IP addresses
46795 description: sw-version is the version of SW for the hosted application on the PNF.
46796 orchestration-status:
46798 description: orchestration-status is the status of orchestration on the PNF.
46803 description: ID of the physical frame (relay rack) where pnf is installed.
46806 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46810 $ref: "#/definitions/relationship"
46814 $ref: "#/definitions/p-interface"
46818 $ref: "#/definitions/lag-interface"
46821 Collection of Physical Network Functions.
46826 $ref: "#/definitions/pnf"
46829 Used to capture the network interfaces of this VCE
46830 ###### Related Nodes
46831 - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
46832 - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
46833 - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
46836 - orchestration-status
46840 description: Unique ID of the interface
46841 neutron-network-id:
46843 description: Neutron network id of this Interface
46844 neutron-network-name:
46846 description: Neutron network name of this Interface
46849 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
46852 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46855 description: Unique ID for port group in vmware
46858 description: Likely to duplicate value of neutron network name
46861 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
46862 orchestration-status:
46864 description: Orchestration status of this VNF, mastered by MSO
46867 description: Heat stack id corresponding to this instance, managed by MSO
46870 description: Corresponds to the SDN-C catalog id used to configure this VCE
46874 $ref: "#/definitions/cvlan-tag-entry"
46878 $ref: "#/definitions/relationship"
46884 $ref: "#/definitions/port-group"
46887 describes the project
46888 ###### Related Nodes
46889 - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
46895 description: Name of the project deploying a service
46898 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
46902 $ref: "#/definitions/relationship"
46905 Collection of projects
46910 $ref: "#/definitions/project"
46913 Property holder for query properties or instance properties
46919 property-constraint:
46922 ###### Related Nodes
46923 - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
46925 - property-constraint-uuid
46930 property-constraint-uuid:
46940 property-constraints:
46942 property-constraint:
46945 $ref: "#/definitions/property-constraint"
46948 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
46949 ###### Related Nodes
46950 - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
46951 - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
46952 - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
46953 - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
46954 - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
46955 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
46956 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
46957 - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
46958 - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
46959 - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
46960 - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
46961 - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
46968 description: Value from executing hostname on the compute node.
46971 description: PTNII name
46975 description: Number of cpus
46979 description: Disk size, in GBs
46983 description: RAM size, in MBs
46986 description: Equipment type. Source of truth should define valid values.
46989 description: Equipment vendor. Source of truth should define valid values.
46992 description: Equipment model. Source of truth should define valid values.
46995 description: Fully-qualified domain name
46998 description: URL to endpoint where AAI can get more details
47001 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
47004 description: Serial number, may be queried
47007 description: ID of Pserver
47010 description: internet topology of Pserver
47015 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47018 description: alternative pserver name
47021 description: purpose of pserver
47025 $ref: "#/definitions/relationship"
47029 $ref: "#/definitions/p-interface"
47033 $ref: "#/definitions/lag-interface"
47036 Collection of compute hosts.
47041 $ref: "#/definitions/pserver"
47044 QueryParameters for performing a named-query or model query
47048 $ref: "#/definitions/named-query"
47051 $ref: "#/definitions/model"
47055 ###### Related Nodes
47056 - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
47058 - related-lookup-uuid
47060 - source-node-property
47062 - target-node-property
47064 related-lookup-uuid:
47068 source-node-property:
47072 target-node-property:
47074 property-collect-list:
47081 $ref: "#/definitions/relationship"
47087 $ref: "#/definitions/related-lookup"
47088 related-to-property:
47092 description: Key part of a key/value pair
47095 description: Value part of a key/value pair
47100 description: A keyword provided by A&AI to indicate type of node.
47103 description: URL to the object in A&AI.
47107 $ref: "#/definitions/relationship-data"
47111 - relationship-value
47115 description: A keyword provided by A&AI to indicate an attribute.
47116 relationship-value:
47118 description: Value of the attribute.
47124 $ref: "#/definitions/relationship"
47125 reserved-prop-names:
47127 Internal map to define some reserved properties of a vertex
47129 last-mod-source-of-truth:
47145 Response container for the results of a named-query or model query
47147 inventory-response-items:
47149 $ref: "#/definitions/inventory-response-items"
47154 description: The specific type of node in the A&AI graph
47157 description: The URL to the specific resource
47158 route-table-reference:
47160 Openstack route table reference.
47161 ###### Related Nodes
47162 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
47164 - route-table-reference-id
47165 - route-table-reference-fqdn
47167 route-table-reference-id:
47169 description: Route Table Reference id, UUID assigned to this instance.
47170 route-table-reference-fqdn:
47172 description: FQDN entry in the route table.
47175 description: Concurrency value
47179 $ref: "#/definitions/relationship"
47180 route-table-references:
47182 Collection of openstack route table references
47184 route-table-reference:
47187 $ref: "#/definitions/route-table-reference"
47190 Route target information
47191 ###### Related Nodes
47192 - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
47194 - global-route-target
47195 - route-target-role
47197 global-route-target:
47199 description: Number used to identify an RT, globally unique in the network
47202 description: Role assigned to this route target
47205 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47209 $ref: "#/definitions/relationship"
47212 Collection of route target information
47217 $ref: "#/definitions/route-target"
47220 ###### Related Nodes
47221 - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
47222 - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
47223 - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
47225 - routing-instance-id
47227 routing-instance-id:
47229 description: Unique id of routing instance
47232 description: rpm owner
47235 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47239 $ref: "#/definitions/site-pair"
47243 $ref: "#/definitions/relationship"
47246 set of probes related to generic-vnf routing instance
47251 $ref: "#/definitions/routing-instance"
47256 $ref: "#/definitions/oam-networks"
47257 az-and-dvs-switches:
47260 $ref: "#/definitions/az-and-dvs-switches"
47263 edge-tag-query-result:
47265 $ref: "#/definitions/edge-tag-query-result"
47266 edge-tag-query-request:
47268 $ref: "#/definitions/edge-tag-query-request"
47271 $ref: "#/definitions/search-results"
47274 $ref: "#/definitions/sdn-zone-response"
47280 $ref: "#/definitions/result-data"
47283 SecondaryFilt for performing a named-query or model query
47294 SecondaryFilts for performing a named-query or model query
47299 $ref: "#/definitions/secondary-filt"
47300 segmentation-assignment:
47302 Openstack segmentation assignment.
47303 ###### Related Nodes
47304 - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
47310 description: Route Table Reference id, UUID assigned to this instance.
47313 description: Concurrency value
47317 $ref: "#/definitions/relationship"
47318 segmentation-assignments:
47320 Collection of openstack segmentation assignments
47322 segmentation-assignment:
47325 $ref: "#/definitions/segmentation-assignment"
47328 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC.
47331 - service-description
47335 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
47336 service-description:
47338 description: Description of the service
47341 description: URL to endpoint where AAI can get more details
47344 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47347 description: service version
47351 $ref: "#/definitions/relationship"
47352 service-capabilities:
47354 Collection of service capabilities.
47356 service-capability:
47359 $ref: "#/definitions/service-capability"
47360 service-capability:
47362 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
47363 ###### Related Nodes
47364 - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
47365 - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
47366 - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
47373 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
47376 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
47379 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47383 $ref: "#/definitions/relationship"
47384 service-design-and-creation:
47386 Namespace for objects managed by ASDC
47391 $ref: "#/definitions/vnf-image"
47395 $ref: "#/definitions/service"
47396 service-capabilities:
47399 $ref: "#/definitions/service-capability"
47403 $ref: "#/definitions/model"
47407 $ref: "#/definitions/named-query"
47410 Instance of a service
47411 ###### Related Nodes
47412 - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
47413 - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
47414 - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
47415 - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
47416 - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
47417 - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
47418 - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
47419 - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
47420 - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
47421 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
47422 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
47423 - SERVICE-INSTANCE is DELETED when these are DELETED METADATUM
47424 - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
47426 - service-instance-id
47428 service-instance-id:
47430 description: Uniquely identifies this instance of a service
47431 service-instance-name:
47433 description: This field will store a name assigned to the service-instance.
47436 description: the ASDC model id for this resource or service model.
47437 persona-model-version:
47439 description: the ASDC model version for this resource or service model.
47442 description: the ASDC model version for this resource or service model.
47445 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
47446 widget-model-version:
47448 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
47451 description: Indicates the total bandwidth to be used for this service.
47454 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
47455 bandwidth-down-wan1:
47457 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
47460 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
47461 bandwidth-down-wan2:
47463 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
47466 description: URL customers will use to access the vHN Portal.
47467 service-instance-location-id:
47469 description: An identifier that customers assign to the location where this service is being used.
47472 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47476 $ref: "#/definitions/relationship"
47480 $ref: "#/definitions/metadatum"
47483 Collection of service instances
47488 $ref: "#/definitions/service-instance"
47489 service-subscription:
47491 Object that group service instances.
47492 ###### Related Nodes
47493 - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
47494 - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
47495 - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
47496 - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
47502 description: Value defined by orchestration to identify this service across ECOMP.
47503 temp-ub-sub-account-id:
47505 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
47508 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47512 $ref: "#/definitions/service-instance"
47516 $ref: "#/definitions/relationship"
47517 service-subscriptions:
47519 Collection of objects that group service instances.
47521 service-subscription:
47524 $ref: "#/definitions/service-subscription"
47527 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
47532 $ref: "#/definitions/service"
47535 ###### Related Nodes
47536 - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
47537 - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
47538 - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
47544 description: unique identifier of probe
47547 description: Prefix address
47550 description: Prefix address
47553 description: ip version, v4, v6
47554 destination-hostname:
47556 description: Hostname of the destination equipment to which SLAs are measured against.
47557 destination-equip-type:
47559 description: The type of destinatination equipment. Could be Router, etc.
47562 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47563 classes-of-service:
47566 $ref: "#/definitions/class-of-service"
47570 $ref: "#/definitions/relationship"
47573 Set of instances for probes used to measure service level agreements
47574 ###### Related Nodes
47575 - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
47576 - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
47577 - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
47583 description: Unique id of site pair set.
47586 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47590 $ref: "#/definitions/routing-instance"
47594 $ref: "#/definitions/relationship"
47597 Collection of sets of instances for probes related to generic-vnf
47602 $ref: "#/definitions/site-pair-set"
47610 $ref: "#/definitions/site-pair"
47614 ###### Related Nodes
47615 - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
47616 - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
47622 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
47625 description: Snapshot name
47626 snapshot-architecture:
47628 description: Operating system architecture
47629 snapshot-os-distro:
47631 description: The common name of the operating system distribution in lowercase
47632 snapshot-os-version:
47634 description: The operating system version as specified by the distributor.
47637 description: The application that the image instantiates.
47638 application-vendor:
47640 description: The vendor of the application.
47641 application-version:
47643 description: The version of the application.
47646 description: URL to endpoint where AAI can get more details
47649 description: This field contains the UUID of the previous snapshot (if any).
47652 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47656 $ref: "#/definitions/relationship"
47659 Collection of openstack snapshots
47664 $ref: "#/definitions/snapshot"
47667 SR-IOV Physical Function
47668 ###### Related Nodes
47669 - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
47670 - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
47676 description: Identifier for the sriov-pf
47679 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47683 $ref: "#/definitions/relationship"
47686 Collection of SR-IOV Physical Functions.
47691 $ref: "#/definitions/sriov-pf"
47694 SR-IOV Virtual Function (not to be confused with virtual network function)
47695 ###### Related Nodes
47696 - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
47702 description: PCI ID used to identify the sriov-vf
47705 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
47708 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
47711 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
47712 vf-vlan-anti-spoof-check:
47714 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.
47715 vf-mac-anti-spoof-check:
47717 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.
47720 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
47721 vf-broadcast-allow:
47723 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
47724 vf-unknown-multicast-allow:
47726 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
47727 vf-unknown-unicast-allow:
47729 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
47732 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
47735 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
47738 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47739 neutron-network-id:
47741 description: Neutron network id of the interface
47745 $ref: "#/definitions/relationship"
47748 Collection of SR-IOV Virtual Functions.
47753 $ref: "#/definitions/sriov-vf"
47762 ###### Related Nodes
47763 - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
47764 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
47765 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
47766 - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
47773 description: Subnet ID, should be UUID.
47776 description: Name associated with the subnet.
47779 description: Neutron id of this subnet
47782 description: gateway ip address
47783 network-start-address:
47785 description: network start address
47788 description: cidr mask
47791 description: ip version
47792 orchestration-status:
47794 description: Orchestration status of this VNF, mastered by MSO
47799 description: the start address reserved for use by dhcp
47802 description: the last address reserved for use by dhcp
47805 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47809 $ref: "#/definitions/relationship"
47815 $ref: "#/definitions/subnet"
47816 tagged-inventory-item-list:
47821 $ref: "#/definitions/inventory-item"
47825 ###### Related Nodes
47826 - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
47827 - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
47828 - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
47829 - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
47830 - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
47831 - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
47832 - TENANT cannot be deleted if linked to VSERVER
47839 description: Unique id relative to the cloud-region.
47842 description: Readable name of tenant
47845 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47849 $ref: "#/definitions/vserver"
47853 $ref: "#/definitions/relationship"
47856 Collection of openstack tenants.
47861 $ref: "#/definitions/tenant"
47864 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
47865 ###### Related Nodes
47866 - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
47869 - bandwidth-up-wan1
47870 - bandwidth-down-wan1
47871 - bandwidth-up-wan2
47872 - bandwidth-down-wan2
47876 description: Allotted Resource id UUID assigned to this instance.
47879 description: The WAN uplink bandwidth for WAN1
47880 bandwidth-down-wan1:
47882 description: The WAN downlink bandwidth for WAN1
47885 description: The WAN uplink bandwidth for WAN2
47886 bandwidth-down-wan2:
47888 description: The WAN downlink bandwidth for WAN2
47891 description: Concurrency value
47895 $ref: "#/definitions/relationship"
47898 This object is used to store the specific tunnel cross connect aspects of an allotted resource
47903 $ref: "#/definitions/tunnel-xconnect"
47906 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
47915 $ref: "#/definitions/update-node-key"
47921 $ref: "#/definitions/action"
47930 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
47931 ###### Related Nodes
47932 - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
47933 - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
47934 - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
47935 - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
47936 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
47937 - VCE is DELETED when these are DELETED PORT-GROUP
47945 description: Unique id of VNF. This is unique across the graph.
47948 description: Name of VNF.
47951 description: Alternate name of VNF.
47954 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
47957 description: Unique identifier of service from ASDC. Expect this to change as ASDC matures.
47958 regional-resource-zone:
47960 description: Regional way of organizing pservers, source of truth should define values
47963 description: Trigger for operational monitoring of this resource by Service Assurance systems.
47966 description: Indicator for whether the resource is considered operational
47969 description: License key
47972 description: Network role being played by this VNF
47973 orchestration-status:
47975 description: Orchestration status of this VNF, mastered by MSO
47978 description: Heat stack id corresponding to this instance, managed by MSO
47981 description: Corresponds to the SDN-C catalog id used to configure this VCE
47984 description: Unique ID of VPE connected to this VCE.
47985 v6-vce-wan-address:
47987 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
47990 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
47993 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47994 ipv4-loopback0-address:
47996 description: Loopback0 address
47997 entitlement-resource-uuid:
47999 description: Entitlement resource uuid
48003 $ref: "#/definitions/port-group"
48007 $ref: "#/definitions/relationship"
48010 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
48015 $ref: "#/definitions/vce"
48018 a deployment unit of VNFCs
48019 ###### Related Nodes
48020 - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
48021 - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
48022 - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
48023 - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
48024 - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
48025 - VF-MODULE cannot be deleted if linked to VNFC
48028 - is-base-vf-module
48032 description: Unique ID of vf-module.
48035 description: Name of vf-module
48038 description: Heat stack id corresponding to this instance.
48039 orchestration-status:
48041 description: orchestration status of this vf-module, mastered by MSO
48046 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48049 description: the ASDC model id for this resource or service model.
48050 persona-model-version:
48052 description: the ASDC model version for this resource or service model.
48055 description: the ASDC model version for this resource or service model.
48058 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
48059 widget-model-version:
48061 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
48062 contrail-service-instance-fqdn:
48064 description: the Contrail unique ID for a service-instance
48068 $ref: "#/definitions/relationship"
48071 Collection of vf-modules, a deployment unit of VNFCs
48076 $ref: "#/definitions/vf-module"
48079 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
48080 ###### Related Nodes
48081 - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
48087 description: indicates whether the VIG is for AVPN or INTERNET
48090 description: v4 IP of the vig server
48093 description: v6 IP of the vig server
48096 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48100 $ref: "#/definitions/relationship"
48106 $ref: "#/definitions/vig-server"
48107 vip-ipv4-address-list:
48110 ###### Related Nodes
48111 - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48112 - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
48113 - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
48114 - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
48120 description: IP address
48121 vip-ipv4-prefix-length:
48124 description: Prefix length, 32 for single address
48128 description: Inner VLAN tag
48132 description: Outer VLAN tag
48135 description: Indicator of fixed or floating address
48138 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48139 neutron-network-id:
48141 description: Neutron network id of the interface that address belongs to
48144 description: Neutron id of subnet that address belongs to
48148 $ref: "#/definitions/relationship"
48149 vip-ipv6-address-list:
48152 ###### Related Nodes
48153 - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48154 - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
48155 - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
48156 - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
48162 description: IP address
48163 vip-ipv6-prefix-length:
48166 description: Prefix length, 128 for single address
48170 description: Inner VLAN tag
48174 description: Outer VLAN tag
48177 description: Indicator of fixed or floating address
48180 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48181 neutron-network-id:
48183 description: Neutron network id of the interface that address belongs to
48186 description: Neutron id of subnet that address belongs to
48190 $ref: "#/definitions/relationship"
48191 virtual-data-center:
48193 Virtual organization of cloud infrastructure elements in a data center context
48194 ###### Related Nodes
48195 - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
48196 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
48197 - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
48204 description: Unique ID of the vdc
48207 description: Name of the virtual data center
48210 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48214 $ref: "#/definitions/relationship"
48215 virtual-data-centers:
48217 Virtual organization of cloud infrastructure elements in a data center context
48219 virtual-data-center:
48222 $ref: "#/definitions/virtual-data-center"
48226 ###### Related Nodes
48227 - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
48228 - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
48229 - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
48230 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
48231 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
48232 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
48233 - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
48234 - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
48240 description: String that identifies the interface
48244 description: Inner VLAN tag
48248 description: Outer VLAN tag
48251 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48254 description: Captures the numeric part of the speed
48257 description: Captures the units corresponding to the speed
48260 description: Used to describe (the service associated with) the vlan
48261 backdoor-connection:
48263 description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
48266 description: This indicates the customers VPN ID associated with this vlan
48270 $ref: "#/definitions/relationship"
48271 l3-interface-ipv4-address-list:
48274 $ref: "#/definitions/l3-interface-ipv4-address-list"
48275 l3-interface-ipv6-address-list:
48278 $ref: "#/definitions/l3-interface-ipv6-address-list"
48284 $ref: "#/definitions/vlan"
48293 description: Unique id of VNF. This is unique across the graph.
48296 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
48297 ###### Related Nodes
48298 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
48299 - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
48303 - application-vendor
48307 description: Unique ID of this asset
48310 description: The application that the image instantiates.
48311 application-vendor:
48313 description: The vendor of the application.
48314 application-version:
48316 description: The version of the application.
48319 description: URL to endpoint where AAI can get more details
48322 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48326 $ref: "#/definitions/relationship"
48329 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
48334 $ref: "#/definitions/vnf-image"
48337 ###### Related Nodes
48338 - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
48339 - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
48340 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
48343 - vnfc-function-code
48346 - is-closed-loop-disabled
48350 description: Unique ID of vnfc.
48351 vnfc-function-code:
48353 description: function code
48359 description: prov status of this vnfc
48360 orchestration-status:
48362 description: Orchestration status of this VNF, mastered by APP-C
48363 ipaddress-v4-oam-vip:
48365 description: Oam V4 vip address of this vnfc
48368 is-closed-loop-disabled:
48372 description: Group notation of VNFC
48375 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48379 $ref: "#/definitions/relationship"
48382 virtual network components associated with a vserver from application controller.
48387 $ref: "#/definitions/vnfc"
48390 Ephemeral Block storage volume.
48391 ###### Related Nodes
48392 - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
48399 description: Unique ID of block storage volume relative to the vserver.
48402 description: URL to endpoint where AAI can get more details
48405 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48409 $ref: "#/definitions/relationship"
48412 Persistent block-level storage.
48413 ###### Related Nodes
48414 - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48415 - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48416 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
48417 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
48418 - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
48421 - volume-group-name
48426 description: Unique ID of volume-group.
48429 description: Name of the volume group.
48432 description: Heat stack id corresponding to this volume-group
48435 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
48436 orchestration-status:
48438 description: Orchestration status of this volume-group
48441 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48445 $ref: "#/definitions/relationship"
48448 Collection of persistent block-level storage.
48453 $ref: "#/definitions/volume-group"
48456 Collection of ephemeral Block storage volumes.
48461 $ref: "#/definitions/volume"
48464 VPLS Provider Edge routers.
48465 ###### Related Nodes
48466 - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48467 - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
48468 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
48469 - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
48470 - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
48478 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
48481 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).
48484 description: Client should send valid enumerated value, e.g., VPLS-PE.
48488 description: Temporary location for stag to get to VCE
48491 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48495 $ref: "#/definitions/relationship"
48499 $ref: "#/definitions/p-interface"
48503 $ref: "#/definitions/lag-interface"
48506 Collection of VPLS Provider Edge routers
48511 $ref: "#/definitions/vpls-pe"
48515 ###### Related Nodes
48516 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
48517 - VPN-BINDING cannot be deleted if linked to L3-NETWORK
48521 - global-route-target
48525 description: VPN ID, globally unique within A&AI
48528 description: VPN Name
48529 global-route-target:
48531 description: Number used to identify a VPN, globally unique in the network
48534 description: the platform associated with the VPN example AVPN, Mobility
48537 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48541 $ref: "#/definitions/relationship"
48542 description: l3-networks relate to vpn-bindings
48548 $ref: "#/definitions/vpn-binding"
48551 Virtual Servers, aka virtual machine or VM.
48552 ###### Related Nodes
48553 - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
48554 - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
48555 - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
48556 - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
48557 - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
48558 - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
48559 - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
48560 - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
48561 - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
48562 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
48563 - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
48564 - VSERVER is DELETED when these are DELETED L-INTERFACE
48565 - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
48571 - is-closed-loop-disabled
48575 description: Unique identifier for this vserver relative to its tenant
48578 description: Name of vserver
48581 description: Alternative name of vserver
48584 description: Trigger for operational monitoring of this resource by Service Assurance systems.
48587 description: URL to endpoint where AAI can get more details
48590 is-closed-loop-disabled:
48594 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48598 $ref: "#/definitions/volume"
48602 $ref: "#/definitions/relationship"
48606 $ref: "#/definitions/l-interface"
48609 Collection of virtual Servers, aka virtual machines or VMs.
48614 $ref: "#/definitions/vserver"
48617 A zone is a grouping of assets in a location homing to the same connections into the CBB
48618 ###### Related Nodes
48619 - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48620 - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
48621 - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
48622 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
48631 description: Code assigned by AIC to the zone
48634 description: English name associated with the zone
48637 description: Design of zone [Medium/Large?]
48640 description: Context of zone [production/test]
48643 description: Status of a zone.
48646 description: Concurrency value
48650 $ref: "#/definitions/relationship"
48653 Collection of zones
48658 $ref: "#/definitions/zone"
48673 $ref: "#/patchDefinitions/action-data"
48682 APIs that are more action related than REST (e.g., notify, update).
48686 $ref: "#/patchDefinitions/update"
48689 $ref: "#/patchDefinitions/notify"
48692 Represents a slice or partial piece of a resource that gets separately allotted
48693 ###### Related Nodes
48694 - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
48695 - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
48696 - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
48697 - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
48698 - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
48699 - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
48700 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
48701 - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
48707 description: Allotted Resource id UUID assigned to this instance.
48710 description: The descriptive information assigned to this allotted resource instance
48713 description: Link back to more information in the controller
48716 description: the ASDC model id for this resource or service model.
48717 persona-model-version:
48719 description: the ASDC model version for this resource or service model.
48722 description: the ASDC model version for this resource or service model.
48723 persona-model-customization-id:
48725 description: captures the id of all the configuration used to customize the resource for the service.
48726 allotted-resources:
48728 This object is used to store slices of services being offered
48733 $ref: "#/patchDefinitions/allotted-resource"
48736 Availability zone, a collection of compute hosts/pservers
48737 ###### Related Nodes
48738 - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48739 - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
48740 - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48741 - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
48742 - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
48743 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
48744 - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
48745 - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
48746 - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
48748 - availability-zone-name
48751 availability-zone-name:
48753 description: Name of the availability zone. Unique across a cloud region
48756 description: Type of hypervisor. Source of truth should define valid values.
48759 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
48760 availability-zones:
48762 Collection of availability zones
48767 $ref: "#/patchDefinitions/availability-zone"
48768 az-and-dvs-switches:
48772 $ref: "#/patchDefinitions/dvs-switches"
48775 $ref: "#/patchDefinitions/availability-zone"
48778 Namespace for business related constructs
48783 $ref: "#/patchDefinitions/connector"
48787 $ref: "#/patchDefinitions/customer"
48790 ###### Related Nodes
48791 - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
48797 description: unique identifier of probe
48800 description: identifier of probe
48803 description: type of probe
48804 classes-of-service:
48806 class-of-service of probe
48811 $ref: "#/patchDefinitions/class-of-service"
48812 cloud-infrastructure:
48814 Namespace for cloud infrastructure.
48819 $ref: "#/patchDefinitions/complex"
48823 $ref: "#/patchDefinitions/cloud-region"
48827 $ref: "#/patchDefinitions/network-profile"
48831 $ref: "#/patchDefinitions/pserver"
48832 virtual-data-centers:
48835 $ref: "#/patchDefinitions/virtual-data-center"
48838 cloud-region designates an installation of a cloud cluster or region or instantiation.
48839 ###### Related Nodes
48840 - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48841 - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
48842 - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48843 - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48844 - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48845 - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48846 - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48847 - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48848 - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48849 - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48850 - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48851 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
48852 - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
48853 - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
48860 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
48863 description: Identifier used by the vendor for the region. Second part of composite key
48866 description: Type of the cloud (e.g., openstack)
48867 owner-defined-type:
48869 description: Cloud-owner defined type indicator (e.g., DCP, LCP)
48870 cloud-region-version:
48872 description: Software version employed at the site
48875 description: URL of the keystone identity service
48878 description: Zone where the cloud is homed
48881 description: complex name for cloud-region instance
48887 $ref: "#/patchDefinitions/cloud-region"
48890 Collection of physical locations that can house cloud-regions.
48891 ###### Related Nodes
48892 - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
48893 - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48894 - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48895 - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
48896 - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
48897 - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48898 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48899 - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
48900 - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48901 - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48902 - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE
48903 - COMPLEX is DELETED when these are DELETED CTAG-POOL
48905 - physical-location-id
48906 - physical-location-type
48913 physical-location-id:
48915 description: Unique identifier for physical location, e.g., CLLI
48918 description: Data center code which can be an alternate way to identify a complex
48921 description: Gamma complex name for LCP instance.
48924 description: URL of the keystone identity service
48927 Collection of physical locations that can house cloud-regions.
48932 $ref: "#/patchDefinitions/complex"
48935 Port Mirror Configuration.
48936 ###### Related Nodes
48937 - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
48938 - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
48939 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
48940 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
48941 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
48942 - CONFIGURATION is DELETED when these are DELETED METADATUM
48943 - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
48946 - configuration-type
48947 - configuration-sub-type
48948 - orchestration-status
48949 - operational-status
48950 - configuration-selflink
48951 - model-customization-id
48955 description: UUID assigned to configuration.
48958 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
48959 configuration-name:
48961 description: Name of the configuration.
48962 configuration-type:
48964 description: port-mirroring-configuration.
48965 configuration-sub-type:
48967 description: vprobe, pprobe.
48968 model-invariant-id:
48970 description: the ASDC model id for this resource or service model.
48973 description: the ASDC model version for this resource or service model.
48974 orchestration-status:
48976 description: Orchestration status of the configuration.
48977 operational-status:
48979 description: Indicator for whether the resource is considered operational.
48980 configuration-selflink:
48982 description: URL to endpoint where AAI can get more details from SDN-GC.
48983 model-customization-id:
48985 description: id of the configuration used to customize the resource
48988 Collection of configurations
48993 $ref: "#/patchDefinitions/configuration"
48996 Collection of resource instances used to connect a variety of disparate inventory widgets
48997 ###### Related Nodes
48998 - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
48999 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
49000 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
49001 - CONNECTOR is DELETED when these are DELETED METADATUM
49003 - resource-instance-id
49005 resource-instance-id:
49007 description: Unique id of resource instance.
49010 Collection of resource instances used to connect a variety of disparate inventory widgets
49015 $ref: "#/patchDefinitions/connector"
49016 constrained-element-set:
49018 This is how we would capture constraints defining allowed sets of elements.
49019 ###### Related Nodes
49020 - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
49021 - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
49022 - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
49023 - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
49025 - constrained-element-set-uuid
49029 constrained-element-set-uuid:
49035 constrained-element-sets:
49037 constrained-element-set:
49040 $ref: "#/patchDefinitions/constrained-element-set"
49043 ###### Related Nodes
49044 - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
49057 $ref: "#/patchDefinitions/ctag-assignment"
49060 A collection of C tags (vlan tags) grouped for a specific purpose.
49061 ###### Related Nodes
49062 - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
49063 - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
49064 - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
49067 - availability-zone-name
49068 - ctag-pool-purpose
49072 description: The Target provider edge router
49073 availability-zone-name:
49075 description: Name of the availability zone
49078 description: Describes what the intended purpose of this pool is.
49081 description: Comma separated list of ctags
49087 $ref: "#/patchDefinitions/ctag-pool"
49090 customer identifiers to provide linkage back to BSS information.
49091 ###### Related Nodes
49092 - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
49093 - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
49095 - global-customer-id
49099 global-customer-id:
49101 description: Global customer id used across ECOMP to uniquely identify customer.
49104 description: Subscriber name, an alternate way to retrieve a customer.
49107 description: Subscriber type, a way to provide VID with only the INFRA customers.
49110 Collection of customer identifiers to provide linkage back to BSS information.
49115 $ref: "#/patchDefinitions/customer"
49123 description: See mis-na-virtualization-platform.yang
49129 $ref: "#/patchDefinitions/cvlan-tag-entry"
49132 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.
49133 ###### Related Nodes
49134 - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
49135 - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
49142 description: DVS switch name
49145 description: URL used to reach the vcenter
49148 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
49153 $ref: "#/patchDefinitions/dvs-switch"
49156 Internal map to define the properties of an edge and interpret the map EdgeRules
49174 edge-tag-query-request:
49185 $ref: "#/patchDefinitions/start-node-filter"
49186 include-node-filter:
49189 $ref: "#/patchDefinitions/include-node-filter"
49193 $ref: "#/patchDefinitions/secondary-filter"
49194 edge-tag-query-result:
49196 tagged-inventory-item-list:
49199 $ref: "#/patchDefinitions/tagged-inventory-item-list"
49200 element-choice-set:
49202 This is how we would capture constraints defining allowed sets of elements.
49203 ###### Related Nodes
49204 - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
49205 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
49206 - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
49208 - element-choice-set-uuid
49209 - element-choice-set-name
49211 element-choice-set-uuid:
49213 element-choice-set-name:
49217 element-choice-sets:
49219 element-choice-set:
49222 $ref: "#/patchDefinitions/element-choice-set"
49225 Metadata for entitlement group.
49226 ###### Related Nodes
49227 - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49228 - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
49235 description: Unique ID for the entitlement group the resource comes from, should be uuid.
49238 description: Unique ID of an entitlement resource.
49241 Entitlements, keyed by group-uuid and resource-uuid, related to license management
49246 $ref: "#/patchDefinitions/entitlement"
49249 Persist EMS address information used by EMS driver.
49250 ###### Related Nodes
49251 - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
49252 - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
49258 description: Unique ID of EMS.
49264 $ref: "#/patchDefinitions/esr-ems"
49267 Persist common address information of external systems.
49268 ###### Related Nodes
49269 - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
49270 - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
49271 - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
49272 - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
49274 - esr-system-info-id
49279 esr-system-info-id:
49281 description: Unique ID of esr system info.
49284 description: name of external system.
49287 description: type of external systems.
49290 description: vendor of external systems.
49293 description: version of external systems.
49296 description: url used to access external systems.
49299 description: username used to access external systems.
49302 description: password used to access external systems.
49305 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
49308 description: protocol of third party SDNC, for example netconf/snmp.
49311 description: ca file content if enabled ssl on auth-url.
49314 description: Whether to verify VIM's certificate.
49317 description: service IP of ftp server.
49320 description: service port of ftp server.
49323 description: domain info for authentication.
49326 description: default tenant of VIM.
49329 description: ftp passive mode or not.
49332 description: resource or performance data file path.
49335 description: the status of external system.
49336 esr-system-info-list:
49338 Collection of persistent block-level external system auth info.
49343 $ref: "#/patchDefinitions/esr-system-info"
49344 esr-thirdparty-sdnc:
49346 Persist SDNC address information used by ONAP SDNC.
49347 ###### Related Nodes
49348 - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
49349 - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
49350 - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
49352 - thirdparty-sdnc-id
49354 thirdparty-sdnc-id:
49356 description: Unique ID of SDNC.
49359 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
49362 description: password used to access SDNC server.
49363 esr-thirdparty-sdnc-list:
49365 esr-thirdparty-sdnc:
49368 $ref: "#/patchDefinitions/esr-thirdparty-sdnc"
49371 Persist VNFM address information used by VF-C.
49372 ###### Related Nodes
49373 - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
49374 - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
49380 description: Unique ID of VNFM.
49383 description: indecate the VIM to deploy VNF.
49386 description: certificate url of VNFM.
49392 $ref: "#/patchDefinitions/esr-vnfm"
49395 evc object is an optional child object of the Configuration object.
49396 ###### Related Nodes
49397 - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
49403 description: Unique/key field for the evc object
49404 forwarding-path-topology:
49406 description: Point-to-Point, Multi-Point
49409 description: Commited Information Rate
49412 description: CIR units
49413 connection-diversity-group-id:
49415 description: Diversity Group ID
49418 description: formerly Performance Group
49419 esp-evc-circuit-id:
49421 description: EVC Circuit ID of ESP EVC
49424 description: Committed Information Rate (For ESP)
49427 description: CIR units (For ESP)
49430 description: Identifies ESP
49431 collector-pop-clli:
49433 description: Collector POP CLLI (from the hostname of the access pnf)
49434 inter-connect-type-ingress:
49436 description: Interconnect type on ingress side of EVC.
49437 tagmode-access-ingress:
49439 description: tagode for collector side of EVC
49440 tagmode-access-egress:
49442 description: tagMode for network side of EVC
49448 $ref: "#/patchDefinitions/evc"
49451 Namespace for external system.
49455 $ref: "#/patchDefinitions/esr-ems-list"
49458 $ref: "#/patchDefinitions/esr-vnfm-list"
49459 esr-thirdparty-sdnc-list:
49461 $ref: "#/patchDefinitions/esr-thirdparty-sdnc-list"
49464 Extra properties for inventory item for response list
49472 ###### Related Nodes
49473 - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
49474 - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
49475 - FLAVOR cannot be deleted if linked to VSERVER
49483 description: Flavor id, expected to be unique across cloud-region.
49486 description: Flavor name
49490 description: Number of CPUs
49494 description: Amount of memory
49498 description: Disk space
49502 description: Amount of ephemeral disk space
49505 description: amount of swap space allocation
49508 description: whether flavor is available to all users or private to the tenant it was created in.
49511 description: URL to endpoint where AAI can get more details
49514 description: Boolean as to whether this flavor is no longer enabled
49517 Collection of openstack flavors.
49522 $ref: "#/patchDefinitions/flavor"
49525 Entity describing a sequenced segment of forwarding path
49526 ###### Related Nodes
49527 - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
49528 - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
49529 - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
49530 - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
49531 - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
49532 - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
49539 description: Unique ID of this segmentation
49542 description: ingress, intermediate, egress
49545 forwarder object is an optional child object of the Configuration object.
49546 ###### Related Nodes
49547 - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
49553 description: Key for forwarder-evc object
49556 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
49559 description: Internal VLAN.
49562 description: SVLAN value for ingress of egress forwarder.
49565 description: CVLAN value for ingress of egress forwarder.
49571 $ref: "#/patchDefinitions/forwarder-evc"
49577 $ref: "#/patchDefinitions/forwarder"
49580 Entity that describes the sequenced forwarding path between interfaces of services or resources
49581 ###### Related Nodes
49582 - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
49583 - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
49584 - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
49585 - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
49586 - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
49588 - forwarding-path-id
49589 - forwarding-path-name
49591 forwarding-path-id:
49593 description: Unique ID of this FP
49594 forwarding-path-name:
49596 description: Name of the FP
49602 $ref: "#/patchDefinitions/forwarding-path"
49605 General purpose VNF
49606 ###### Related Nodes
49607 - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
49608 - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
49609 - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
49610 - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
49611 - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
49612 - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
49613 - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
49614 - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
49615 - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
49616 - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49617 - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49618 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49619 - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
49620 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
49621 - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
49622 - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49623 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
49624 - GENERIC-VNF is DELETED when these are DELETED VNFC,LAG-INTERFACE,L-INTERFACE,VF-MODULE
49630 - is-closed-loop-disabled
49634 description: Unique id of VNF. This is unique across the graph.
49637 description: Name of VNF.
49640 description: Alternate name of VNF.
49643 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
49646 description: Unique identifier of service from ASDC
49647 regional-resource-zone:
49649 description: Regional way of organizing pservers, source of truth should define values
49652 description: Trigger for operational monitoring of this resource by Service Assurance systems.
49655 description: Indicator for whether the resource is considered operational
49658 description: License key
49661 description: Client should send valid enumerated value
49662 orchestration-status:
49664 description: Orchestration status of this VNF, used by MSO.
49667 description: Heat stack id corresponding to this instance, managed by MSO
49670 description: Corresponds to the SDN-C catalog id used to configure this VCE
49673 description: identifier of managed by company or customer
49676 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
49677 ipv4-loopback0-address:
49679 description: v4 Loopback0 address
49682 description: v6 Loopback address
49683 management-v6-address:
49685 description: v6 management address
49689 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors
49692 description: units associated with vcpu, used for VNFs with no vservers/flavors
49696 description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors
49699 description: units associated with vmemory, used for VNFs with no vservers/flavors
49703 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors
49706 description: units associated with vdisk, used for VNFs with no vservers/flavors
49709 is-closed-loop-disabled:
49718 $ref: "#/patchDefinitions/generic-vnf"
49721 Openstack group-assignment used to store exclusivity groups (EG).
49722 ###### Related Nodes
49723 - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
49724 - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
49725 - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
49733 description: Group id, expected to be unique across cloud-region.
49736 description: Group type - the type of group this instance refers to
49739 description: Group name - name assigned to the group
49742 description: Group description - description of the group
49745 Collection of openstack group assignments
49750 $ref: "#/patchDefinitions/group-assignment"
49753 ###### Related Nodes
49754 - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
49762 description: host-route id
49765 description: subnet prefix
49768 description: Could be ip-address, hostname, or service-instance
49771 description: Should be ip-address, hostname, or service-instance to match next-hop
49777 $ref: "#/patchDefinitions/host-route"
49781 ###### Related Nodes
49782 - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
49783 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
49784 - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
49785 - IMAGE cannot be deleted if linked to VSERVER
49786 - IMAGE is DELETED when these are DELETED METADATUM
49796 description: Image id, expected to be unique across cloud region
49799 description: Image name
49800 image-architecture:
49802 description: Operating system architecture.
49805 description: The common name of the operating system distribution in lowercase
49808 description: The operating system version as specified by the distributor.
49811 description: The application that the image instantiates.
49812 application-vendor:
49814 description: The vendor of the application.
49815 application-version:
49817 description: The version of the application.
49820 description: URL to endpoint where AAI can get more details
49823 Collectio of Openstack images.
49828 $ref: "#/patchDefinitions/image"
49829 include-node-filter:
49835 InstanceFilter for performing a named-query or model query
49838 InstanceFilters for performing a named-query or model query
49843 $ref: "#/patchDefinitions/instance-filter"
49846 General mechanism for grouping instances
49847 ###### Related Nodes
49848 - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
49849 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
49850 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
49851 - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
49852 - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
49860 description: Instance Group ID, UUID assigned to this instance.
49863 description: Descriptive text to help identify the usage of this instance-group
49866 description: Only valid value today is lower case ha for high availability
49869 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
49872 Collection of openstack route table references
49877 $ref: "#/patchDefinitions/instance-group"
49882 $ref: "#/patchDefinitions/search"
49885 $ref: "#/patchDefinitions/actions"
49886 cloud-infrastructure:
49888 $ref: "#/patchDefinitions/cloud-infrastructure"
49891 $ref: "#/patchDefinitions/business"
49892 service-design-and-creation:
49894 $ref: "#/patchDefinitions/service-design-and-creation"
49897 $ref: "#/patchDefinitions/network"
49900 $ref: "#/patchDefinitions/aai-internal"
49903 inventory-item-type:
49905 inventory-item-link:
49907 inventory-item-data:
49910 $ref: "#/patchDefinitions/inventory-item-data"
49911 tagged-inventory-item-list:
49914 $ref: "#/patchDefinitions/tagged-inventory-item-list"
49915 inventory-item-data:
49921 inventory-response-item:
49923 Inventory item for response list
49929 $ref: "#/patchDefinitions/extra-properties"
49930 inventory-response-items:
49932 $ref: "#/patchDefinitions/inventory-response-items"
49933 inventory-response-items:
49935 Container for inventory items in response list
49937 inventory-response-item:
49940 $ref: "#/patchDefinitions/inventory-response-item"
49941 ipsec-configuration:
49943 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
49944 ###### Related Nodes
49945 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
49946 - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
49947 - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
49949 - ipsec-configuration-id
49951 ipsec-configuration-id:
49953 description: UUID of this configuration
49954 requested-vig-address-type:
49956 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
49957 requested-encryption-strength:
49959 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
49960 requested-dmz-type:
49962 description: can offer a shared DMZ or a DMZ specific to a customer
49963 shared-dmz-network-address:
49965 description: Network address of shared DMZ
49966 requested-customer-name:
49968 description: If the DMZ is a custom DMZ, this field will indicate the customer information
49971 description: can be 1 or 2
49972 ikev1-authentication:
49974 description: Contains values like md5, sha1, sha256, sha384
49977 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
49980 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
49983 description: Group name defined in VIG for clients using aggressive mode
49986 description: pre-shared key for the above group name
49989 description: Lifetime for IKEv1 SA
49990 ipsec-authentication:
49992 description: md5, sha1, sha256, sha384
49995 description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
49998 description: Life time for IPSec SA
50001 description: enable PFS or not
50004 description: user ID for xAuth, sm-user, ,nmteHostName
50005 xauth-user-password:
50007 description: Encrypted using the Juniper $9$ algorithm
50010 description: The time between DPD probe
50013 description: Maximum number of DPD before claiming the tunnel is down
50014 ipsec-configurations:
50016 ipsec-configuration:
50019 $ref: "#/patchDefinitions/ipsec-configuration"
50028 Logical interfaces, e.g., a vnic.
50029 ###### Related Nodes
50030 - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
50031 - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
50032 - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
50033 - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
50034 - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
50035 - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
50036 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
50037 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
50038 - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
50039 - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
50040 - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
50041 - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
50047 description: Name given to the interface
50050 description: E.g., CUSTOMER, UPLINK, etc.
50053 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
50056 description: URL to endpoint where AAI can get more details
50059 description: ID of interface
50062 description: MAC address for the interface
50065 description: Name of the network
50068 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
50071 Collection of logical interfaces.
50076 $ref: "#/patchDefinitions/l-interface"
50077 l3-interface-ipv4-address-list:
50080 ###### Related Nodes
50081 - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
50082 - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
50083 - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
50084 - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
50086 - l3-interface-ipv4-address
50088 l3-interface-ipv4-address:
50090 description: IP address
50091 l3-interface-ipv4-prefix-length:
50094 description: Prefix length, 32 for single address
50098 description: Inner VLAN tag
50102 description: Outer VLAN tag
50105 description: Indicator of fixed or floating address
50106 l3-interface-ipv6-address-list:
50109 ###### Related Nodes
50110 - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
50111 - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
50112 - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
50113 - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
50115 - l3-interface-ipv6-address
50117 l3-interface-ipv6-address:
50119 description: IP address
50120 l3-interface-ipv6-prefix-length:
50123 description: Prefix length, 128 for single address
50127 description: Inner VLAN tag
50131 description: Outer VLAN tag
50134 description: Indicator of fixed or floating address
50137 Generic network definition
50138 ###### Related Nodes
50139 - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
50140 - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
50141 - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
50142 - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
50143 - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
50144 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
50145 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
50146 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
50147 - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
50148 - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
50149 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
50150 - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
50151 - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
50152 - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
50153 - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
50158 - is-provider-network
50159 - is-shared-network
50160 - is-external-network
50164 description: Network ID, should be uuid. Unique across A&AI.
50167 description: Name of the network, governed by some naming convention..
50170 description: Type of the network - who defines these values?
50173 description: Role the network plans - who defines these values?
50174 network-technology:
50176 description: Network technology - who defines these values?
50177 neutron-network-id:
50179 description: Neutron network id of this Interface
50184 description: Unique identifier of service from ASDC
50185 network-role-instance:
50188 description: network role instance
50194 $ref: "#/patchDefinitions/l3-network"
50197 Link aggregate interface
50198 ###### Related Nodes
50199 - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
50200 - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
50201 - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
50202 - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
50203 - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
50204 - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
50205 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
50206 - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
50207 - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK
50213 description: Name that identifies the link aggregate interface
50216 Collection of link aggregate interfaces.
50221 $ref: "#/patchDefinitions/lag-interface"
50224 LAG links can connect lag-interfaces
50225 ###### Related Nodes
50226 - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
50227 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
50233 description: Alphabetical concatenation of lag-interface names
50236 Collection of link aggregation connections
50241 $ref: "#/patchDefinitions/lag-link"
50244 Metadata for license group.
50245 ###### Related Nodes
50246 - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
50247 - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
50254 description: Unique ID for the license group the resource belongs to, should be uuid.
50257 description: Unique ID of a license resource.
50260 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
50265 $ref: "#/patchDefinitions/license"
50268 describes a line-of-business
50269 ###### Related Nodes
50270 - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
50272 - line-of-business-name
50274 line-of-business-name:
50276 description: Name of the line-of-business (product)
50279 Collection of lines-of-business
50284 $ref: "#/patchDefinitions/line-of-business"
50287 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
50288 ###### Related Nodes
50289 - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
50290 - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
50291 - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
50292 - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
50293 - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
50294 - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
50295 - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
50296 - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
50297 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
50298 - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
50299 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
50306 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
50309 description: Type of logical link, e.g., evc
50312 description: Captures the numeric part of the speed
50315 description: Captures the units corresponding to the speed
50318 description: v4, v6, or ds for dual stack
50321 description: For example, static or BGP
50324 Collection of logical connections
50329 $ref: "#/patchDefinitions/logical-link"
50332 Collection of metadatum (key/value pairs)
50337 $ref: "#/patchDefinitions/metadatum"
50341 ###### Related Nodes
50342 - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
50343 - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
50344 - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
50345 - TO model( metadatum org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
50356 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models
50357 ###### Related Nodes
50358 - TO model( model-element isA model, MANY2ONE)
50359 - TO model-element (CHILD of model, model startsWith model-element, ONE2MANY)
50360 - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
50361 - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
50362 - FROM model-element( model-element isA model, MANY2ONE)
50363 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
50364 - MODEL cannot be deleted if linked to NAMED-QUERY,NAMED-QUERY-ELEMENT
50365 - MODEL is DELETED when these are DELETED METADATUM
50366 - MODEL deletion means associated objects of these types are also DELETED:MODEL-ELEMENT
50368 - model-name-version-id
50374 model-name-version-id:
50376 description: Unique identifier corresponding to one version of a model in ASDC
50379 description: Type of the model, e.g., service, resource, widget, etc.
50382 description: Name of the model, which can change from version to version.
50385 description: Invariant unique ID which does not change from version to version
50388 description: Version
50391 description: Description
50392 model-and-named-query-search:
50394 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
50398 $ref: "#/patchDefinitions/query-parameters"
50401 $ref: "#/patchDefinitions/instance-filters"
50406 This is how we would capture constraints defining allowed sets of elements.
50407 ###### Related Nodes
50408 - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
50409 - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
50410 - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
50412 - model-constraint-uuid
50413 - constrained-element-set-uuid-to-replace
50415 model-constraint-uuid:
50417 constrained-element-set-uuid-to-replace:
50419 constrained-element-sets:
50422 $ref: "#/patchDefinitions/constrained-element-set"
50428 $ref: "#/patchDefinitions/model-constraint"
50431 Defines how other models combine to make up a higher-level model.
50432 ###### Related Nodes
50433 - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
50434 - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
50435 - TO model( model-element isA model, MANY2ONE)
50436 - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
50437 - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
50438 - FROM model (PARENT of model-element, model startsWith model-element)
50439 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
50440 - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
50442 - model-element-uuid
50443 - new-data-del-flag
50446 model-element-uuid:
50450 description: Indicates whether this element was created as part of instantiation from this model
50453 description: How many of this type of element are required/allowed
50461 $ref: "#/patchDefinitions/model-element"
50464 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
50465 ###### Related Nodes
50466 - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
50467 - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
50468 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
50469 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
50470 - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
50471 - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
50479 description: Unique identifier corresponding to one version of a model in ASDC
50482 description: Name of the model, which can change from version to version.
50485 description: Version
50488 description: Description
50494 $ref: "#/patchDefinitions/model-ver"
50497 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
50502 $ref: "#/patchDefinitions/model"
50503 multicast-configuration:
50505 ###### Related Nodes
50506 - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
50508 - multicast-configuration-id
50509 - multicast-protocol
50512 multicast-configuration-id:
50514 description: Unique id of multicast configuration.
50515 multicast-protocol:
50517 description: protocol of multicast configuration
50520 description: rp type of multicast configuration
50521 multicast-configurations:
50523 multicast configuration of generic-vnf ip-address
50525 multicast-configuration:
50528 $ref: "#/patchDefinitions/multicast-configuration"
50534 $ref: "#/patchDefinitions/named-query"
50538 ###### Related Nodes
50539 - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
50540 - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
50541 - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
50542 - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
50546 - named-query-version
50552 named-query-version:
50554 required-input-param:
50558 named-query-element:
50561 ###### Related Nodes
50562 - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
50563 - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
50564 - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
50565 - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
50566 - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
50567 - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
50568 - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
50570 - named-query-element-uuid
50572 named-query-element-uuid:
50574 property-collect-list:
50576 named-query-elements:
50578 named-query-element:
50581 $ref: "#/patchDefinitions/named-query-element"
50584 Namespace for network inventory resources.
50589 $ref: "#/patchDefinitions/logical-link"
50593 $ref: "#/patchDefinitions/site-pair-set"
50597 $ref: "#/patchDefinitions/vpn-binding"
50601 $ref: "#/patchDefinitions/vpls-pe"
50602 multicast-configurations:
50605 $ref: "#/patchDefinitions/multicast-configuration"
50609 $ref: "#/patchDefinitions/vce"
50613 $ref: "#/patchDefinitions/vnfc"
50617 $ref: "#/patchDefinitions/l3-network"
50621 $ref: "#/patchDefinitions/network-policy"
50625 $ref: "#/patchDefinitions/generic-vnf"
50629 $ref: "#/patchDefinitions/lag-link"
50633 $ref: "#/patchDefinitions/newvce"
50637 $ref: "#/patchDefinitions/pnf"
50641 $ref: "#/patchDefinitions/physical-link"
50642 ipsec-configurations:
50645 $ref: "#/patchDefinitions/ipsec-configuration"
50646 route-table-references:
50649 $ref: "#/patchDefinitions/route-table-reference"
50655 $ref: "#/patchDefinitions/network-policy"
50658 ###### Related Nodes
50659 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
50661 - network-policy-id
50665 description: UUID representing unique key to this instance
50666 network-policy-fqdn:
50668 description: Contrail FQDN for the policy
50671 description: ID for the openStack Heat instance
50674 Network profile populated by SDN-GP for SNMP
50675 ###### Related Nodes
50676 - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
50682 description: Unique name of network profile.
50685 description: Encrypted SNMP community string
50688 Collection of network profiles
50693 $ref: "#/patchDefinitions/network-profile"
50696 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
50697 ###### Related Nodes
50698 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
50699 - NEWVCE is DELETED when these are DELETED L-INTERFACE
50707 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
50710 description: Name of VNF.
50713 description: Alternate name of VNF.
50716 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
50719 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
50722 description: Indicator for whether the resource is considered operational
50725 description: License key
50728 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).
50731 description: Client should send valid enumerated value.
50734 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
50739 $ref: "#/patchDefinitions/newvce"
50740 notification-event:
50744 notification-event-header:
50746 $ref: "#/patchDefinitions/notification-event-header"
50747 notification-event-header:
50788 $ref: "#/patchDefinitions/key-data"
50793 OAM network, to be deprecated shortly. Do not use for new purposes.
50794 ###### Related Nodes
50795 - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
50796 - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
50797 - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
50805 description: UUID of the network. Unique across a cloud-region
50808 description: Name of the network.
50812 description: cvlan-id
50813 ipv4-oam-gateway-address:
50815 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
50816 ipv4-oam-gateway-address-prefix-length:
50819 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
50822 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
50827 $ref: "#/patchDefinitions/oam-network"
50828 operational-environment:
50830 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
50831 ###### Related Nodes
50832 - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
50833 - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
50835 - operational-environment-id
50836 - operational-environment-name
50837 - operational-environment-type
50838 - operational-environment-status
50842 operational-environment-id:
50844 description: UUID of an operational environment
50845 operational-environment-name:
50847 description: Operational Environment name
50848 operational-environment-type:
50850 description: Operational Environment Type.
50851 operational-environment-status:
50853 description: Status
50856 description: Tenant Context.
50859 description: Workload Context.
50860 operational-environments:
50862 a logical partition of the cloud which allows to have multiple environments in the production AIC.
50864 operational-environment:
50867 $ref: "#/patchDefinitions/operational-environment"
50870 Allows for legacy POST of old-style and new-style models
50872 - model-invariant-id
50873 - model-name-version-id
50879 model-invariant-id:
50881 description: Unique identifier corresponding to the main definition of a model in ASDC
50882 model-name-version-id:
50884 description: Unique identifier corresponding to one version of a model in ASDC
50887 description: Type of the model, e.g., service, resource, widget, etc.
50890 description: Name of the model, which can change from version to version.
50893 description: Invariant unique ID which does not change from version to version
50896 description: Version
50899 description: Description
50902 Collection of owning-entities
50907 $ref: "#/patchDefinitions/owning-entity"
50910 describes an owning-entity
50911 ###### Related Nodes
50912 - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
50915 - owning-entity-name
50919 description: UUID of an owning entity
50920 owning-entity-name:
50922 description: Owning entity name
50925 Physical interface (e.g., nic)
50926 ###### Related Nodes
50927 - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
50928 - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
50929 - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
50930 - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
50931 - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
50932 - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
50933 - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
50934 - P-INTERFACE is DELETED when these are DELETED L-INTERFACE
50935 - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
50941 description: Name that identifies the physical interface
50944 description: Captures the numeric part of the speed
50947 description: Captures the units corresponding to the speed
50950 description: Nature of the services and connectivity on this port.
50951 equipment-identifier:
50953 description: CLEI or other specification for p-interface hardware.
50956 description: Role specification for p-interface hardware.
50959 description: Indicates the physical properties of the interface.
50962 Collection of physical interfaces.
50967 $ref: "#/patchDefinitions/p-interface"
50970 Collection of physical connections, typically between p-interfaces
50971 ###### Related Nodes
50972 - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
50978 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
50981 description: Captures the numeric part of the speed
50984 description: Captures the units corresponding to the speed
50987 description: Circuit it
50990 description: Dual access mode (e.g., primary, secondary
50993 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
50994 service-provider-name:
50996 description: Name of the service Provider on this link.
50999 Collection of physical connections, typically between p-interfaces
51004 $ref: "#/patchDefinitions/physical-link"
51007 describes a platform
51008 ###### Related Nodes
51009 - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
51015 description: Name of the platform
51018 Collection of platforms
51023 $ref: "#/patchDefinitions/platform"
51026 PNF represents a physical network function. typically equipment used in the D1 world.
51027 ###### Related Nodes
51028 - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
51029 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
51030 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
51031 - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
51032 - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
51039 description: unique name of Physical Network Function.
51042 description: name of Physical Network Function.
51045 description: source of name2
51048 description: id of pnf
51051 description: Equipment type. Source of truth should define valid values.
51054 description: Equipment vendor. Source of truth should define valid values.
51057 description: Equipment model. Source of truth should define valid values.
51060 description: identifier of managed by company or customer
51063 description: ipv4-oam-address with new naming convention for IP addresses
51066 description: sw-version is the version of SW for the hosted application on the PNF.
51067 orchestration-status:
51069 description: orchestration-status is the status of orchestration on the PNF.
51074 description: ID of the physical frame (relay rack) where pnf is installed.
51077 Collection of Physical Network Functions.
51082 $ref: "#/patchDefinitions/pnf"
51085 Used to capture the network interfaces of this VCE
51086 ###### Related Nodes
51087 - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
51088 - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
51089 - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
51092 - orchestration-status
51096 description: Unique ID of the interface
51097 neutron-network-id:
51099 description: Neutron network id of this Interface
51100 neutron-network-name:
51102 description: Neutron network name of this Interface
51105 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
51111 $ref: "#/patchDefinitions/port-group"
51114 describes the project
51115 ###### Related Nodes
51116 - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
51122 description: Name of the project deploying a service
51125 Collection of projects
51130 $ref: "#/patchDefinitions/project"
51133 Property holder for query properties or instance properties
51139 property-constraint:
51142 ###### Related Nodes
51143 - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
51145 - property-constraint-uuid
51150 property-constraint-uuid:
51158 property-constraints:
51160 property-constraint:
51163 $ref: "#/patchDefinitions/property-constraint"
51166 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
51167 ###### Related Nodes
51168 - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
51169 - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
51170 - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
51171 - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
51172 - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
51173 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
51174 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
51175 - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
51176 - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
51177 - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
51178 - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
51179 - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
51186 description: Value from executing hostname on the compute node.
51189 description: PTNII name
51193 description: Number of cpus
51197 description: Disk size, in GBs
51201 description: RAM size, in MBs
51204 description: Equipment type. Source of truth should define valid values.
51207 description: Equipment vendor. Source of truth should define valid values.
51210 description: Equipment model. Source of truth should define valid values.
51213 description: Fully-qualified domain name
51216 description: URL to endpoint where AAI can get more details
51219 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
51222 description: Serial number, may be queried
51225 description: ID of Pserver
51228 description: internet topology of Pserver
51233 Collection of compute hosts.
51238 $ref: "#/patchDefinitions/pserver"
51241 QueryParameters for performing a named-query or model query
51245 $ref: "#/patchDefinitions/named-query"
51248 $ref: "#/patchDefinitions/model"
51252 ###### Related Nodes
51253 - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
51255 - related-lookup-uuid
51257 - source-node-property
51259 - target-node-property
51261 related-lookup-uuid:
51265 source-node-property:
51269 target-node-property:
51271 property-collect-list:
51278 $ref: "#/patchDefinitions/related-lookup"
51279 related-to-property:
51283 description: Key part of a key/value pair
51286 description: Value part of a key/value pair
51291 description: A keyword provided by A&AI to indicate type of node.
51294 description: URL to the object in A&AI.
51298 $ref: "#/patchDefinitions/relationship-data"
51299 related-to-property:
51302 $ref: "#/patchDefinitions/related-to-property"
51306 - relationship-value
51310 description: A keyword provided by A&AI to indicate an attribute.
51311 relationship-value:
51313 description: Value of the attribute.
51314 reserved-prop-names:
51316 Internal map to define some reserved properties of a vertex
51318 last-mod-source-of-truth:
51334 Response container for the results of a named-query or model query
51336 inventory-response-items:
51338 $ref: "#/patchDefinitions/inventory-response-items"
51343 description: The specific type of node in the A&AI graph
51346 description: The URL to the specific resource
51347 route-table-reference:
51349 Openstack route table reference.
51350 ###### Related Nodes
51351 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
51353 - route-table-reference-id
51354 - route-table-reference-fqdn
51356 route-table-reference-id:
51358 description: Route Table Reference id, UUID assigned to this instance.
51359 route-table-reference-fqdn:
51361 description: FQDN entry in the route table.
51362 route-table-references:
51364 Collection of openstack route table references
51366 route-table-reference:
51369 $ref: "#/patchDefinitions/route-table-reference"
51372 Route target information
51373 ###### Related Nodes
51374 - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
51376 - global-route-target
51377 - route-target-role
51379 global-route-target:
51381 description: Number used to identify an RT, globally unique in the network
51384 description: Role assigned to this route target
51387 Collection of route target information
51392 $ref: "#/patchDefinitions/route-target"
51395 ###### Related Nodes
51396 - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
51397 - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
51398 - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
51400 - routing-instance-id
51402 routing-instance-id:
51404 description: Unique id of routing instance
51407 description: rpm owner
51410 set of probes related to generic-vnf routing instance
51415 $ref: "#/patchDefinitions/routing-instance"
51420 $ref: "#/patchDefinitions/oam-networks"
51421 az-and-dvs-switches:
51424 $ref: "#/patchDefinitions/az-and-dvs-switches"
51427 edge-tag-query-result:
51429 $ref: "#/patchDefinitions/edge-tag-query-result"
51430 edge-tag-query-request:
51432 $ref: "#/patchDefinitions/edge-tag-query-request"
51435 $ref: "#/patchDefinitions/search-results"
51438 $ref: "#/patchDefinitions/sdn-zone-response"
51444 $ref: "#/patchDefinitions/result-data"
51447 SecondaryFilt for performing a named-query or model query
51458 SecondaryFilts for performing a named-query or model query
51463 $ref: "#/patchDefinitions/secondary-filt"
51464 segmentation-assignment:
51466 Openstack segmentation assignment.
51467 ###### Related Nodes
51468 - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
51474 description: Route Table Reference id, UUID assigned to this instance.
51475 segmentation-assignments:
51477 Collection of openstack segmentation assignments
51479 segmentation-assignment:
51482 $ref: "#/patchDefinitions/segmentation-assignment"
51485 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC.
51488 - service-description
51492 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
51493 service-description:
51495 description: Description of the service
51498 description: URL to endpoint where AAI can get more details
51499 service-capabilities:
51501 Collection of service capabilities.
51503 service-capability:
51506 $ref: "#/patchDefinitions/service-capability"
51507 service-capability:
51509 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
51510 ###### Related Nodes
51511 - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
51512 - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
51513 - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
51520 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
51523 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
51524 service-design-and-creation:
51526 Namespace for objects managed by ASDC
51531 $ref: "#/patchDefinitions/vnf-image"
51535 $ref: "#/patchDefinitions/service"
51536 service-capabilities:
51539 $ref: "#/patchDefinitions/service-capability"
51543 $ref: "#/patchDefinitions/model"
51547 $ref: "#/patchDefinitions/named-query"
51550 Instance of a service
51551 ###### Related Nodes
51552 - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
51553 - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
51554 - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
51555 - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
51556 - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
51557 - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
51558 - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
51559 - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
51560 - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
51561 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
51562 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
51563 - SERVICE-INSTANCE is DELETED when these are DELETED METADATUM
51564 - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
51566 - service-instance-id
51568 service-instance-id:
51570 description: Uniquely identifies this instance of a service
51571 service-instance-name:
51573 description: This field will store a name assigned to the service-instance.
51576 description: the ASDC model id for this resource or service model.
51577 persona-model-version:
51579 description: the ASDC model version for this resource or service model.
51582 description: the ASDC model version for this resource or service model.
51585 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
51586 widget-model-version:
51588 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
51591 description: Indicates the total bandwidth to be used for this service.
51594 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
51595 bandwidth-down-wan1:
51597 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
51600 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
51601 bandwidth-down-wan2:
51603 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
51606 description: URL customers will use to access the vHN Portal.
51607 service-instance-location-id:
51609 description: An identifier that customers assign to the location where this service is being used.
51612 Collection of service instances
51617 $ref: "#/patchDefinitions/service-instance"
51618 service-subscription:
51620 Object that group service instances.
51621 ###### Related Nodes
51622 - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
51623 - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
51624 - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
51625 - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
51631 description: Value defined by orchestration to identify this service across ECOMP.
51632 temp-ub-sub-account-id:
51634 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
51635 service-subscriptions:
51637 Collection of objects that group service instances.
51639 service-subscription:
51642 $ref: "#/patchDefinitions/service-subscription"
51645 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
51650 $ref: "#/patchDefinitions/service"
51653 ###### Related Nodes
51654 - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
51655 - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
51656 - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
51662 description: unique identifier of probe
51665 description: Prefix address
51668 description: Prefix address
51671 description: ip version, v4, v6
51672 destination-hostname:
51674 description: Hostname of the destination equipment to which SLAs are measured against.
51675 destination-equip-type:
51677 description: The type of destinatination equipment. Could be Router, etc.
51680 Set of instances for probes used to measure service level agreements
51681 ###### Related Nodes
51682 - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
51683 - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
51684 - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
51690 description: Unique id of site pair set.
51693 Collection of sets of instances for probes related to generic-vnf
51698 $ref: "#/patchDefinitions/site-pair-set"
51706 $ref: "#/patchDefinitions/site-pair"
51710 ###### Related Nodes
51711 - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
51712 - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
51718 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
51721 description: Snapshot name
51722 snapshot-architecture:
51724 description: Operating system architecture
51725 snapshot-os-distro:
51727 description: The common name of the operating system distribution in lowercase
51728 snapshot-os-version:
51730 description: The operating system version as specified by the distributor.
51733 description: The application that the image instantiates.
51734 application-vendor:
51736 description: The vendor of the application.
51737 application-version:
51739 description: The version of the application.
51742 description: URL to endpoint where AAI can get more details
51745 description: This field contains the UUID of the previous snapshot (if any).
51748 Collection of openstack snapshots
51753 $ref: "#/patchDefinitions/snapshot"
51756 SR-IOV Physical Function
51757 ###### Related Nodes
51758 - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
51759 - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
51765 description: Identifier for the sriov-pf
51768 Collection of SR-IOV Physical Functions.
51773 $ref: "#/patchDefinitions/sriov-pf"
51776 SR-IOV Virtual Function (not to be confused with virtual network function)
51777 ###### Related Nodes
51778 - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
51784 description: PCI ID used to identify the sriov-vf
51787 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
51790 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
51793 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
51794 vf-vlan-anti-spoof-check:
51796 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.
51797 vf-mac-anti-spoof-check:
51799 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.
51802 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
51803 vf-broadcast-allow:
51805 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
51806 vf-unknown-multicast-allow:
51808 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
51809 vf-unknown-unicast-allow:
51811 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
51814 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
51817 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
51820 Collection of SR-IOV Virtual Functions.
51825 $ref: "#/patchDefinitions/sriov-vf"
51834 ###### Related Nodes
51835 - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
51836 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
51837 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
51838 - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
51845 description: Subnet ID, should be UUID.
51848 description: Name associated with the subnet.
51851 description: Neutron id of this subnet
51854 description: gateway ip address
51855 network-start-address:
51857 description: network start address
51860 description: cidr mask
51863 description: ip version
51864 orchestration-status:
51866 description: Orchestration status of this VNF, mastered by MSO
51871 description: the start address reserved for use by dhcp
51874 description: the last address reserved for use by dhcp
51880 $ref: "#/patchDefinitions/subnet"
51881 tagged-inventory-item-list:
51886 $ref: "#/patchDefinitions/inventory-item"
51890 ###### Related Nodes
51891 - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
51892 - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
51893 - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
51894 - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
51895 - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
51896 - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
51897 - TENANT cannot be deleted if linked to VSERVER
51904 description: Unique id relative to the cloud-region.
51907 description: Readable name of tenant
51910 Collection of openstack tenants.
51915 $ref: "#/patchDefinitions/tenant"
51918 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
51919 ###### Related Nodes
51920 - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
51923 - bandwidth-up-wan1
51924 - bandwidth-down-wan1
51925 - bandwidth-up-wan2
51926 - bandwidth-down-wan2
51930 description: Allotted Resource id UUID assigned to this instance.
51933 description: The WAN uplink bandwidth for WAN1
51934 bandwidth-down-wan1:
51936 description: The WAN downlink bandwidth for WAN1
51939 description: The WAN uplink bandwidth for WAN2
51940 bandwidth-down-wan2:
51942 description: The WAN downlink bandwidth for WAN2
51945 This object is used to store the specific tunnel cross connect aspects of an allotted resource
51950 $ref: "#/patchDefinitions/tunnel-xconnect"
51953 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
51962 $ref: "#/patchDefinitions/update-node-key"
51968 $ref: "#/patchDefinitions/action"
51977 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
51978 ###### Related Nodes
51979 - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
51980 - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
51981 - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
51982 - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
51983 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
51984 - VCE is DELETED when these are DELETED PORT-GROUP
51992 description: Unique id of VNF. This is unique across the graph.
51995 description: Name of VNF.
51998 description: Alternate name of VNF.
52001 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
52004 description: Unique identifier of service from ASDC. Expect this to change as ASDC matures.
52005 regional-resource-zone:
52007 description: Regional way of organizing pservers, source of truth should define values
52010 description: Trigger for operational monitoring of this resource by Service Assurance systems.
52013 description: Indicator for whether the resource is considered operational
52016 description: License key
52019 description: Network role being played by this VNF
52020 orchestration-status:
52022 description: Orchestration status of this VNF, mastered by MSO
52025 description: Heat stack id corresponding to this instance, managed by MSO
52028 description: Corresponds to the SDN-C catalog id used to configure this VCE
52031 description: Unique ID of VPE connected to this VCE.
52032 v6-vce-wan-address:
52034 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
52037 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
52040 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
52045 $ref: "#/patchDefinitions/vce"
52048 a deployment unit of VNFCs
52049 ###### Related Nodes
52050 - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
52051 - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
52052 - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
52053 - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
52054 - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
52055 - VF-MODULE cannot be deleted if linked to VNFC
52058 - is-base-vf-module
52062 description: Unique ID of vf-module.
52065 description: Name of vf-module
52068 description: Heat stack id corresponding to this instance.
52069 orchestration-status:
52071 description: orchestration status of this vf-module, mastered by MSO
52076 Collection of vf-modules, a deployment unit of VNFCs
52081 $ref: "#/patchDefinitions/vf-module"
52084 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
52085 ###### Related Nodes
52086 - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
52092 description: indicates whether the VIG is for AVPN or INTERNET
52095 description: v4 IP of the vig server
52098 description: v6 IP of the vig server
52104 $ref: "#/patchDefinitions/vig-server"
52105 vip-ipv4-address-list:
52108 ###### Related Nodes
52109 - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52110 - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
52111 - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
52112 - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
52118 description: IP address
52119 vip-ipv4-prefix-length:
52122 description: Prefix length, 32 for single address
52126 description: Inner VLAN tag
52130 description: Outer VLAN tag
52133 description: Indicator of fixed or floating address
52134 vip-ipv6-address-list:
52137 ###### Related Nodes
52138 - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52139 - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
52140 - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
52141 - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
52147 description: IP address
52148 vip-ipv6-prefix-length:
52151 description: Prefix length, 128 for single address
52155 description: Inner VLAN tag
52159 description: Outer VLAN tag
52162 description: Indicator of fixed or floating address
52163 virtual-data-center:
52165 Virtual organization of cloud infrastructure elements in a data center context
52166 ###### Related Nodes
52167 - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
52168 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
52169 - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
52176 description: Unique ID of the vdc
52179 description: Name of the virtual data center
52180 virtual-data-centers:
52182 Virtual organization of cloud infrastructure elements in a data center context
52184 virtual-data-center:
52187 $ref: "#/patchDefinitions/virtual-data-center"
52191 ###### Related Nodes
52192 - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
52193 - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
52194 - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
52195 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
52196 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
52197 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
52198 - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
52199 - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
52205 description: String that identifies the interface
52209 description: Inner VLAN tag
52213 description: Outer VLAN tag
52219 $ref: "#/patchDefinitions/vlan"
52228 description: Unique id of VNF. This is unique across the graph.
52231 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
52232 ###### Related Nodes
52233 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
52234 - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
52238 - application-vendor
52242 description: Unique ID of this asset
52245 description: The application that the image instantiates.
52246 application-vendor:
52248 description: The vendor of the application.
52249 application-version:
52251 description: The version of the application.
52254 description: URL to endpoint where AAI can get more details
52257 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
52262 $ref: "#/patchDefinitions/vnf-image"
52265 ###### Related Nodes
52266 - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
52267 - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
52268 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
52271 - vnfc-function-code
52274 - is-closed-loop-disabled
52278 description: Unique ID of vnfc.
52279 vnfc-function-code:
52281 description: function code
52287 description: prov status of this vnfc
52288 orchestration-status:
52290 description: Orchestration status of this VNF, mastered by APP-C
52291 ipaddress-v4-oam-vip:
52293 description: Oam V4 vip address of this vnfc
52296 is-closed-loop-disabled:
52300 description: Group notation of VNFC
52303 virtual network components associated with a vserver from application controller.
52308 $ref: "#/patchDefinitions/vnfc"
52311 Ephemeral Block storage volume.
52312 ###### Related Nodes
52313 - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
52320 description: Unique ID of block storage volume relative to the vserver.
52323 description: URL to endpoint where AAI can get more details
52326 Persistent block-level storage.
52327 ###### Related Nodes
52328 - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52329 - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52330 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
52331 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
52332 - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
52335 - volume-group-name
52340 description: Unique ID of volume-group.
52343 description: Name of the volume group.
52346 description: Heat stack id corresponding to this volume-group
52349 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
52350 orchestration-status:
52352 description: Orchestration status of this volume-group
52355 Collection of persistent block-level storage.
52360 $ref: "#/patchDefinitions/volume-group"
52363 Collection of ephemeral Block storage volumes.
52368 $ref: "#/patchDefinitions/volume"
52371 VPLS Provider Edge routers.
52372 ###### Related Nodes
52373 - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52374 - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
52375 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
52376 - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
52377 - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
52385 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
52388 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).
52391 description: Client should send valid enumerated value, e.g., VPLS-PE.
52395 description: Temporary location for stag to get to VCE
52398 Collection of VPLS Provider Edge routers
52403 $ref: "#/patchDefinitions/vpls-pe"
52407 ###### Related Nodes
52408 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
52409 - VPN-BINDING cannot be deleted if linked to L3-NETWORK
52413 - global-route-target
52417 description: VPN ID, globally unique within A&AI
52420 description: VPN Name
52421 global-route-target:
52423 description: Number used to identify a VPN, globally unique in the network
52426 description: the platform associated with the VPN example AVPN, Mobility
52432 $ref: "#/patchDefinitions/vpn-binding"
52435 Virtual Servers, aka virtual machine or VM.
52436 ###### Related Nodes
52437 - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
52438 - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
52439 - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
52440 - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
52441 - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
52442 - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
52443 - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
52444 - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
52445 - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
52446 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
52447 - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
52448 - VSERVER is DELETED when these are DELETED L-INTERFACE
52449 - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
52455 - is-closed-loop-disabled
52459 description: Unique identifier for this vserver relative to its tenant
52462 description: Name of vserver
52465 description: Alternative name of vserver
52468 description: Trigger for operational monitoring of this resource by Service Assurance systems.
52471 description: URL to endpoint where AAI can get more details
52474 is-closed-loop-disabled:
52478 Collection of virtual Servers, aka virtual machines or VMs.
52483 $ref: "#/patchDefinitions/vserver"
52486 A zone is a grouping of assets in a location homing to the same connections into the CBB
52487 ###### Related Nodes
52488 - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52489 - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
52490 - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
52491 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
52500 description: Code assigned by AIC to the zone
52503 description: English name associated with the zone
52506 description: Design of zone [Medium/Large?]
52509 description: Context of zone [production/test]
52512 description: Status of a zone.
52515 Collection of zones
52520 $ref: "#/patchDefinitions/zone"
52535 $ref: "#/getDefinitions/action-data"
52544 APIs that are more action related than REST (e.g., notify, update).
52548 $ref: "#/getDefinitions/update"
52551 $ref: "#/getDefinitions/notify"
52554 Represents a slice or partial piece of a resource that gets separately allotted
52555 ###### Related Nodes
52556 - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
52557 - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
52558 - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
52559 - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
52560 - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
52561 - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
52562 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
52563 - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
52569 description: Allotted Resource id UUID assigned to this instance.
52572 description: The descriptive information assigned to this allotted resource instance
52575 description: Link back to more information in the controller
52578 description: the ASDC model id for this resource or service model.
52579 persona-model-version:
52581 description: the ASDC model version for this resource or service model.
52584 description: the ASDC model version for this resource or service model.
52585 persona-model-customization-id:
52587 description: captures the id of all the configuration used to customize the resource for the service.
52590 description: Concurrency value
52594 $ref: "#/getDefinitions/tunnel-xconnect"
52598 $ref: "#/getDefinitions/relationship"
52599 allotted-resources:
52601 This object is used to store slices of services being offered
52606 $ref: "#/getDefinitions/allotted-resource"
52609 Availability zone, a collection of compute hosts/pservers
52610 ###### Related Nodes
52611 - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52612 - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
52613 - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52614 - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
52615 - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
52616 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
52617 - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
52618 - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
52619 - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
52621 - availability-zone-name
52624 availability-zone-name:
52626 description: Name of the availability zone. Unique across a cloud region
52629 description: Type of hypervisor. Source of truth should define valid values.
52632 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
52635 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52639 $ref: "#/getDefinitions/relationship"
52640 availability-zones:
52642 Collection of availability zones
52647 $ref: "#/getDefinitions/availability-zone"
52648 az-and-dvs-switches:
52652 $ref: "#/getDefinitions/dvs-switches"
52655 $ref: "#/getDefinitions/availability-zone"
52658 Namespace for business related constructs
52663 $ref: "#/getDefinitions/connector"
52667 $ref: "#/getDefinitions/customer"
52670 ###### Related Nodes
52671 - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
52677 description: unique identifier of probe
52680 description: identifier of probe
52683 description: type of probe
52686 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52690 $ref: "#/getDefinitions/relationship"
52691 classes-of-service:
52693 class-of-service of probe
52698 $ref: "#/getDefinitions/class-of-service"
52699 cloud-infrastructure:
52701 Namespace for cloud infrastructure.
52706 $ref: "#/getDefinitions/complex"
52710 $ref: "#/getDefinitions/cloud-region"
52714 $ref: "#/getDefinitions/network-profile"
52718 $ref: "#/getDefinitions/pserver"
52719 virtual-data-centers:
52722 $ref: "#/getDefinitions/virtual-data-center"
52725 cloud-region designates an installation of a cloud cluster or region or instantiation.
52726 ###### Related Nodes
52727 - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52728 - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
52729 - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52730 - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52731 - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52732 - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52733 - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52734 - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52735 - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52736 - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52737 - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52738 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
52739 - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
52740 - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
52747 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
52750 description: Identifier used by the vendor for the region. Second part of composite key
52753 description: Type of the cloud (e.g., openstack)
52754 owner-defined-type:
52756 description: Cloud-owner defined type indicator (e.g., DCP, LCP)
52757 cloud-region-version:
52759 description: Software version employed at the site
52762 description: URL of the keystone identity service
52765 description: Zone where the cloud is homed
52768 description: complex name for cloud-region instance
52771 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52775 $ref: "#/getDefinitions/volume-group"
52779 $ref: "#/getDefinitions/tenant"
52783 $ref: "#/getDefinitions/flavor"
52787 $ref: "#/getDefinitions/group-assignment"
52791 $ref: "#/getDefinitions/snapshot"
52795 $ref: "#/getDefinitions/image"
52799 $ref: "#/getDefinitions/dvs-switch"
52803 $ref: "#/getDefinitions/oam-network"
52804 availability-zones:
52807 $ref: "#/getDefinitions/availability-zone"
52811 $ref: "#/getDefinitions/relationship"
52817 $ref: "#/getDefinitions/cloud-region"
52820 Collection of physical locations that can house cloud-regions.
52821 ###### Related Nodes
52822 - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
52823 - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52824 - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52825 - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
52826 - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
52827 - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52828 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52829 - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
52830 - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52831 - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52832 - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE
52833 - COMPLEX is DELETED when these are DELETED CTAG-POOL
52835 - physical-location-id
52836 - physical-location-type
52843 physical-location-id:
52845 description: Unique identifier for physical location, e.g., CLLI
52848 description: Data center code which can be an alternate way to identify a complex
52851 description: Gamma complex name for LCP instance.
52854 description: URL of the keystone identity service
52857 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52858 physical-location-type:
52860 description: Type, e.g., central office, data center.
52886 $ref: "#/getDefinitions/ctag-pool"
52890 $ref: "#/getDefinitions/relationship"
52893 Collection of physical locations that can house cloud-regions.
52898 $ref: "#/getDefinitions/complex"
52901 Port Mirror Configuration.
52902 ###### Related Nodes
52903 - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
52904 - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
52905 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
52906 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
52907 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
52908 - CONFIGURATION is DELETED when these are DELETED METADATUM
52909 - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
52912 - configuration-type
52913 - configuration-sub-type
52914 - orchestration-status
52915 - operational-status
52916 - configuration-selflink
52917 - model-customization-id
52921 description: UUID assigned to configuration.
52924 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
52925 configuration-name:
52927 description: Name of the configuration.
52928 configuration-type:
52930 description: port-mirroring-configuration.
52931 configuration-sub-type:
52933 description: vprobe, pprobe.
52934 model-invariant-id:
52936 description: the ASDC model id for this resource or service model.
52939 description: the ASDC model version for this resource or service model.
52940 orchestration-status:
52942 description: Orchestration status of the configuration.
52943 operational-status:
52945 description: Indicator for whether the resource is considered operational.
52946 configuration-selflink:
52948 description: URL to endpoint where AAI can get more details from SDN-GC.
52949 model-customization-id:
52951 description: id of the configuration used to customize the resource
52954 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52958 $ref: "#/getDefinitions/relationship"
52962 $ref: "#/getDefinitions/metadatum"
52965 Collection of configurations
52970 $ref: "#/getDefinitions/configuration"
52973 Collection of resource instances used to connect a variety of disparate inventory widgets
52974 ###### Related Nodes
52975 - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
52976 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
52977 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
52978 - CONNECTOR is DELETED when these are DELETED METADATUM
52980 - resource-instance-id
52982 resource-instance-id:
52984 description: Unique id of resource instance.
52987 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52990 description: the ASDC model id for this resource or service model.
52991 persona-model-version:
52993 description: the ASDC model version for this resource or service model.
52996 description: the ASDC model version for this resource or service model.
52999 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
53000 widget-model-version:
53002 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
53006 $ref: "#/getDefinitions/relationship"
53010 $ref: "#/getDefinitions/metadatum"
53013 Collection of resource instances used to connect a variety of disparate inventory widgets
53018 $ref: "#/getDefinitions/connector"
53019 constrained-element-set:
53021 This is how we would capture constraints defining allowed sets of elements.
53022 ###### Related Nodes
53023 - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
53024 - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
53025 - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
53026 - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
53028 - constrained-element-set-uuid
53032 constrained-element-set-uuid:
53040 element-choice-sets:
53043 $ref: "#/getDefinitions/element-choice-set"
53047 $ref: "#/getDefinitions/relationship"
53048 constrained-element-sets:
53050 constrained-element-set:
53053 $ref: "#/getDefinitions/constrained-element-set"
53056 ###### Related Nodes
53057 - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
53067 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53071 $ref: "#/getDefinitions/relationship"
53077 $ref: "#/getDefinitions/ctag-assignment"
53080 A collection of C tags (vlan tags) grouped for a specific purpose.
53081 ###### Related Nodes
53082 - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
53083 - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
53084 - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
53087 - availability-zone-name
53088 - ctag-pool-purpose
53092 description: The Target provider edge router
53093 availability-zone-name:
53095 description: Name of the availability zone
53098 description: Describes what the intended purpose of this pool is.
53101 description: Comma separated list of ctags
53104 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53108 $ref: "#/getDefinitions/relationship"
53114 $ref: "#/getDefinitions/ctag-pool"
53117 customer identifiers to provide linkage back to BSS information.
53118 ###### Related Nodes
53119 - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
53120 - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
53122 - global-customer-id
53126 global-customer-id:
53128 description: Global customer id used across ECOMP to uniquely identify customer.
53131 description: Subscriber name, an alternate way to retrieve a customer.
53134 description: Subscriber type, a way to provide VID with only the INFRA customers.
53137 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53138 service-subscriptions:
53141 $ref: "#/getDefinitions/service-subscription"
53145 $ref: "#/getDefinitions/relationship"
53148 Collection of customer identifiers to provide linkage back to BSS information.
53153 $ref: "#/getDefinitions/customer"
53161 description: See mis-na-virtualization-platform.yang
53164 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53168 $ref: "#/getDefinitions/relationship"
53174 $ref: "#/getDefinitions/cvlan-tag-entry"
53177 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.
53178 ###### Related Nodes
53179 - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53180 - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
53187 description: DVS switch name
53190 description: URL used to reach the vcenter
53193 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53197 $ref: "#/getDefinitions/relationship"
53200 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
53205 $ref: "#/getDefinitions/dvs-switch"
53208 Internal map to define the properties of an edge and interpret the map EdgeRules
53226 edge-tag-query-request:
53237 $ref: "#/getDefinitions/start-node-filter"
53238 include-node-filter:
53241 $ref: "#/getDefinitions/include-node-filter"
53245 $ref: "#/getDefinitions/secondary-filter"
53246 edge-tag-query-result:
53248 tagged-inventory-item-list:
53251 $ref: "#/getDefinitions/tagged-inventory-item-list"
53252 element-choice-set:
53254 This is how we would capture constraints defining allowed sets of elements.
53255 ###### Related Nodes
53256 - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
53257 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
53258 - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
53260 - element-choice-set-uuid
53261 - element-choice-set-name
53263 element-choice-set-uuid:
53265 element-choice-set-name:
53274 $ref: "#/getDefinitions/model-element"
53278 $ref: "#/getDefinitions/relationship"
53279 element-choice-sets:
53281 element-choice-set:
53284 $ref: "#/getDefinitions/element-choice-set"
53287 Metadata for entitlement group.
53288 ###### Related Nodes
53289 - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53290 - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
53297 description: Unique ID for the entitlement group the resource comes from, should be uuid.
53300 description: Unique ID of an entitlement resource.
53303 description: Concurrency value
53307 $ref: "#/getDefinitions/relationship"
53310 Entitlements, keyed by group-uuid and resource-uuid, related to license management
53315 $ref: "#/getDefinitions/entitlement"
53318 Persist EMS address information used by EMS driver.
53319 ###### Related Nodes
53320 - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
53321 - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
53327 description: Unique ID of EMS.
53330 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53331 esr-system-info-list:
53333 $ref: "#/getDefinitions/esr-system-info-list"
53336 $ref: "#/getDefinitions/relationship-list"
53342 $ref: "#/getDefinitions/esr-ems"
53345 Persist common address information of external systems.
53346 ###### Related Nodes
53347 - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
53348 - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
53349 - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
53350 - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
53352 - esr-system-info-id
53357 esr-system-info-id:
53359 description: Unique ID of esr system info.
53362 description: name of external system.
53365 description: type of external systems.
53368 description: vendor of external systems.
53371 description: version of external systems.
53374 description: url used to access external systems.
53377 description: username used to access external systems.
53380 description: password used to access external systems.
53383 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
53386 description: protocol of third party SDNC, for example netconf/snmp.
53389 description: ca file content if enabled ssl on auth-url.
53392 description: Whether to verify VIM's certificate.
53395 description: service IP of ftp server.
53398 description: service port of ftp server.
53401 description: domain info for authentication.
53404 description: default tenant of VIM.
53407 description: ftp passive mode or not.
53410 description: resource or performance data file path.
53413 description: the status of external system.
53416 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53420 $ref: "#/getDefinitions/relationship"
53421 esr-system-info-list:
53423 Collection of persistent block-level external system auth info.
53428 $ref: "#/getDefinitions/esr-system-info"
53429 esr-thirdparty-sdnc:
53431 Persist SDNC address information used by ONAP SDNC.
53432 ###### Related Nodes
53433 - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
53434 - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
53435 - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
53437 - thirdparty-sdnc-id
53439 thirdparty-sdnc-id:
53441 description: Unique ID of SDNC.
53444 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
53447 description: password used to access SDNC server.
53450 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53451 esr-system-info-list:
53453 $ref: "#/getDefinitions/esr-system-info-list"
53456 $ref: "#/getDefinitions/relationship-list"
53457 esr-thirdparty-sdnc-list:
53459 esr-thirdparty-sdnc:
53462 $ref: "#/getDefinitions/esr-thirdparty-sdnc"
53465 Persist VNFM address information used by VF-C.
53466 ###### Related Nodes
53467 - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
53468 - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
53474 description: Unique ID of VNFM.
53477 description: indecate the VIM to deploy VNF.
53480 description: certificate url of VNFM.
53483 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53484 esr-system-info-list:
53486 $ref: "#/getDefinitions/esr-system-info-list"
53489 $ref: "#/getDefinitions/relationship-list"
53495 $ref: "#/getDefinitions/esr-vnfm"
53498 evc object is an optional child object of the Configuration object.
53499 ###### Related Nodes
53500 - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
53506 description: Unique/key field for the evc object
53507 forwarding-path-topology:
53509 description: Point-to-Point, Multi-Point
53512 description: Commited Information Rate
53515 description: CIR units
53516 connection-diversity-group-id:
53518 description: Diversity Group ID
53521 description: formerly Performance Group
53522 esp-evc-circuit-id:
53524 description: EVC Circuit ID of ESP EVC
53527 description: Committed Information Rate (For ESP)
53530 description: CIR units (For ESP)
53533 description: Identifies ESP
53534 collector-pop-clli:
53536 description: Collector POP CLLI (from the hostname of the access pnf)
53537 inter-connect-type-ingress:
53539 description: Interconnect type on ingress side of EVC.
53540 tagmode-access-ingress:
53542 description: tagode for collector side of EVC
53543 tagmode-access-egress:
53545 description: tagMode for network side of EVC
53549 $ref: "#/getDefinitions/relationship"
53552 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53558 $ref: "#/getDefinitions/evc"
53561 Namespace for external system.
53565 $ref: "#/getDefinitions/esr-ems-list"
53568 $ref: "#/getDefinitions/esr-vnfm-list"
53569 esr-thirdparty-sdnc-list:
53571 $ref: "#/getDefinitions/esr-thirdparty-sdnc-list"
53574 Extra properties for inventory item for response list
53582 ###### Related Nodes
53583 - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53584 - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
53585 - FLAVOR cannot be deleted if linked to VSERVER
53593 description: Flavor id, expected to be unique across cloud-region.
53596 description: Flavor name
53600 description: Number of CPUs
53604 description: Amount of memory
53608 description: Disk space
53612 description: Amount of ephemeral disk space
53615 description: amount of swap space allocation
53618 description: whether flavor is available to all users or private to the tenant it was created in.
53621 description: URL to endpoint where AAI can get more details
53624 description: Boolean as to whether this flavor is no longer enabled
53627 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53631 $ref: "#/getDefinitions/relationship"
53634 Collection of openstack flavors.
53639 $ref: "#/getDefinitions/flavor"
53642 Entity describing a sequenced segment of forwarding path
53643 ###### Related Nodes
53644 - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
53645 - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
53646 - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
53647 - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
53648 - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
53649 - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
53656 description: Unique ID of this segmentation
53659 description: ingress, intermediate, egress
53663 $ref: "#/getDefinitions/relationship"
53666 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53669 forwarder object is an optional child object of the Configuration object.
53670 ###### Related Nodes
53671 - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
53677 description: Key for forwarder-evc object
53680 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
53683 description: Internal VLAN.
53686 description: SVLAN value for ingress of egress forwarder.
53689 description: CVLAN value for ingress of egress forwarder.
53693 $ref: "#/getDefinitions/relationship"
53696 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53702 $ref: "#/getDefinitions/forwarder-evc"
53708 $ref: "#/getDefinitions/forwarder"
53711 Entity that describes the sequenced forwarding path between interfaces of services or resources
53712 ###### Related Nodes
53713 - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
53714 - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
53715 - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
53716 - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
53717 - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
53719 - forwarding-path-id
53720 - forwarding-path-name
53722 forwarding-path-id:
53724 description: Unique ID of this FP
53725 forwarding-path-name:
53727 description: Name of the FP
53731 $ref: "#/getDefinitions/relationship"
53734 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53737 description: the self link for this FP
53741 $ref: "#/getDefinitions/forwarder"
53747 $ref: "#/getDefinitions/forwarding-path"
53750 General purpose VNF
53751 ###### Related Nodes
53752 - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
53753 - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
53754 - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
53755 - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
53756 - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
53757 - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
53758 - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
53759 - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
53760 - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
53761 - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53762 - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53763 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53764 - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
53765 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
53766 - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
53767 - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53768 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
53769 - GENERIC-VNF is DELETED when these are DELETED VNFC,LAG-INTERFACE,L-INTERFACE,VF-MODULE
53775 - is-closed-loop-disabled
53779 description: Unique id of VNF. This is unique across the graph.
53782 description: Name of VNF.
53785 description: Alternate name of VNF.
53788 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
53791 description: Unique identifier of service from ASDC
53792 regional-resource-zone:
53794 description: Regional way of organizing pservers, source of truth should define values
53797 description: Trigger for operational monitoring of this resource by Service Assurance systems.
53800 description: Indicator for whether the resource is considered operational
53803 description: License key
53806 description: Client should send valid enumerated value
53807 orchestration-status:
53809 description: Orchestration status of this VNF, used by MSO.
53812 description: Heat stack id corresponding to this instance, managed by MSO
53815 description: Corresponds to the SDN-C catalog id used to configure this VCE
53818 description: identifier of managed by company or customer
53821 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
53822 ipv4-loopback0-address:
53824 description: v4 Loopback0 address
53827 description: v6 Loopback address
53828 management-v6-address:
53830 description: v6 management address
53834 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors
53837 description: units associated with vcpu, used for VNFs with no vservers/flavors
53841 description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors
53844 description: units associated with vmemory, used for VNFs with no vservers/flavors
53848 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors
53851 description: units associated with vdisk, used for VNFs with no vservers/flavors
53854 is-closed-loop-disabled:
53858 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53861 description: details regarding the generic-vnf operation
53862 encrypted-access-flag:
53864 description: indicates whether generic-vnf access uses SSH
53867 description: the ASDC model id for this resource or service model.
53868 persona-model-version:
53870 description: the ASDC model version for this resource or service model.
53873 description: the ASDC model version for this resource or service model.
53876 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
53877 widget-model-version:
53879 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
53882 description: as-number of the VNF
53883 regional-resource-subzone:
53885 description: represents sub zone of the rr plane
53889 $ref: "#/getDefinitions/relationship"
53893 $ref: "#/getDefinitions/l-interface"
53897 $ref: "#/getDefinitions/lag-interface"
53901 $ref: "#/getDefinitions/vf-module"
53909 $ref: "#/getDefinitions/generic-vnf"
53912 Openstack group-assignment used to store exclusivity groups (EG).
53913 ###### Related Nodes
53914 - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53915 - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
53916 - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
53924 description: Group id, expected to be unique across cloud-region.
53927 description: Group type - the type of group this instance refers to
53930 description: Group name - name assigned to the group
53933 description: Group description - description of the group
53936 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53940 $ref: "#/getDefinitions/relationship"
53943 Collection of openstack group assignments
53948 $ref: "#/getDefinitions/group-assignment"
53951 ###### Related Nodes
53952 - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
53960 description: host-route id
53963 description: subnet prefix
53966 description: Could be ip-address, hostname, or service-instance
53969 description: Should be ip-address, hostname, or service-instance to match next-hop
53972 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53976 $ref: "#/getDefinitions/relationship"
53982 $ref: "#/getDefinitions/host-route"
53986 ###### Related Nodes
53987 - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53988 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
53989 - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
53990 - IMAGE cannot be deleted if linked to VSERVER
53991 - IMAGE is DELETED when these are DELETED METADATUM
54001 description: Image id, expected to be unique across cloud region
54004 description: Image name
54005 image-architecture:
54007 description: Operating system architecture.
54010 description: The common name of the operating system distribution in lowercase
54013 description: The operating system version as specified by the distributor.
54016 description: The application that the image instantiates.
54017 application-vendor:
54019 description: The vendor of the application.
54020 application-version:
54022 description: The version of the application.
54025 description: URL to endpoint where AAI can get more details
54028 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54032 $ref: "#/getDefinitions/relationship"
54036 $ref: "#/getDefinitions/metadatum"
54039 Collectio of Openstack images.
54044 $ref: "#/getDefinitions/image"
54045 include-node-filter:
54051 InstanceFilter for performing a named-query or model query
54054 InstanceFilters for performing a named-query or model query
54059 $ref: "#/getDefinitions/instance-filter"
54062 General mechanism for grouping instances
54063 ###### Related Nodes
54064 - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
54065 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54066 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54067 - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54068 - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54076 description: Instance Group ID, UUID assigned to this instance.
54079 description: Descriptive text to help identify the usage of this instance-group
54082 description: Only valid value today is lower case ha for high availability
54085 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
54088 description: Concurrency value
54092 $ref: "#/getDefinitions/relationship"
54095 Collection of openstack route table references
54100 $ref: "#/getDefinitions/instance-group"
54105 $ref: "#/getDefinitions/search"
54108 $ref: "#/getDefinitions/actions"
54109 cloud-infrastructure:
54111 $ref: "#/getDefinitions/cloud-infrastructure"
54114 $ref: "#/getDefinitions/business"
54115 service-design-and-creation:
54117 $ref: "#/getDefinitions/service-design-and-creation"
54120 $ref: "#/getDefinitions/network"
54123 $ref: "#/getDefinitions/aai-internal"
54126 inventory-item-type:
54128 inventory-item-link:
54130 inventory-item-data:
54133 $ref: "#/getDefinitions/inventory-item-data"
54134 tagged-inventory-item-list:
54137 $ref: "#/getDefinitions/tagged-inventory-item-list"
54138 inventory-item-data:
54144 inventory-response-item:
54146 Inventory item for response list
54152 $ref: "#/getDefinitions/extra-properties"
54153 inventory-response-items:
54155 $ref: "#/getDefinitions/inventory-response-items"
54156 inventory-response-items:
54158 Container for inventory items in response list
54160 inventory-response-item:
54163 $ref: "#/getDefinitions/inventory-response-item"
54164 ipsec-configuration:
54166 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
54167 ###### Related Nodes
54168 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
54169 - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
54170 - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
54172 - ipsec-configuration-id
54174 ipsec-configuration-id:
54176 description: UUID of this configuration
54177 requested-vig-address-type:
54179 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
54180 requested-encryption-strength:
54182 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
54183 requested-dmz-type:
54185 description: can offer a shared DMZ or a DMZ specific to a customer
54186 shared-dmz-network-address:
54188 description: Network address of shared DMZ
54189 requested-customer-name:
54191 description: If the DMZ is a custom DMZ, this field will indicate the customer information
54194 description: can be 1 or 2
54195 ikev1-authentication:
54197 description: Contains values like md5, sha1, sha256, sha384
54200 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
54203 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
54206 description: Group name defined in VIG for clients using aggressive mode
54209 description: pre-shared key for the above group name
54212 description: Lifetime for IKEv1 SA
54213 ipsec-authentication:
54215 description: md5, sha1, sha256, sha384
54218 description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
54221 description: Life time for IPSec SA
54224 description: enable PFS or not
54227 description: user ID for xAuth, sm-user, ,nmteHostName
54228 xauth-user-password:
54230 description: Encrypted using the Juniper $9$ algorithm
54233 description: The time between DPD probe
54236 description: Maximum number of DPD before claiming the tunnel is down
54239 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54243 $ref: "#/getDefinitions/relationship"
54247 $ref: "#/getDefinitions/vig-server"
54248 ipsec-configurations:
54250 ipsec-configuration:
54253 $ref: "#/getDefinitions/ipsec-configuration"
54262 Logical interfaces, e.g., a vnic.
54263 ###### Related Nodes
54264 - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54265 - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
54266 - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
54267 - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
54268 - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
54269 - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
54270 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
54271 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
54272 - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
54273 - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
54274 - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
54275 - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
54281 description: Name given to the interface
54284 description: E.g., CUSTOMER, UPLINK, etc.
54287 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
54290 description: URL to endpoint where AAI can get more details
54293 description: ID of interface
54296 description: MAC address for the interface
54299 description: Name of the network
54302 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
54305 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54309 $ref: "#/getDefinitions/vlan"
54313 $ref: "#/getDefinitions/sriov-vf"
54317 $ref: "#/getDefinitions/relationship"
54318 l3-interface-ipv4-address-list:
54321 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
54322 l3-interface-ipv6-address-list:
54325 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
54328 Collection of logical interfaces.
54333 $ref: "#/getDefinitions/l-interface"
54334 l3-interface-ipv4-address-list:
54337 ###### Related Nodes
54338 - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
54339 - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
54340 - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
54341 - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
54343 - l3-interface-ipv4-address
54345 l3-interface-ipv4-address:
54347 description: IP address
54348 l3-interface-ipv4-prefix-length:
54351 description: Prefix length, 32 for single address
54355 description: Inner VLAN tag
54359 description: Outer VLAN tag
54362 description: Indicator of fixed or floating address
54365 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54366 neutron-network-id:
54368 description: Neutron network id of the interface that address belongs to
54371 description: Neutron id of subnet that address belongs to
54375 $ref: "#/getDefinitions/relationship"
54376 l3-interface-ipv6-address-list:
54379 ###### Related Nodes
54380 - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
54381 - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
54382 - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
54383 - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
54385 - l3-interface-ipv6-address
54387 l3-interface-ipv6-address:
54389 description: IP address
54390 l3-interface-ipv6-prefix-length:
54393 description: Prefix length, 128 for single address
54397 description: Inner VLAN tag
54401 description: Outer VLAN tag
54404 description: Indicator of fixed or floating address
54407 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54408 neutron-network-id:
54410 description: Neutron network id of the interface that address belongs to
54413 description: Neutron id of subnet that address belongs to
54417 $ref: "#/getDefinitions/relationship"
54420 Generic network definition
54421 ###### Related Nodes
54422 - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
54423 - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
54424 - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
54425 - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54426 - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54427 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54428 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
54429 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
54430 - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
54431 - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
54432 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
54433 - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
54434 - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54435 - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
54436 - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
54441 - is-provider-network
54442 - is-shared-network
54443 - is-external-network
54447 description: Network ID, should be uuid. Unique across A&AI.
54450 description: Name of the network, governed by some naming convention..
54453 description: Type of the network - who defines these values?
54456 description: Role the network plans - who defines these values?
54457 network-technology:
54459 description: Network technology - who defines these values?
54460 neutron-network-id:
54462 description: Neutron network id of this Interface
54467 description: Unique identifier of service from ASDC
54468 network-role-instance:
54471 description: network role instance
54474 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54475 orchestration-status:
54477 description: Orchestration status of this VNF, mastered by MSO
54480 description: Heat stack id corresponding to this instance, managed by MSO
54483 description: Corresponds to the SDN-C catalog id used to configure this VCE
54484 contrail-network-fqdn:
54486 description: Contrail FQDN for the network
54489 description: the ASDC model id for this resource or service model.
54490 persona-model-version:
54492 description: the ASDC model version for this resource or service model.
54495 description: the ASDC model version for this resource or service model.
54498 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
54499 widget-model-version:
54501 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
54502 physical-network-name:
54504 description: Name associated with the physical network.
54505 is-provider-network:
54509 is-external-network:
54514 $ref: "#/getDefinitions/subnet"
54518 $ref: "#/getDefinitions/ctag-assignment"
54519 segmentation-assignments:
54522 $ref: "#/getDefinitions/segmentation-assignment"
54526 $ref: "#/getDefinitions/relationship"
54527 description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
54533 $ref: "#/getDefinitions/l3-network"
54536 Link aggregate interface
54537 ###### Related Nodes
54538 - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54539 - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
54540 - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
54541 - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
54542 - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
54543 - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
54544 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
54545 - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
54546 - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK
54552 description: Name that identifies the link aggregate interface
54555 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54558 description: Captures the numeric part of the speed
54561 description: Captures the units corresponding to the speed
54565 $ref: "#/getDefinitions/relationship"
54569 $ref: "#/getDefinitions/l-interface"
54572 Collection of link aggregate interfaces.
54577 $ref: "#/getDefinitions/lag-interface"
54580 LAG links can connect lag-interfaces
54581 ###### Related Nodes
54582 - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
54583 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
54589 description: Alphabetical concatenation of lag-interface names
54592 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54596 $ref: "#/getDefinitions/relationship"
54599 Collection of link aggregation connections
54604 $ref: "#/getDefinitions/lag-link"
54607 Metadata for license group.
54608 ###### Related Nodes
54609 - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54610 - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
54617 description: Unique ID for the license group the resource belongs to, should be uuid.
54620 description: Unique ID of a license resource.
54623 description: Concurrency value
54627 $ref: "#/getDefinitions/relationship"
54630 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
54635 $ref: "#/getDefinitions/license"
54638 describes a line-of-business
54639 ###### Related Nodes
54640 - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
54642 - line-of-business-name
54644 line-of-business-name:
54646 description: Name of the line-of-business (product)
54649 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54653 $ref: "#/getDefinitions/relationship"
54656 Collection of lines-of-business
54661 $ref: "#/getDefinitions/line-of-business"
54664 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
54665 ###### Related Nodes
54666 - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
54667 - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
54668 - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
54669 - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
54670 - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
54671 - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
54672 - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
54673 - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
54674 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
54675 - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
54676 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
54683 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
54686 description: Type of logical link, e.g., evc
54689 description: Captures the numeric part of the speed
54692 description: Captures the units corresponding to the speed
54695 description: v4, v6, or ds for dual stack
54698 description: For example, static or BGP
54701 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54704 description: the ASDC model id for this resource or service model.
54705 persona-model-version:
54707 description: the ASDC model version for this resource or service model.
54710 description: the ASDC model version for this resource or service model.
54713 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
54714 widget-model-version:
54716 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
54717 operational-status:
54719 description: Indication of operational status of the logical link.
54722 description: Indication of the network use of the logical link.
54725 description: Alias or alternate name (CLCI or D1 name).
54728 description: UUID of the logical-link, SDNC generates this.
54732 $ref: "#/getDefinitions/relationship"
54735 Collection of logical connections
54740 $ref: "#/getDefinitions/logical-link"
54743 Collection of metadatum (key/value pairs)
54748 $ref: "#/getDefinitions/metadatum"
54752 ###### Related Nodes
54753 - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
54754 - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
54755 - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
54756 - TO model( metadatum org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
54767 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54770 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models
54771 ###### Related Nodes
54772 - TO model( model-element isA model, MANY2ONE)
54773 - TO model-element (CHILD of model, model startsWith model-element, ONE2MANY)
54774 - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
54775 - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
54776 - FROM model-element( model-element isA model, MANY2ONE)
54777 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
54778 - MODEL cannot be deleted if linked to NAMED-QUERY,NAMED-QUERY-ELEMENT
54779 - MODEL is DELETED when these are DELETED METADATUM
54780 - MODEL deletion means associated objects of these types are also DELETED:MODEL-ELEMENT
54782 - model-name-version-id
54788 model-name-version-id:
54790 description: Unique identifier corresponding to one version of a model in ASDC
54793 description: Type of the model, e.g., service, resource, widget, etc.
54796 description: Name of the model, which can change from version to version.
54799 description: Invariant unique ID which does not change from version to version
54802 description: Version
54805 description: Description
54808 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54812 $ref: "#/getDefinitions/model-element"
54816 $ref: "#/getDefinitions/metadatum"
54820 $ref: "#/getDefinitions/relationship"
54821 model-and-named-query-search:
54823 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
54827 $ref: "#/getDefinitions/query-parameters"
54830 $ref: "#/getDefinitions/instance-filters"
54835 This is how we would capture constraints defining allowed sets of elements.
54836 ###### Related Nodes
54837 - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
54838 - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
54839 - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
54841 - model-constraint-uuid
54842 - constrained-element-set-uuid-to-replace
54844 model-constraint-uuid:
54846 constrained-element-set-uuid-to-replace:
54848 constrained-element-sets:
54851 $ref: "#/getDefinitions/constrained-element-set"
54857 $ref: "#/getDefinitions/model-constraint"
54860 Defines how other models combine to make up a higher-level model.
54861 ###### Related Nodes
54862 - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
54863 - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
54864 - TO model( model-element isA model, MANY2ONE)
54865 - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
54866 - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
54867 - FROM model (PARENT of model-element, model startsWith model-element)
54868 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
54869 - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
54871 - model-element-uuid
54872 - new-data-del-flag
54875 model-element-uuid:
54879 description: Indicates whether this element was created as part of instantiation from this model
54882 description: How many of this type of element are required/allowed
54887 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54891 $ref: "#/getDefinitions/model-element"
54892 description: Defines how other models combine to make up a higher-level model
54896 $ref: "#/getDefinitions/model-constraint"
54897 description: Describes new constraints on this model element that are not part of that model's definition
54901 $ref: "#/getDefinitions/relationship"
54907 $ref: "#/getDefinitions/model-element"
54910 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
54911 ###### Related Nodes
54912 - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
54913 - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
54914 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
54915 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
54916 - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
54917 - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
54925 description: Unique identifier corresponding to one version of a model in ASDC
54928 description: Name of the model, which can change from version to version.
54931 description: Version
54934 description: Description
54937 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54941 $ref: "#/getDefinitions/model-element"
54945 $ref: "#/getDefinitions/metadatum"
54949 $ref: "#/getDefinitions/relationship"
54955 $ref: "#/getDefinitions/model-ver"
54958 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
54963 $ref: "#/getDefinitions/model"
54964 multicast-configuration:
54966 ###### Related Nodes
54967 - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
54969 - multicast-configuration-id
54970 - multicast-protocol
54973 multicast-configuration-id:
54975 description: Unique id of multicast configuration.
54976 multicast-protocol:
54978 description: protocol of multicast configuration
54981 description: rp type of multicast configuration
54984 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
54988 $ref: "#/getDefinitions/relationship"
54989 multicast-configurations:
54991 multicast configuration of generic-vnf ip-address
54993 multicast-configuration:
54996 $ref: "#/getDefinitions/multicast-configuration"
55002 $ref: "#/getDefinitions/named-query"
55006 ###### Related Nodes
55007 - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
55008 - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
55009 - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
55010 - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
55014 - named-query-version
55020 named-query-version:
55022 required-input-param:
55028 named-query-elements:
55031 $ref: "#/getDefinitions/named-query-element"
55035 $ref: "#/getDefinitions/relationship"
55036 named-query-element:
55039 ###### Related Nodes
55040 - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
55041 - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
55042 - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55043 - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55044 - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55045 - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55046 - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
55048 - named-query-element-uuid
55050 named-query-element-uuid:
55052 property-collect-list:
55056 property-limit-desc:
55060 named-query-elements:
55063 $ref: "#/getDefinitions/named-query-element"
55067 $ref: "#/getDefinitions/related-lookup"
55068 property-constraints:
55071 $ref: "#/getDefinitions/property-constraint"
55075 $ref: "#/getDefinitions/relationship"
55076 named-query-elements:
55078 named-query-element:
55081 $ref: "#/getDefinitions/named-query-element"
55084 Namespace for network inventory resources.
55089 $ref: "#/getDefinitions/logical-link"
55093 $ref: "#/getDefinitions/site-pair-set"
55097 $ref: "#/getDefinitions/vpn-binding"
55101 $ref: "#/getDefinitions/vpls-pe"
55102 multicast-configurations:
55105 $ref: "#/getDefinitions/multicast-configuration"
55109 $ref: "#/getDefinitions/vce"
55113 $ref: "#/getDefinitions/vnfc"
55117 $ref: "#/getDefinitions/l3-network"
55121 $ref: "#/getDefinitions/network-policy"
55125 $ref: "#/getDefinitions/generic-vnf"
55129 $ref: "#/getDefinitions/lag-link"
55133 $ref: "#/getDefinitions/newvce"
55137 $ref: "#/getDefinitions/pnf"
55141 $ref: "#/getDefinitions/physical-link"
55142 ipsec-configurations:
55145 $ref: "#/getDefinitions/ipsec-configuration"
55146 route-table-references:
55149 $ref: "#/getDefinitions/route-table-reference"
55155 $ref: "#/getDefinitions/network-policy"
55158 ###### Related Nodes
55159 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
55161 - network-policy-id
55165 description: UUID representing unique key to this instance
55166 network-policy-fqdn:
55168 description: Contrail FQDN for the policy
55171 description: ID for the openStack Heat instance
55174 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55178 $ref: "#/getDefinitions/relationship"
55181 Network profile populated by SDN-GP for SNMP
55182 ###### Related Nodes
55183 - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
55189 description: Unique name of network profile.
55192 description: Encrypted SNMP community string
55195 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55199 $ref: "#/getDefinitions/relationship"
55202 Collection of network profiles
55207 $ref: "#/getDefinitions/network-profile"
55210 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
55211 ###### Related Nodes
55212 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
55213 - NEWVCE is DELETED when these are DELETED L-INTERFACE
55221 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
55224 description: Name of VNF.
55227 description: Alternate name of VNF.
55230 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
55233 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
55236 description: Indicator for whether the resource is considered operational
55239 description: License key
55242 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).
55245 description: Client should send valid enumerated value.
55248 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55249 ipv4-loopback0-address:
55251 description: v4 Loopback0 address
55252 orchestration-status:
55254 description: Orchestration status of this VNF, mastered by MSO.
55257 description: Heat stack id corresponding to this instance, managed by MSO
55260 description: Corresponds to the SDN-C catalog id used to configure this VCE
55264 $ref: "#/getDefinitions/relationship"
55268 $ref: "#/getDefinitions/l-interface"
55271 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
55276 $ref: "#/getDefinitions/newvce"
55277 notification-event:
55281 notification-event-header:
55283 $ref: "#/getDefinitions/notification-event-header"
55284 notification-event-header:
55325 $ref: "#/getDefinitions/key-data"
55330 OAM network, to be deprecated shortly. Do not use for new purposes.
55331 ###### Related Nodes
55332 - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
55333 - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
55334 - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
55342 description: UUID of the network. Unique across a cloud-region
55345 description: Name of the network.
55349 description: cvlan-id
55350 ipv4-oam-gateway-address:
55352 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
55353 ipv4-oam-gateway-address-prefix-length:
55356 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
55359 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55363 $ref: "#/getDefinitions/relationship"
55366 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
55371 $ref: "#/getDefinitions/oam-network"
55372 operational-environment:
55374 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
55375 ###### Related Nodes
55376 - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
55377 - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
55379 - operational-environment-id
55380 - operational-environment-name
55381 - operational-environment-type
55382 - operational-environment-status
55386 operational-environment-id:
55388 description: UUID of an operational environment
55389 operational-environment-name:
55391 description: Operational Environment name
55392 operational-environment-type:
55394 description: Operational Environment Type.
55395 operational-environment-status:
55397 description: Status
55400 description: Tenant Context.
55403 description: Workload Context.
55406 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55410 $ref: "#/getDefinitions/relationship"
55411 operational-environments:
55413 a logical partition of the cloud which allows to have multiple environments in the production AIC.
55415 operational-environment:
55418 $ref: "#/getDefinitions/operational-environment"
55421 Allows for legacy POST of old-style and new-style models
55423 - model-invariant-id
55424 - model-name-version-id
55430 model-invariant-id:
55432 description: Unique identifier corresponding to the main definition of a model in ASDC
55433 model-name-version-id:
55435 description: Unique identifier corresponding to one version of a model in ASDC
55438 description: Type of the model, e.g., service, resource, widget, etc.
55441 description: Name of the model, which can change from version to version.
55444 description: Invariant unique ID which does not change from version to version
55447 description: Version
55450 description: Description
55453 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55456 $ref: "#/getDefinitions/model-vers"
55459 $ref: "#/getDefinitions/relationship-list"
55462 Collection of owning-entities
55467 $ref: "#/getDefinitions/owning-entity"
55470 describes an owning-entity
55471 ###### Related Nodes
55472 - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
55475 - owning-entity-name
55479 description: UUID of an owning entity
55480 owning-entity-name:
55482 description: Owning entity name
55485 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55489 $ref: "#/getDefinitions/relationship"
55492 Physical interface (e.g., nic)
55493 ###### Related Nodes
55494 - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
55495 - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
55496 - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
55497 - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
55498 - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
55499 - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
55500 - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
55501 - P-INTERFACE is DELETED when these are DELETED L-INTERFACE
55502 - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
55508 description: Name that identifies the physical interface
55511 description: Captures the numeric part of the speed
55514 description: Captures the units corresponding to the speed
55517 description: Nature of the services and connectivity on this port.
55518 equipment-identifier:
55520 description: CLEI or other specification for p-interface hardware.
55523 description: Role specification for p-interface hardware.
55526 description: Indicates the physical properties of the interface.
55529 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55533 $ref: "#/getDefinitions/relationship"
55537 $ref: "#/getDefinitions/l-interface"
55540 Collection of physical interfaces.
55545 $ref: "#/getDefinitions/p-interface"
55548 Collection of physical connections, typically between p-interfaces
55549 ###### Related Nodes
55550 - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
55556 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
55559 description: Captures the numeric part of the speed
55562 description: Captures the units corresponding to the speed
55565 description: Circuit it
55568 description: Dual access mode (e.g., primary, secondary
55571 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
55572 service-provider-name:
55574 description: Name of the service Provider on this link.
55577 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55581 $ref: "#/getDefinitions/relationship"
55584 Collection of physical connections, typically between p-interfaces
55589 $ref: "#/getDefinitions/physical-link"
55592 describes a platform
55593 ###### Related Nodes
55594 - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
55600 description: Name of the platform
55603 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55607 $ref: "#/getDefinitions/relationship"
55610 Collection of platforms
55615 $ref: "#/getDefinitions/platform"
55618 PNF represents a physical network function. typically equipment used in the D1 world.
55619 ###### Related Nodes
55620 - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
55621 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
55622 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
55623 - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
55624 - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
55631 description: unique name of Physical Network Function.
55634 description: name of Physical Network Function.
55637 description: source of name2
55640 description: id of pnf
55643 description: Equipment type. Source of truth should define valid values.
55646 description: Equipment vendor. Source of truth should define valid values.
55649 description: Equipment model. Source of truth should define valid values.
55652 description: identifier of managed by company or customer
55655 description: ipv4-oam-address with new naming convention for IP addresses
55658 description: sw-version is the version of SW for the hosted application on the PNF.
55659 orchestration-status:
55661 description: orchestration-status is the status of orchestration on the PNF.
55666 description: ID of the physical frame (relay rack) where pnf is installed.
55669 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55673 $ref: "#/getDefinitions/relationship"
55677 $ref: "#/getDefinitions/p-interface"
55681 $ref: "#/getDefinitions/lag-interface"
55684 Collection of Physical Network Functions.
55689 $ref: "#/getDefinitions/pnf"
55692 Used to capture the network interfaces of this VCE
55693 ###### Related Nodes
55694 - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
55695 - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
55696 - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
55699 - orchestration-status
55703 description: Unique ID of the interface
55704 neutron-network-id:
55706 description: Neutron network id of this Interface
55707 neutron-network-name:
55709 description: Neutron network name of this Interface
55712 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
55715 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55718 description: Unique ID for port group in vmware
55721 description: Likely to duplicate value of neutron network name
55724 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
55725 orchestration-status:
55727 description: Orchestration status of this VNF, mastered by MSO
55730 description: Heat stack id corresponding to this instance, managed by MSO
55733 description: Corresponds to the SDN-C catalog id used to configure this VCE
55737 $ref: "#/getDefinitions/cvlan-tag-entry"
55741 $ref: "#/getDefinitions/relationship"
55747 $ref: "#/getDefinitions/port-group"
55750 describes the project
55751 ###### Related Nodes
55752 - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
55758 description: Name of the project deploying a service
55761 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55765 $ref: "#/getDefinitions/relationship"
55768 Collection of projects
55773 $ref: "#/getDefinitions/project"
55776 Property holder for query properties or instance properties
55782 property-constraint:
55785 ###### Related Nodes
55786 - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55788 - property-constraint-uuid
55793 property-constraint-uuid:
55803 property-constraints:
55805 property-constraint:
55808 $ref: "#/getDefinitions/property-constraint"
55811 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
55812 ###### Related Nodes
55813 - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
55814 - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
55815 - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
55816 - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
55817 - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
55818 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
55819 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
55820 - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
55821 - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
55822 - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
55823 - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
55824 - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
55831 description: Value from executing hostname on the compute node.
55834 description: PTNII name
55838 description: Number of cpus
55842 description: Disk size, in GBs
55846 description: RAM size, in MBs
55849 description: Equipment type. Source of truth should define valid values.
55852 description: Equipment vendor. Source of truth should define valid values.
55855 description: Equipment model. Source of truth should define valid values.
55858 description: Fully-qualified domain name
55861 description: URL to endpoint where AAI can get more details
55864 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
55867 description: Serial number, may be queried
55870 description: ID of Pserver
55873 description: internet topology of Pserver
55878 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
55881 description: alternative pserver name
55884 description: purpose of pserver
55888 $ref: "#/getDefinitions/relationship"
55892 $ref: "#/getDefinitions/p-interface"
55896 $ref: "#/getDefinitions/lag-interface"
55899 Collection of compute hosts.
55904 $ref: "#/getDefinitions/pserver"
55907 QueryParameters for performing a named-query or model query
55911 $ref: "#/getDefinitions/named-query"
55914 $ref: "#/getDefinitions/model"
55918 ###### Related Nodes
55919 - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55921 - related-lookup-uuid
55923 - source-node-property
55925 - target-node-property
55927 related-lookup-uuid:
55931 source-node-property:
55935 target-node-property:
55937 property-collect-list:
55944 $ref: "#/getDefinitions/relationship"
55950 $ref: "#/getDefinitions/related-lookup"
55951 related-to-property:
55955 description: Key part of a key/value pair
55958 description: Value part of a key/value pair
55963 description: A keyword provided by A&AI to indicate type of node.
55966 description: URL to the object in A&AI.
55970 $ref: "#/getDefinitions/relationship-data"
55971 related-to-property:
55974 $ref: "#/getDefinitions/related-to-property"
55978 - relationship-value
55982 description: A keyword provided by A&AI to indicate an attribute.
55983 relationship-value:
55985 description: Value of the attribute.
55991 $ref: "#/getDefinitions/relationship"
55992 reserved-prop-names:
55994 Internal map to define some reserved properties of a vertex
55996 last-mod-source-of-truth:
56012 Response container for the results of a named-query or model query
56014 inventory-response-items:
56016 $ref: "#/getDefinitions/inventory-response-items"
56021 description: The specific type of node in the A&AI graph
56024 description: The URL to the specific resource
56025 route-table-reference:
56027 Openstack route table reference.
56028 ###### Related Nodes
56029 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
56031 - route-table-reference-id
56032 - route-table-reference-fqdn
56034 route-table-reference-id:
56036 description: Route Table Reference id, UUID assigned to this instance.
56037 route-table-reference-fqdn:
56039 description: FQDN entry in the route table.
56042 description: Concurrency value
56046 $ref: "#/getDefinitions/relationship"
56047 route-table-references:
56049 Collection of openstack route table references
56051 route-table-reference:
56054 $ref: "#/getDefinitions/route-table-reference"
56057 Route target information
56058 ###### Related Nodes
56059 - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
56061 - global-route-target
56062 - route-target-role
56064 global-route-target:
56066 description: Number used to identify an RT, globally unique in the network
56069 description: Role assigned to this route target
56072 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56076 $ref: "#/getDefinitions/relationship"
56079 Collection of route target information
56084 $ref: "#/getDefinitions/route-target"
56087 ###### Related Nodes
56088 - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
56089 - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
56090 - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
56092 - routing-instance-id
56094 routing-instance-id:
56096 description: Unique id of routing instance
56099 description: rpm owner
56102 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56106 $ref: "#/getDefinitions/site-pair"
56110 $ref: "#/getDefinitions/relationship"
56113 set of probes related to generic-vnf routing instance
56118 $ref: "#/getDefinitions/routing-instance"
56123 $ref: "#/getDefinitions/oam-networks"
56124 az-and-dvs-switches:
56127 $ref: "#/getDefinitions/az-and-dvs-switches"
56130 edge-tag-query-result:
56132 $ref: "#/getDefinitions/edge-tag-query-result"
56133 edge-tag-query-request:
56135 $ref: "#/getDefinitions/edge-tag-query-request"
56138 $ref: "#/getDefinitions/search-results"
56141 $ref: "#/getDefinitions/sdn-zone-response"
56147 $ref: "#/getDefinitions/result-data"
56150 SecondaryFilt for performing a named-query or model query
56161 SecondaryFilts for performing a named-query or model query
56166 $ref: "#/getDefinitions/secondary-filt"
56167 segmentation-assignment:
56169 Openstack segmentation assignment.
56170 ###### Related Nodes
56171 - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
56177 description: Route Table Reference id, UUID assigned to this instance.
56180 description: Concurrency value
56184 $ref: "#/getDefinitions/relationship"
56185 segmentation-assignments:
56187 Collection of openstack segmentation assignments
56189 segmentation-assignment:
56192 $ref: "#/getDefinitions/segmentation-assignment"
56195 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC.
56198 - service-description
56202 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
56203 service-description:
56205 description: Description of the service
56208 description: URL to endpoint where AAI can get more details
56211 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56214 description: service version
56218 $ref: "#/getDefinitions/relationship"
56219 service-capabilities:
56221 Collection of service capabilities.
56223 service-capability:
56226 $ref: "#/getDefinitions/service-capability"
56227 service-capability:
56229 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
56230 ###### Related Nodes
56231 - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
56232 - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
56233 - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
56240 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
56243 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
56246 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56250 $ref: "#/getDefinitions/relationship"
56251 service-design-and-creation:
56253 Namespace for objects managed by ASDC
56258 $ref: "#/getDefinitions/vnf-image"
56262 $ref: "#/getDefinitions/service"
56263 service-capabilities:
56266 $ref: "#/getDefinitions/service-capability"
56270 $ref: "#/getDefinitions/model"
56274 $ref: "#/getDefinitions/named-query"
56277 Instance of a service
56278 ###### Related Nodes
56279 - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
56280 - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
56281 - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
56282 - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
56283 - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
56284 - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
56285 - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
56286 - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
56287 - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
56288 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
56289 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
56290 - SERVICE-INSTANCE is DELETED when these are DELETED METADATUM
56291 - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
56293 - service-instance-id
56295 service-instance-id:
56297 description: Uniquely identifies this instance of a service
56298 service-instance-name:
56300 description: This field will store a name assigned to the service-instance.
56303 description: the ASDC model id for this resource or service model.
56304 persona-model-version:
56306 description: the ASDC model version for this resource or service model.
56309 description: the ASDC model version for this resource or service model.
56312 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
56313 widget-model-version:
56315 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
56318 description: Indicates the total bandwidth to be used for this service.
56321 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
56322 bandwidth-down-wan1:
56324 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
56327 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
56328 bandwidth-down-wan2:
56330 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
56333 description: URL customers will use to access the vHN Portal.
56334 service-instance-location-id:
56336 description: An identifier that customers assign to the location where this service is being used.
56339 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56343 $ref: "#/getDefinitions/relationship"
56347 $ref: "#/getDefinitions/metadatum"
56350 Collection of service instances
56355 $ref: "#/getDefinitions/service-instance"
56356 service-subscription:
56358 Object that group service instances.
56359 ###### Related Nodes
56360 - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
56361 - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
56362 - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
56363 - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
56369 description: Value defined by orchestration to identify this service across ECOMP.
56370 temp-ub-sub-account-id:
56372 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
56375 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56379 $ref: "#/getDefinitions/service-instance"
56383 $ref: "#/getDefinitions/relationship"
56384 service-subscriptions:
56386 Collection of objects that group service instances.
56388 service-subscription:
56391 $ref: "#/getDefinitions/service-subscription"
56394 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
56399 $ref: "#/getDefinitions/service"
56402 ###### Related Nodes
56403 - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
56404 - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
56405 - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
56411 description: unique identifier of probe
56414 description: Prefix address
56417 description: Prefix address
56420 description: ip version, v4, v6
56421 destination-hostname:
56423 description: Hostname of the destination equipment to which SLAs are measured against.
56424 destination-equip-type:
56426 description: The type of destinatination equipment. Could be Router, etc.
56429 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56430 classes-of-service:
56433 $ref: "#/getDefinitions/class-of-service"
56437 $ref: "#/getDefinitions/relationship"
56440 Set of instances for probes used to measure service level agreements
56441 ###### Related Nodes
56442 - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
56443 - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
56444 - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
56450 description: Unique id of site pair set.
56453 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56457 $ref: "#/getDefinitions/routing-instance"
56461 $ref: "#/getDefinitions/relationship"
56464 Collection of sets of instances for probes related to generic-vnf
56469 $ref: "#/getDefinitions/site-pair-set"
56477 $ref: "#/getDefinitions/site-pair"
56481 ###### Related Nodes
56482 - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56483 - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
56489 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
56492 description: Snapshot name
56493 snapshot-architecture:
56495 description: Operating system architecture
56496 snapshot-os-distro:
56498 description: The common name of the operating system distribution in lowercase
56499 snapshot-os-version:
56501 description: The operating system version as specified by the distributor.
56504 description: The application that the image instantiates.
56505 application-vendor:
56507 description: The vendor of the application.
56508 application-version:
56510 description: The version of the application.
56513 description: URL to endpoint where AAI can get more details
56516 description: This field contains the UUID of the previous snapshot (if any).
56519 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56523 $ref: "#/getDefinitions/relationship"
56526 Collection of openstack snapshots
56531 $ref: "#/getDefinitions/snapshot"
56534 SR-IOV Physical Function
56535 ###### Related Nodes
56536 - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
56537 - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
56543 description: Identifier for the sriov-pf
56546 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56550 $ref: "#/getDefinitions/relationship"
56553 Collection of SR-IOV Physical Functions.
56558 $ref: "#/getDefinitions/sriov-pf"
56561 SR-IOV Virtual Function (not to be confused with virtual network function)
56562 ###### Related Nodes
56563 - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
56569 description: PCI ID used to identify the sriov-vf
56572 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
56575 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
56578 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
56579 vf-vlan-anti-spoof-check:
56581 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.
56582 vf-mac-anti-spoof-check:
56584 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.
56587 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
56588 vf-broadcast-allow:
56590 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
56591 vf-unknown-multicast-allow:
56593 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
56594 vf-unknown-unicast-allow:
56596 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
56599 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
56602 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
56605 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56606 neutron-network-id:
56608 description: Neutron network id of the interface
56612 $ref: "#/getDefinitions/relationship"
56615 Collection of SR-IOV Virtual Functions.
56620 $ref: "#/getDefinitions/sriov-vf"
56629 ###### Related Nodes
56630 - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
56631 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
56632 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
56633 - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
56640 description: Subnet ID, should be UUID.
56643 description: Name associated with the subnet.
56646 description: Neutron id of this subnet
56649 description: gateway ip address
56650 network-start-address:
56652 description: network start address
56655 description: cidr mask
56658 description: ip version
56659 orchestration-status:
56661 description: Orchestration status of this VNF, mastered by MSO
56666 description: the start address reserved for use by dhcp
56669 description: the last address reserved for use by dhcp
56672 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56676 $ref: "#/getDefinitions/relationship"
56682 $ref: "#/getDefinitions/subnet"
56683 tagged-inventory-item-list:
56688 $ref: "#/getDefinitions/inventory-item"
56692 ###### Related Nodes
56693 - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56694 - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
56695 - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
56696 - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
56697 - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
56698 - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
56699 - TENANT cannot be deleted if linked to VSERVER
56706 description: Unique id relative to the cloud-region.
56709 description: Readable name of tenant
56712 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56716 $ref: "#/getDefinitions/vserver"
56720 $ref: "#/getDefinitions/relationship"
56723 Collection of openstack tenants.
56728 $ref: "#/getDefinitions/tenant"
56731 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
56732 ###### Related Nodes
56733 - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
56736 - bandwidth-up-wan1
56737 - bandwidth-down-wan1
56738 - bandwidth-up-wan2
56739 - bandwidth-down-wan2
56743 description: Allotted Resource id UUID assigned to this instance.
56746 description: The WAN uplink bandwidth for WAN1
56747 bandwidth-down-wan1:
56749 description: The WAN downlink bandwidth for WAN1
56752 description: The WAN uplink bandwidth for WAN2
56753 bandwidth-down-wan2:
56755 description: The WAN downlink bandwidth for WAN2
56758 description: Concurrency value
56762 $ref: "#/getDefinitions/relationship"
56765 This object is used to store the specific tunnel cross connect aspects of an allotted resource
56770 $ref: "#/getDefinitions/tunnel-xconnect"
56773 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
56782 $ref: "#/getDefinitions/update-node-key"
56788 $ref: "#/getDefinitions/action"
56797 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
56798 ###### Related Nodes
56799 - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
56800 - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
56801 - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
56802 - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
56803 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
56804 - VCE is DELETED when these are DELETED PORT-GROUP
56812 description: Unique id of VNF. This is unique across the graph.
56815 description: Name of VNF.
56818 description: Alternate name of VNF.
56821 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
56824 description: Unique identifier of service from ASDC. Expect this to change as ASDC matures.
56825 regional-resource-zone:
56827 description: Regional way of organizing pservers, source of truth should define values
56830 description: Trigger for operational monitoring of this resource by Service Assurance systems.
56833 description: Indicator for whether the resource is considered operational
56836 description: License key
56839 description: Network role being played by this VNF
56840 orchestration-status:
56842 description: Orchestration status of this VNF, mastered by MSO
56845 description: Heat stack id corresponding to this instance, managed by MSO
56848 description: Corresponds to the SDN-C catalog id used to configure this VCE
56851 description: Unique ID of VPE connected to this VCE.
56852 v6-vce-wan-address:
56854 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
56857 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
56860 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56861 ipv4-loopback0-address:
56863 description: Loopback0 address
56864 entitlement-resource-uuid:
56866 description: Entitlement resource uuid
56870 $ref: "#/getDefinitions/port-group"
56874 $ref: "#/getDefinitions/relationship"
56877 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
56882 $ref: "#/getDefinitions/vce"
56885 a deployment unit of VNFCs
56886 ###### Related Nodes
56887 - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
56888 - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
56889 - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
56890 - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
56891 - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
56892 - VF-MODULE cannot be deleted if linked to VNFC
56895 - is-base-vf-module
56899 description: Unique ID of vf-module.
56902 description: Name of vf-module
56905 description: Heat stack id corresponding to this instance.
56906 orchestration-status:
56908 description: orchestration status of this vf-module, mastered by MSO
56913 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56916 description: the ASDC model id for this resource or service model.
56917 persona-model-version:
56919 description: the ASDC model version for this resource or service model.
56922 description: the ASDC model version for this resource or service model.
56925 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
56926 widget-model-version:
56928 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
56929 contrail-service-instance-fqdn:
56931 description: the Contrail unique ID for a service-instance
56935 $ref: "#/getDefinitions/relationship"
56938 Collection of vf-modules, a deployment unit of VNFCs
56943 $ref: "#/getDefinitions/vf-module"
56946 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
56947 ###### Related Nodes
56948 - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
56954 description: indicates whether the VIG is for AVPN or INTERNET
56957 description: v4 IP of the vig server
56960 description: v6 IP of the vig server
56963 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56967 $ref: "#/getDefinitions/relationship"
56973 $ref: "#/getDefinitions/vig-server"
56974 vip-ipv4-address-list:
56977 ###### Related Nodes
56978 - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56979 - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56980 - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
56981 - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
56987 description: IP address
56988 vip-ipv4-prefix-length:
56991 description: Prefix length, 32 for single address
56995 description: Inner VLAN tag
56999 description: Outer VLAN tag
57002 description: Indicator of fixed or floating address
57005 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57006 neutron-network-id:
57008 description: Neutron network id of the interface that address belongs to
57011 description: Neutron id of subnet that address belongs to
57015 $ref: "#/getDefinitions/relationship"
57016 vip-ipv6-address-list:
57019 ###### Related Nodes
57020 - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57021 - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
57022 - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
57023 - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
57029 description: IP address
57030 vip-ipv6-prefix-length:
57033 description: Prefix length, 128 for single address
57037 description: Inner VLAN tag
57041 description: Outer VLAN tag
57044 description: Indicator of fixed or floating address
57047 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57048 neutron-network-id:
57050 description: Neutron network id of the interface that address belongs to
57053 description: Neutron id of subnet that address belongs to
57057 $ref: "#/getDefinitions/relationship"
57058 virtual-data-center:
57060 Virtual organization of cloud infrastructure elements in a data center context
57061 ###### Related Nodes
57062 - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
57063 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
57064 - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
57071 description: Unique ID of the vdc
57074 description: Name of the virtual data center
57077 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57081 $ref: "#/getDefinitions/relationship"
57082 virtual-data-centers:
57084 Virtual organization of cloud infrastructure elements in a data center context
57086 virtual-data-center:
57089 $ref: "#/getDefinitions/virtual-data-center"
57093 ###### Related Nodes
57094 - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
57095 - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
57096 - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
57097 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
57098 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
57099 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
57100 - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
57101 - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
57107 description: String that identifies the interface
57111 description: Inner VLAN tag
57115 description: Outer VLAN tag
57118 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57121 description: Captures the numeric part of the speed
57124 description: Captures the units corresponding to the speed
57127 description: Used to describe (the service associated with) the vlan
57128 backdoor-connection:
57130 description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
57133 description: This indicates the customers VPN ID associated with this vlan
57137 $ref: "#/getDefinitions/relationship"
57138 l3-interface-ipv4-address-list:
57141 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
57142 l3-interface-ipv6-address-list:
57145 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
57151 $ref: "#/getDefinitions/vlan"
57160 description: Unique id of VNF. This is unique across the graph.
57163 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
57164 ###### Related Nodes
57165 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
57166 - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
57170 - application-vendor
57174 description: Unique ID of this asset
57177 description: The application that the image instantiates.
57178 application-vendor:
57180 description: The vendor of the application.
57181 application-version:
57183 description: The version of the application.
57186 description: URL to endpoint where AAI can get more details
57189 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57193 $ref: "#/getDefinitions/relationship"
57196 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
57201 $ref: "#/getDefinitions/vnf-image"
57204 ###### Related Nodes
57205 - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
57206 - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
57207 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
57210 - vnfc-function-code
57213 - is-closed-loop-disabled
57217 description: Unique ID of vnfc.
57218 vnfc-function-code:
57220 description: function code
57226 description: prov status of this vnfc
57227 orchestration-status:
57229 description: Orchestration status of this VNF, mastered by APP-C
57230 ipaddress-v4-oam-vip:
57232 description: Oam V4 vip address of this vnfc
57235 is-closed-loop-disabled:
57239 description: Group notation of VNFC
57242 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57246 $ref: "#/getDefinitions/relationship"
57249 virtual network components associated with a vserver from application controller.
57254 $ref: "#/getDefinitions/vnfc"
57257 Ephemeral Block storage volume.
57258 ###### Related Nodes
57259 - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
57266 description: Unique ID of block storage volume relative to the vserver.
57269 description: URL to endpoint where AAI can get more details
57272 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57276 $ref: "#/getDefinitions/relationship"
57279 Persistent block-level storage.
57280 ###### Related Nodes
57281 - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57282 - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57283 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
57284 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
57285 - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
57288 - volume-group-name
57293 description: Unique ID of volume-group.
57296 description: Name of the volume group.
57299 description: Heat stack id corresponding to this volume-group
57302 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
57303 orchestration-status:
57305 description: Orchestration status of this volume-group
57308 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57312 $ref: "#/getDefinitions/relationship"
57315 Collection of persistent block-level storage.
57320 $ref: "#/getDefinitions/volume-group"
57323 Collection of ephemeral Block storage volumes.
57328 $ref: "#/getDefinitions/volume"
57331 VPLS Provider Edge routers.
57332 ###### Related Nodes
57333 - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57334 - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
57335 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
57336 - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
57337 - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
57345 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
57348 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).
57351 description: Client should send valid enumerated value, e.g., VPLS-PE.
57355 description: Temporary location for stag to get to VCE
57358 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57362 $ref: "#/getDefinitions/relationship"
57366 $ref: "#/getDefinitions/p-interface"
57370 $ref: "#/getDefinitions/lag-interface"
57373 Collection of VPLS Provider Edge routers
57378 $ref: "#/getDefinitions/vpls-pe"
57382 ###### Related Nodes
57383 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
57384 - VPN-BINDING cannot be deleted if linked to L3-NETWORK
57388 - global-route-target
57392 description: VPN ID, globally unique within A&AI
57395 description: VPN Name
57396 global-route-target:
57398 description: Number used to identify a VPN, globally unique in the network
57401 description: the platform associated with the VPN example AVPN, Mobility
57404 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57408 $ref: "#/getDefinitions/relationship"
57409 description: l3-networks relate to vpn-bindings
57415 $ref: "#/getDefinitions/vpn-binding"
57418 Virtual Servers, aka virtual machine or VM.
57419 ###### Related Nodes
57420 - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
57421 - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
57422 - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
57423 - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
57424 - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
57425 - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
57426 - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
57427 - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
57428 - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
57429 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
57430 - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
57431 - VSERVER is DELETED when these are DELETED L-INTERFACE
57432 - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
57438 - is-closed-loop-disabled
57442 description: Unique identifier for this vserver relative to its tenant
57445 description: Name of vserver
57448 description: Alternative name of vserver
57451 description: Trigger for operational monitoring of this resource by Service Assurance systems.
57454 description: URL to endpoint where AAI can get more details
57457 is-closed-loop-disabled:
57461 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57465 $ref: "#/getDefinitions/volume"
57469 $ref: "#/getDefinitions/relationship"
57473 $ref: "#/getDefinitions/l-interface"
57476 Collection of virtual Servers, aka virtual machines or VMs.
57481 $ref: "#/getDefinitions/vserver"
57484 A zone is a grouping of assets in a location homing to the same connections into the CBB
57485 ###### Related Nodes
57486 - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57487 - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
57488 - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
57489 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
57498 description: Code assigned by AIC to the zone
57501 description: English name associated with the zone
57504 description: Design of zone [Medium/Large?]
57507 description: Context of zone [production/test]
57510 description: Status of a zone.
57513 description: Concurrency value
57517 $ref: "#/getDefinitions/relationship"
57520 Collection of zones
57525 $ref: "#/getDefinitions/zone"