5 [Differences versus the previous schema version](apidocs/aai_swagger_v9.diff)
7 Copyright © 2017 AT&T Intellectual Property. All rights reserved.
9 Licensed under the Creative Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except in compliance with the License.
11 You may obtain a copy of the License at
13 (https://creativecommons.org/licenses/by/4.0/)
15 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
17 ECOMP and OpenECOMP are trademarks and service marks of AT&T Intellectual Property.
19 This document is best viewed with Firefox or Chrome. Nodes can be found by appending /#/definitions/node-type-to-find to the path to this document. Edge definitions can be found with the node definitions.
21 title: Active and Available Inventory REST API
24 url: http://www.apache.org/licenses/LICENSE-2.0.html
34 /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship:
38 summary: see node definition for valid relationships
39 operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship
48 description: Response codes found in [response codes](https://wiki.onap.org/).
50 - name: physical-location-id
52 description: Unique identifier for physical location, e.g., CLLI
55 example: __PHYSICAL-LOCATION-ID__
58 description: The Target provider edge router
61 example: __TARGET-PE__
62 - name: availability-zone-name
64 description: Name of the availability zone
67 example: __AVAILABILITY-ZONE-NAME__
70 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)
73 $ref: "#/definitions/relationship"
77 summary: delete an existing relationship
78 description: delete an existing relationship
79 operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship
88 description: Response codes found in [response codes](https://wiki.onap.org/).
90 - name: physical-location-id
92 description: Unique identifier for physical location, e.g., CLLI
95 example: __PHYSICAL-LOCATION-ID__
98 description: The Target provider edge router
101 example: __TARGET-PE__
102 - name: availability-zone-name
104 description: Name of the availability zone
107 example: __AVAILABILITY-ZONE-NAME__
108 /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}:
111 - CloudInfrastructure
112 summary: returns ctag-pool
113 description: returns ctag-pool
114 operationId: getCloudInfrastructureComplexesComplexCtagPoolsCtagPool
120 description: successful operation
122 $ref: "#/getDefinitions/ctag-pool"
124 description: Response codes found in [response codes](https://wiki.onap.org/).
126 - name: physical-location-id
128 description: Unique identifier for physical location, e.g., CLLI
131 example: __PHYSICAL-LOCATION-ID__
134 description: The Target provider edge router
137 example: __TARGET-PE__
138 - name: availability-zone-name
140 description: Name of the availability zone
143 example: __AVAILABILITY-ZONE-NAME__
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/v9/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/v9/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/v9/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/v9/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)
573 $ref: "#/definitions/relationship"
576 - CloudInfrastructure
577 summary: delete an existing relationship
578 description: delete an existing relationship
579 operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship
588 description: Response codes found in [response codes](https://wiki.onap.org/).
592 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
595 example: __CLOUD-OWNER__
596 - name: cloud-region-id
598 description: Identifier used by the vendor for the region. Second part of composite key
601 example: __CLOUD-REGION-ID__
602 - name: volume-group-id
604 description: Unique ID of volume-group.
607 example: __VOLUME-GROUP-ID__
608 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}:
611 - CloudInfrastructure
612 summary: returns volume-group
613 description: returns volume-group
614 operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
620 description: successful operation
622 $ref: "#/getDefinitions/volume-group"
624 description: Response codes found in [response codes](https://wiki.onap.org/).
628 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
631 example: __CLOUD-OWNER__
632 - name: cloud-region-id
634 description: Identifier used by the vendor for the region. Second part of composite key
637 example: __CLOUD-REGION-ID__
638 - name: volume-group-id
640 description: Unique ID of volume-group.
643 example: __VOLUME-GROUP-ID__
646 description: Type of the cloud (e.g., openstack)
649 - name: owner-defined-type
651 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
654 - name: volume-group-name
656 description: Name of the volume group.
659 - name: heat-stack-id
661 description: Heat stack id corresponding to this volume-group
666 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
671 - CloudInfrastructure
672 summary: create or update an existing volume-group
674 Create or update an existing volume-group.
676 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
677 operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
686 description: Response codes found in [response codes](https://wiki.onap.org/).
690 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
693 example: __CLOUD-OWNER__
694 - name: cloud-region-id
696 description: Identifier used by the vendor for the region. Second part of composite key
699 example: __CLOUD-REGION-ID__
700 - name: volume-group-id
702 description: Unique ID of volume-group.
705 example: __VOLUME-GROUP-ID__
708 description: volume-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/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/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
8287 $ref: "#/definitions/relationship"
8290 - CloudInfrastructure
8291 summary: delete an existing relationship
8292 description: delete an existing relationship
8293 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
8302 description: Response codes found in [response codes](https://wiki.onap.org/).
8306 description: Value from executing hostname on the compute node.
8309 example: __HOSTNAME__
8310 - name: interface-name
8312 description: Name that identifies the physical interface
8315 example: __INTERFACE-NAME__
8316 - name: interface-name
8318 description: Name given to the interface
8321 example: __INTERFACE-NAME__
8322 - name: vlan-interface
8324 description: String that identifies the interface
8327 example: __VLAN-INTERFACE__
8328 - name: l3-interface-ipv4-address
8330 description: IP address
8333 example: __L3-INTERFACE-IPV4-ADDRESS__
8334 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
8337 - CloudInfrastructure
8338 summary: returns l3-interface-ipv4-address-list
8339 description: returns l3-interface-ipv4-address-list
8340 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8346 description: successful operation
8348 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
8350 description: Response codes found in [response codes](https://wiki.onap.org/).
8354 description: Value from executing hostname on the compute node.
8357 example: __HOSTNAME__
8358 - name: interface-name
8360 description: Name that identifies the physical interface
8363 example: __INTERFACE-NAME__
8364 - name: interface-name
8366 description: Name given to the interface
8369 example: __INTERFACE-NAME__
8370 - name: vlan-interface
8372 description: String that identifies the interface
8375 example: __VLAN-INTERFACE__
8376 - name: l3-interface-ipv4-address
8378 description: IP address
8381 example: __L3-INTERFACE-IPV4-ADDRESS__
8384 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
8389 description: ID of Pserver
8396 - name: pserver-name2
8398 description: alternative pserver name
8403 description: Trigger for operational monitoring of this resource by Service Assurance systems.
8406 - name: interface-id
8408 description: ID of interface
8413 description: MAC address for the interface
8416 - name: network-name
8418 description: Name of the network
8421 - name: vlan-id-inner
8423 description: Inner VLAN tag
8429 description: This indicates the customers VPN ID associated with this vlan
8432 - name: vlan-id-inner
8434 description: Inner VLAN tag
8438 - name: neutron-network-id
8440 description: Neutron network id of the interface that address belongs to
8443 - name: neutron-subnet-id
8445 description: Neutron id of subnet that address belongs to
8450 - CloudInfrastructure
8451 summary: create or update an existing l3-interface-ipv4-address-list
8453 Create or update an existing l3-interface-ipv4-address-list.
8455 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8456 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8465 description: Response codes found in [response codes](https://wiki.onap.org/).
8469 description: Value from executing hostname on the compute node.
8472 example: __HOSTNAME__
8473 - name: interface-name
8475 description: Name that identifies the physical interface
8478 example: __INTERFACE-NAME__
8479 - name: interface-name
8481 description: Name given to the interface
8484 example: __INTERFACE-NAME__
8485 - name: vlan-interface
8487 description: String that identifies the interface
8490 example: __VLAN-INTERFACE__
8491 - name: l3-interface-ipv4-address
8493 description: IP address
8496 example: __L3-INTERFACE-IPV4-ADDRESS__
8499 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
8502 $ref: "#/definitions/l3-interface-ipv4-address-list"
8505 - CloudInfrastructure
8506 summary: update an existing l3-interface-ipv4-address-list
8508 Update an existing l3-interface-ipv4-address-list
8510 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8511 The PUT operation will entirely replace an existing object.
8512 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8514 Other differences between PUT and PATCH are:
8516 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8517 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8518 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8519 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8528 description: Response codes found in [response codes](https://wiki.onap.org/).
8532 description: Value from executing hostname on the compute node.
8535 example: __HOSTNAME__
8536 - name: interface-name
8538 description: Name that identifies the physical interface
8541 example: __INTERFACE-NAME__
8542 - name: interface-name
8544 description: Name given to the interface
8547 example: __INTERFACE-NAME__
8548 - name: vlan-interface
8550 description: String that identifies the interface
8553 example: __VLAN-INTERFACE__
8554 - name: l3-interface-ipv4-address
8556 description: IP address
8559 example: __L3-INTERFACE-IPV4-ADDRESS__
8562 description: l3-interface-ipv4-address-list object that needs to be created or updated.
8565 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
8568 - CloudInfrastructure
8569 summary: delete an existing l3-interface-ipv4-address-list
8570 description: delete an existing l3-interface-ipv4-address-list
8571 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8580 description: Response codes found in [response codes](https://wiki.onap.org/).
8584 description: Value from executing hostname on the compute node.
8587 example: __HOSTNAME__
8588 - name: interface-name
8590 description: Name that identifies the physical interface
8593 example: __INTERFACE-NAME__
8594 - name: interface-name
8596 description: Name given to the interface
8599 example: __INTERFACE-NAME__
8600 - name: vlan-interface
8602 description: String that identifies the interface
8605 example: __VLAN-INTERFACE__
8606 - name: l3-interface-ipv4-address
8608 description: IP address
8611 example: __L3-INTERFACE-IPV4-ADDRESS__
8612 - name: resource-version
8614 description: resource-version for concurrency
8617 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
8620 - CloudInfrastructure
8621 summary: see node definition for valid relationships
8622 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
8631 description: Response codes found in [response codes](https://wiki.onap.org/).
8635 description: Value from executing hostname on the compute node.
8638 example: __HOSTNAME__
8639 - name: interface-name
8641 description: Name that identifies the physical interface
8644 example: __INTERFACE-NAME__
8645 - name: interface-name
8647 description: Name given to the interface
8650 example: __INTERFACE-NAME__
8651 - name: vlan-interface
8653 description: String that identifies the interface
8656 example: __VLAN-INTERFACE__
8657 - name: l3-interface-ipv6-address
8659 description: IP address
8662 example: __L3-INTERFACE-IPV6-ADDRESS__
8665 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
8668 $ref: "#/definitions/relationship"
8671 - CloudInfrastructure
8672 summary: delete an existing relationship
8673 description: delete an existing relationship
8674 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
8683 description: Response codes found in [response codes](https://wiki.onap.org/).
8687 description: Value from executing hostname on the compute node.
8690 example: __HOSTNAME__
8691 - name: interface-name
8693 description: Name that identifies the physical interface
8696 example: __INTERFACE-NAME__
8697 - name: interface-name
8699 description: Name given to the interface
8702 example: __INTERFACE-NAME__
8703 - name: vlan-interface
8705 description: String that identifies the interface
8708 example: __VLAN-INTERFACE__
8709 - name: l3-interface-ipv6-address
8711 description: IP address
8714 example: __L3-INTERFACE-IPV6-ADDRESS__
8715 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
8718 - CloudInfrastructure
8719 summary: returns l3-interface-ipv6-address-list
8720 description: returns l3-interface-ipv6-address-list
8721 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8727 description: successful operation
8729 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
8731 description: Response codes found in [response codes](https://wiki.onap.org/).
8735 description: Value from executing hostname on the compute node.
8738 example: __HOSTNAME__
8739 - name: interface-name
8741 description: Name that identifies the physical interface
8744 example: __INTERFACE-NAME__
8745 - name: interface-name
8747 description: Name given to the interface
8750 example: __INTERFACE-NAME__
8751 - name: vlan-interface
8753 description: String that identifies the interface
8756 example: __VLAN-INTERFACE__
8757 - name: l3-interface-ipv6-address
8759 description: IP address
8762 example: __L3-INTERFACE-IPV6-ADDRESS__
8765 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
8770 description: ID of Pserver
8777 - name: pserver-name2
8779 description: alternative pserver name
8784 description: Trigger for operational monitoring of this resource by Service Assurance systems.
8787 - name: interface-id
8789 description: ID of interface
8794 description: MAC address for the interface
8797 - name: network-name
8799 description: Name of the network
8802 - name: vlan-id-inner
8804 description: Inner VLAN tag
8810 description: This indicates the customers VPN ID associated with this vlan
8813 - name: vlan-id-inner
8815 description: Inner VLAN tag
8819 - name: neutron-network-id
8821 description: Neutron network id of the interface that address belongs to
8824 - name: neutron-subnet-id
8826 description: Neutron id of subnet that address belongs to
8831 - CloudInfrastructure
8832 summary: create or update an existing l3-interface-ipv6-address-list
8834 Create or update an existing l3-interface-ipv6-address-list.
8836 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
8837 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8846 description: Response codes found in [response codes](https://wiki.onap.org/).
8850 description: Value from executing hostname on the compute node.
8853 example: __HOSTNAME__
8854 - name: interface-name
8856 description: Name that identifies the physical interface
8859 example: __INTERFACE-NAME__
8860 - name: interface-name
8862 description: Name given to the interface
8865 example: __INTERFACE-NAME__
8866 - name: vlan-interface
8868 description: String that identifies the interface
8871 example: __VLAN-INTERFACE__
8872 - name: l3-interface-ipv6-address
8874 description: IP address
8877 example: __L3-INTERFACE-IPV6-ADDRESS__
8880 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
8883 $ref: "#/definitions/l3-interface-ipv6-address-list"
8886 - CloudInfrastructure
8887 summary: update an existing l3-interface-ipv6-address-list
8889 Update an existing l3-interface-ipv6-address-list
8891 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8892 The PUT operation will entirely replace an existing object.
8893 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
8895 Other differences between PUT and PATCH are:
8897 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
8898 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8899 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8900 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8909 description: Response codes found in [response codes](https://wiki.onap.org/).
8913 description: Value from executing hostname on the compute node.
8916 example: __HOSTNAME__
8917 - name: interface-name
8919 description: Name that identifies the physical interface
8922 example: __INTERFACE-NAME__
8923 - name: interface-name
8925 description: Name given to the interface
8928 example: __INTERFACE-NAME__
8929 - name: vlan-interface
8931 description: String that identifies the interface
8934 example: __VLAN-INTERFACE__
8935 - name: l3-interface-ipv6-address
8937 description: IP address
8940 example: __L3-INTERFACE-IPV6-ADDRESS__
8943 description: l3-interface-ipv6-address-list object that needs to be created or updated.
8946 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
8949 - CloudInfrastructure
8950 summary: delete an existing l3-interface-ipv6-address-list
8951 description: delete an existing l3-interface-ipv6-address-list
8952 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8961 description: Response codes found in [response codes](https://wiki.onap.org/).
8965 description: Value from executing hostname on the compute node.
8968 example: __HOSTNAME__
8969 - name: interface-name
8971 description: Name that identifies the physical interface
8974 example: __INTERFACE-NAME__
8975 - name: interface-name
8977 description: Name given to the interface
8980 example: __INTERFACE-NAME__
8981 - name: vlan-interface
8983 description: String that identifies the interface
8986 example: __VLAN-INTERFACE__
8987 - name: l3-interface-ipv6-address
8989 description: IP address
8992 example: __L3-INTERFACE-IPV6-ADDRESS__
8993 - name: resource-version
8995 description: resource-version for concurrency
8998 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
9001 - CloudInfrastructure
9002 summary: returns vlan
9003 description: returns vlan
9004 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9010 description: successful operation
9012 $ref: "#/getDefinitions/vlan"
9014 description: Response codes found in [response codes](https://wiki.onap.org/).
9018 description: Value from executing hostname on the compute node.
9021 example: __HOSTNAME__
9022 - name: interface-name
9024 description: Name that identifies the physical interface
9027 example: __INTERFACE-NAME__
9028 - name: interface-name
9030 description: Name given to the interface
9033 example: __INTERFACE-NAME__
9034 - name: vlan-interface
9036 description: String that identifies the interface
9039 example: __VLAN-INTERFACE__
9042 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
9047 description: ID of Pserver
9054 - name: pserver-name2
9056 description: alternative pserver name
9061 description: Trigger for operational monitoring of this resource by Service Assurance systems.
9064 - name: interface-id
9066 description: ID of interface
9071 description: MAC address for the interface
9074 - name: network-name
9076 description: Name of the network
9079 - name: vlan-id-inner
9081 description: Inner VLAN tag
9087 description: This indicates the customers VPN ID associated with this vlan
9092 - CloudInfrastructure
9093 summary: create or update an existing vlan
9095 Create or update an existing vlan.
9097 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9098 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9107 description: Response codes found in [response codes](https://wiki.onap.org/).
9111 description: Value from executing hostname on the compute node.
9114 example: __HOSTNAME__
9115 - name: interface-name
9117 description: Name that identifies the physical interface
9120 example: __INTERFACE-NAME__
9121 - name: interface-name
9123 description: Name given to the interface
9126 example: __INTERFACE-NAME__
9127 - name: vlan-interface
9129 description: String that identifies the interface
9132 example: __VLAN-INTERFACE__
9135 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
9138 $ref: "#/definitions/vlan"
9141 - CloudInfrastructure
9142 summary: update an existing vlan
9144 Update an existing vlan
9146 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9147 The PUT operation will entirely replace an existing object.
9148 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9150 Other differences between PUT and PATCH are:
9152 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9153 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9154 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9155 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9164 description: Response codes found in [response codes](https://wiki.onap.org/).
9168 description: Value from executing hostname on the compute node.
9171 example: __HOSTNAME__
9172 - name: interface-name
9174 description: Name that identifies the physical interface
9177 example: __INTERFACE-NAME__
9178 - name: interface-name
9180 description: Name given to the interface
9183 example: __INTERFACE-NAME__
9184 - name: vlan-interface
9186 description: String that identifies the interface
9189 example: __VLAN-INTERFACE__
9192 description: vlan object that needs to be created or updated.
9195 $ref: "#/patchDefinitions/vlan"
9198 - CloudInfrastructure
9199 summary: delete an existing vlan
9200 description: delete an existing vlan
9201 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9210 description: Response codes found in [response codes](https://wiki.onap.org/).
9214 description: Value from executing hostname on the compute node.
9217 example: __HOSTNAME__
9218 - name: interface-name
9220 description: Name that identifies the physical interface
9223 example: __INTERFACE-NAME__
9224 - name: interface-name
9226 description: Name given to the interface
9229 example: __INTERFACE-NAME__
9230 - name: vlan-interface
9232 description: String that identifies the interface
9235 example: __VLAN-INTERFACE__
9236 - name: resource-version
9238 description: resource-version for concurrency
9241 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
9244 - CloudInfrastructure
9245 summary: returns vlans
9246 description: returns vlans
9247 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans
9253 description: successful operation
9255 $ref: "#/getDefinitions/vlans"
9257 description: Response codes found in [response codes](https://wiki.onap.org/).
9261 description: Value from executing hostname on the compute node.
9264 example: __HOSTNAME__
9265 - name: interface-name
9267 description: Name that identifies the physical interface
9270 example: __INTERFACE-NAME__
9271 - name: interface-name
9273 description: Name given to the interface
9276 example: __INTERFACE-NAME__
9279 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
9284 description: ID of Pserver
9291 - name: pserver-name2
9293 description: alternative pserver name
9298 description: Trigger for operational monitoring of this resource by Service Assurance systems.
9301 - name: interface-id
9303 description: ID of interface
9308 description: MAC address for the interface
9311 - name: network-name
9313 description: Name of the network
9316 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
9319 - CloudInfrastructure
9320 summary: see node definition for valid relationships
9321 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
9330 description: Response codes found in [response codes](https://wiki.onap.org/).
9334 description: Value from executing hostname on the compute node.
9337 example: __HOSTNAME__
9338 - name: interface-name
9340 description: Name that identifies the physical interface
9343 example: __INTERFACE-NAME__
9344 - name: interface-name
9346 description: Name given to the interface
9349 example: __INTERFACE-NAME__
9352 description: PCI ID used to identify the sriov-vf
9358 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
9361 $ref: "#/definitions/relationship"
9364 - CloudInfrastructure
9365 summary: delete an existing relationship
9366 description: delete an existing relationship
9367 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
9376 description: Response codes found in [response codes](https://wiki.onap.org/).
9380 description: Value from executing hostname on the compute node.
9383 example: __HOSTNAME__
9384 - name: interface-name
9386 description: Name that identifies the physical interface
9389 example: __INTERFACE-NAME__
9390 - name: interface-name
9392 description: Name given to the interface
9395 example: __INTERFACE-NAME__
9398 description: PCI ID used to identify the sriov-vf
9402 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
9405 - CloudInfrastructure
9406 summary: returns sriov-vf
9407 description: returns sriov-vf
9408 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9414 description: successful operation
9416 $ref: "#/getDefinitions/sriov-vf"
9418 description: Response codes found in [response codes](https://wiki.onap.org/).
9422 description: Value from executing hostname on the compute node.
9425 example: __HOSTNAME__
9426 - name: interface-name
9428 description: Name that identifies the physical interface
9431 example: __INTERFACE-NAME__
9432 - name: interface-name
9434 description: Name given to the interface
9437 example: __INTERFACE-NAME__
9440 description: PCI ID used to identify the sriov-vf
9446 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
9451 description: ID of Pserver
9458 - name: pserver-name2
9460 description: alternative pserver name
9465 description: Trigger for operational monitoring of this resource by Service Assurance systems.
9468 - name: interface-id
9470 description: ID of interface
9475 description: MAC address for the interface
9478 - name: network-name
9480 description: Name of the network
9483 - name: vf-vlan-filter
9485 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
9488 - name: vf-mac-filter
9490 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
9493 - name: vf-vlan-strip
9495 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
9498 - name: neutron-network-id
9500 description: Neutron network id of the interface
9505 - CloudInfrastructure
9506 summary: create or update an existing sriov-vf
9508 Create or update an existing sriov-vf.
9510 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9511 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9520 description: Response codes found in [response codes](https://wiki.onap.org/).
9524 description: Value from executing hostname on the compute node.
9527 example: __HOSTNAME__
9528 - name: interface-name
9530 description: Name that identifies the physical interface
9533 example: __INTERFACE-NAME__
9534 - name: interface-name
9536 description: Name given to the interface
9539 example: __INTERFACE-NAME__
9542 description: PCI ID used to identify the sriov-vf
9548 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
9551 $ref: "#/definitions/sriov-vf"
9554 - CloudInfrastructure
9555 summary: update an existing sriov-vf
9557 Update an existing sriov-vf
9559 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9560 The PUT operation will entirely replace an existing object.
9561 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
9563 Other differences between PUT and PATCH are:
9565 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
9566 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9567 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9568 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9577 description: Response codes found in [response codes](https://wiki.onap.org/).
9581 description: Value from executing hostname on the compute node.
9584 example: __HOSTNAME__
9585 - name: interface-name
9587 description: Name that identifies the physical interface
9590 example: __INTERFACE-NAME__
9591 - name: interface-name
9593 description: Name given to the interface
9596 example: __INTERFACE-NAME__
9599 description: PCI ID used to identify the sriov-vf
9605 description: sriov-vf object that needs to be created or updated.
9608 $ref: "#/patchDefinitions/sriov-vf"
9611 - CloudInfrastructure
9612 summary: delete an existing sriov-vf
9613 description: delete an existing sriov-vf
9614 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9623 description: Response codes found in [response codes](https://wiki.onap.org/).
9627 description: Value from executing hostname on the compute node.
9630 example: __HOSTNAME__
9631 - name: interface-name
9633 description: Name that identifies the physical interface
9636 example: __INTERFACE-NAME__
9637 - name: interface-name
9639 description: Name given to the interface
9642 example: __INTERFACE-NAME__
9645 description: PCI ID used to identify the sriov-vf
9649 - name: resource-version
9651 description: resource-version for concurrency
9654 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
9657 - CloudInfrastructure
9658 summary: returns sriov-vfs
9659 description: returns sriov-vfs
9660 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
9666 description: successful operation
9668 $ref: "#/getDefinitions/sriov-vfs"
9670 description: Response codes found in [response codes](https://wiki.onap.org/).
9674 description: Value from executing hostname on the compute node.
9677 example: __HOSTNAME__
9678 - name: interface-name
9680 description: Name that identifies the physical interface
9683 example: __INTERFACE-NAME__
9684 - name: interface-name
9686 description: Name given to the interface
9689 example: __INTERFACE-NAME__
9692 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
9697 description: ID of Pserver
9704 - name: pserver-name2
9706 description: alternative pserver name
9711 description: Trigger for operational monitoring of this resource by Service Assurance systems.
9714 - name: interface-id
9716 description: ID of interface
9721 description: MAC address for the interface
9724 - name: network-name
9726 description: Name of the network
9729 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
9732 - CloudInfrastructure
9733 summary: see node definition for valid relationships
9734 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
9743 description: Response codes found in [response codes](https://wiki.onap.org/).
9747 description: Value from executing hostname on the compute node.
9750 example: __HOSTNAME__
9751 - name: interface-name
9753 description: Name that identifies the physical interface
9756 example: __INTERFACE-NAME__
9757 - name: interface-name
9759 description: Name given to the interface
9762 example: __INTERFACE-NAME__
9765 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
9768 $ref: "#/definitions/relationship"
9771 - CloudInfrastructure
9772 summary: delete an existing relationship
9773 description: delete an existing relationship
9774 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
9783 description: Response codes found in [response codes](https://wiki.onap.org/).
9787 description: Value from executing hostname on the compute node.
9790 example: __HOSTNAME__
9791 - name: interface-name
9793 description: Name that identifies the physical interface
9796 example: __INTERFACE-NAME__
9797 - name: interface-name
9799 description: Name given to the interface
9802 example: __INTERFACE-NAME__
9803 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
9806 - CloudInfrastructure
9807 summary: see node definition for valid relationships
9808 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
9817 description: Response codes found in [response codes](https://wiki.onap.org/).
9821 description: Value from executing hostname on the compute node.
9824 example: __HOSTNAME__
9825 - name: interface-name
9827 description: Name that identifies the physical interface
9830 example: __INTERFACE-NAME__
9831 - name: interface-name
9833 description: Name given to the interface
9836 example: __INTERFACE-NAME__
9837 - name: l3-interface-ipv4-address
9839 description: IP address
9842 example: __L3-INTERFACE-IPV4-ADDRESS__
9845 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
9848 $ref: "#/definitions/relationship"
9851 - CloudInfrastructure
9852 summary: delete an existing relationship
9853 description: delete an existing relationship
9854 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
9863 description: Response codes found in [response codes](https://wiki.onap.org/).
9867 description: Value from executing hostname on the compute node.
9870 example: __HOSTNAME__
9871 - name: interface-name
9873 description: Name that identifies the physical interface
9876 example: __INTERFACE-NAME__
9877 - name: interface-name
9879 description: Name given to the interface
9882 example: __INTERFACE-NAME__
9883 - name: l3-interface-ipv4-address
9885 description: IP address
9888 example: __L3-INTERFACE-IPV4-ADDRESS__
9889 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
9892 - CloudInfrastructure
9893 summary: returns l3-interface-ipv4-address-list
9894 description: returns l3-interface-ipv4-address-list
9895 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
9901 description: successful operation
9903 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
9905 description: Response codes found in [response codes](https://wiki.onap.org/).
9909 description: Value from executing hostname on the compute node.
9912 example: __HOSTNAME__
9913 - name: interface-name
9915 description: Name that identifies the physical interface
9918 example: __INTERFACE-NAME__
9919 - name: interface-name
9921 description: Name given to the interface
9924 example: __INTERFACE-NAME__
9925 - name: l3-interface-ipv4-address
9927 description: IP address
9930 example: __L3-INTERFACE-IPV4-ADDRESS__
9933 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
9938 description: ID of Pserver
9945 - name: pserver-name2
9947 description: alternative pserver name
9952 description: Trigger for operational monitoring of this resource by Service Assurance systems.
9955 - name: interface-id
9957 description: ID of interface
9962 description: MAC address for the interface
9965 - name: network-name
9967 description: Name of the network
9970 - name: vlan-id-inner
9972 description: Inner VLAN tag
9976 - name: neutron-network-id
9978 description: Neutron network id of the interface that address belongs to
9981 - name: neutron-subnet-id
9983 description: Neutron id of subnet that address belongs to
9988 - CloudInfrastructure
9989 summary: create or update an existing l3-interface-ipv4-address-list
9991 Create or update an existing l3-interface-ipv4-address-list.
9993 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
9994 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
10003 description: Response codes found in [response codes](https://wiki.onap.org/).
10007 description: Value from executing hostname on the compute node.
10010 example: __HOSTNAME__
10011 - name: interface-name
10013 description: Name that identifies the physical interface
10016 example: __INTERFACE-NAME__
10017 - name: interface-name
10019 description: Name given to the interface
10022 example: __INTERFACE-NAME__
10023 - name: l3-interface-ipv4-address
10025 description: IP address
10028 example: __L3-INTERFACE-IPV4-ADDRESS__
10031 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
10034 $ref: "#/definitions/l3-interface-ipv4-address-list"
10037 - CloudInfrastructure
10038 summary: update an existing l3-interface-ipv4-address-list
10040 Update an existing l3-interface-ipv4-address-list
10042 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10043 The PUT operation will entirely replace an existing object.
10044 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10046 Other differences between PUT and PATCH are:
10048 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10049 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10050 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10051 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
10060 description: Response codes found in [response codes](https://wiki.onap.org/).
10064 description: Value from executing hostname on the compute node.
10067 example: __HOSTNAME__
10068 - name: interface-name
10070 description: Name that identifies the physical interface
10073 example: __INTERFACE-NAME__
10074 - name: interface-name
10076 description: Name given to the interface
10079 example: __INTERFACE-NAME__
10080 - name: l3-interface-ipv4-address
10082 description: IP address
10085 example: __L3-INTERFACE-IPV4-ADDRESS__
10088 description: l3-interface-ipv4-address-list object that needs to be created or updated.
10091 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
10094 - CloudInfrastructure
10095 summary: delete an existing l3-interface-ipv4-address-list
10096 description: delete an existing l3-interface-ipv4-address-list
10097 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
10106 description: Response codes found in [response codes](https://wiki.onap.org/).
10110 description: Value from executing hostname on the compute node.
10113 example: __HOSTNAME__
10114 - name: interface-name
10116 description: Name that identifies the physical interface
10119 example: __INTERFACE-NAME__
10120 - name: interface-name
10122 description: Name given to the interface
10125 example: __INTERFACE-NAME__
10126 - name: l3-interface-ipv4-address
10128 description: IP address
10131 example: __L3-INTERFACE-IPV4-ADDRESS__
10132 - name: resource-version
10134 description: resource-version for concurrency
10137 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
10140 - CloudInfrastructure
10141 summary: see node definition for valid relationships
10142 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
10151 description: Response codes found in [response codes](https://wiki.onap.org/).
10155 description: Value from executing hostname on the compute node.
10158 example: __HOSTNAME__
10159 - name: interface-name
10161 description: Name that identifies the physical interface
10164 example: __INTERFACE-NAME__
10165 - name: interface-name
10167 description: Name given to the interface
10170 example: __INTERFACE-NAME__
10171 - name: l3-interface-ipv6-address
10173 description: IP address
10176 example: __L3-INTERFACE-IPV6-ADDRESS__
10179 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
10182 $ref: "#/definitions/relationship"
10185 - CloudInfrastructure
10186 summary: delete an existing relationship
10187 description: delete an existing relationship
10188 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
10197 description: Response codes found in [response codes](https://wiki.onap.org/).
10201 description: Value from executing hostname on the compute node.
10204 example: __HOSTNAME__
10205 - name: interface-name
10207 description: Name that identifies the physical interface
10210 example: __INTERFACE-NAME__
10211 - name: interface-name
10213 description: Name given to the interface
10216 example: __INTERFACE-NAME__
10217 - name: l3-interface-ipv6-address
10219 description: IP address
10222 example: __L3-INTERFACE-IPV6-ADDRESS__
10223 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
10226 - CloudInfrastructure
10227 summary: returns l3-interface-ipv6-address-list
10228 description: returns l3-interface-ipv6-address-list
10229 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10235 description: successful operation
10237 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
10239 description: Response codes found in [response codes](https://wiki.onap.org/).
10243 description: Value from executing hostname on the compute node.
10246 example: __HOSTNAME__
10247 - name: interface-name
10249 description: Name that identifies the physical interface
10252 example: __INTERFACE-NAME__
10253 - name: interface-name
10255 description: Name given to the interface
10258 example: __INTERFACE-NAME__
10259 - name: l3-interface-ipv6-address
10261 description: IP address
10264 example: __L3-INTERFACE-IPV6-ADDRESS__
10267 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
10272 description: ID of Pserver
10279 - name: pserver-name2
10281 description: alternative pserver name
10284 - name: prov-status
10286 description: Trigger for operational monitoring of this resource by Service Assurance systems.
10289 - name: interface-id
10291 description: ID of interface
10296 description: MAC address for the interface
10299 - name: network-name
10301 description: Name of the network
10304 - name: vlan-id-inner
10306 description: Inner VLAN tag
10310 - name: neutron-network-id
10312 description: Neutron network id of the interface that address belongs to
10315 - name: neutron-subnet-id
10317 description: Neutron id of subnet that address belongs to
10322 - CloudInfrastructure
10323 summary: create or update an existing l3-interface-ipv6-address-list
10325 Create or update an existing l3-interface-ipv6-address-list.
10327 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10328 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10337 description: Response codes found in [response codes](https://wiki.onap.org/).
10341 description: Value from executing hostname on the compute node.
10344 example: __HOSTNAME__
10345 - name: interface-name
10347 description: Name that identifies the physical interface
10350 example: __INTERFACE-NAME__
10351 - name: interface-name
10353 description: Name given to the interface
10356 example: __INTERFACE-NAME__
10357 - name: l3-interface-ipv6-address
10359 description: IP address
10362 example: __L3-INTERFACE-IPV6-ADDRESS__
10365 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
10368 $ref: "#/definitions/l3-interface-ipv6-address-list"
10371 - CloudInfrastructure
10372 summary: update an existing l3-interface-ipv6-address-list
10374 Update an existing l3-interface-ipv6-address-list
10376 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10377 The PUT operation will entirely replace an existing object.
10378 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10380 Other differences between PUT and PATCH are:
10382 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10383 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10384 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10385 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10394 description: Response codes found in [response codes](https://wiki.onap.org/).
10398 description: Value from executing hostname on the compute node.
10401 example: __HOSTNAME__
10402 - name: interface-name
10404 description: Name that identifies the physical interface
10407 example: __INTERFACE-NAME__
10408 - name: interface-name
10410 description: Name given to the interface
10413 example: __INTERFACE-NAME__
10414 - name: l3-interface-ipv6-address
10416 description: IP address
10419 example: __L3-INTERFACE-IPV6-ADDRESS__
10422 description: l3-interface-ipv6-address-list object that needs to be created or updated.
10425 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
10428 - CloudInfrastructure
10429 summary: delete an existing l3-interface-ipv6-address-list
10430 description: delete an existing l3-interface-ipv6-address-list
10431 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10440 description: Response codes found in [response codes](https://wiki.onap.org/).
10444 description: Value from executing hostname on the compute node.
10447 example: __HOSTNAME__
10448 - name: interface-name
10450 description: Name that identifies the physical interface
10453 example: __INTERFACE-NAME__
10454 - name: interface-name
10456 description: Name given to the interface
10459 example: __INTERFACE-NAME__
10460 - name: l3-interface-ipv6-address
10462 description: IP address
10465 example: __L3-INTERFACE-IPV6-ADDRESS__
10466 - name: resource-version
10468 description: resource-version for concurrency
10471 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
10474 - CloudInfrastructure
10475 summary: returns l-interface
10476 description: returns l-interface
10477 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10483 description: successful operation
10485 $ref: "#/getDefinitions/l-interface"
10487 description: Response codes found in [response codes](https://wiki.onap.org/).
10491 description: Value from executing hostname on the compute node.
10494 example: __HOSTNAME__
10495 - name: interface-name
10497 description: Name that identifies the physical interface
10500 example: __INTERFACE-NAME__
10501 - name: interface-name
10503 description: Name given to the interface
10506 example: __INTERFACE-NAME__
10509 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
10514 description: ID of Pserver
10521 - name: pserver-name2
10523 description: alternative pserver name
10526 - name: prov-status
10528 description: Trigger for operational monitoring of this resource by Service Assurance systems.
10531 - name: interface-id
10533 description: ID of interface
10538 description: MAC address for the interface
10541 - name: network-name
10543 description: Name of the network
10548 - CloudInfrastructure
10549 summary: create or update an existing l-interface
10551 Create or update an existing l-interface.
10553 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10554 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10563 description: Response codes found in [response codes](https://wiki.onap.org/).
10567 description: Value from executing hostname on the compute node.
10570 example: __HOSTNAME__
10571 - name: interface-name
10573 description: Name that identifies the physical interface
10576 example: __INTERFACE-NAME__
10577 - name: interface-name
10579 description: Name given to the interface
10582 example: __INTERFACE-NAME__
10585 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
10588 $ref: "#/definitions/l-interface"
10591 - CloudInfrastructure
10592 summary: update an existing l-interface
10594 Update an existing l-interface
10596 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10597 The PUT operation will entirely replace an existing object.
10598 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10600 Other differences between PUT and PATCH are:
10602 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10603 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10604 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10605 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10614 description: Response codes found in [response codes](https://wiki.onap.org/).
10618 description: Value from executing hostname on the compute node.
10621 example: __HOSTNAME__
10622 - name: interface-name
10624 description: Name that identifies the physical interface
10627 example: __INTERFACE-NAME__
10628 - name: interface-name
10630 description: Name given to the interface
10633 example: __INTERFACE-NAME__
10636 description: l-interface object that needs to be created or updated.
10639 $ref: "#/patchDefinitions/l-interface"
10642 - CloudInfrastructure
10643 summary: delete an existing l-interface
10644 description: delete an existing l-interface
10645 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10654 description: Response codes found in [response codes](https://wiki.onap.org/).
10658 description: Value from executing hostname on the compute node.
10661 example: __HOSTNAME__
10662 - name: interface-name
10664 description: Name that identifies the physical interface
10667 example: __INTERFACE-NAME__
10668 - name: interface-name
10670 description: Name given to the interface
10673 example: __INTERFACE-NAME__
10674 - name: resource-version
10676 description: resource-version for concurrency
10679 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces:
10682 - CloudInfrastructure
10683 summary: returns l-interfaces
10684 description: returns l-interfaces
10685 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces
10691 description: successful operation
10693 $ref: "#/getDefinitions/l-interfaces"
10695 description: Response codes found in [response codes](https://wiki.onap.org/).
10699 description: Value from executing hostname on the compute node.
10702 example: __HOSTNAME__
10703 - name: interface-name
10705 description: Name that identifies the physical interface
10708 example: __INTERFACE-NAME__
10711 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
10716 description: ID of Pserver
10723 - name: pserver-name2
10725 description: alternative pserver name
10728 - name: prov-status
10730 description: Trigger for operational monitoring of this resource by Service Assurance systems.
10733 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}:
10736 - CloudInfrastructure
10737 summary: returns p-interface
10738 description: returns p-interface
10739 operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface
10745 description: successful operation
10747 $ref: "#/getDefinitions/p-interface"
10749 description: Response codes found in [response codes](https://wiki.onap.org/).
10753 description: Value from executing hostname on the compute node.
10756 example: __HOSTNAME__
10757 - name: interface-name
10759 description: Name that identifies the physical interface
10762 example: __INTERFACE-NAME__
10765 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
10770 description: ID of Pserver
10777 - name: pserver-name2
10779 description: alternative pserver name
10782 - name: prov-status
10784 description: Trigger for operational monitoring of this resource by Service Assurance systems.
10789 - CloudInfrastructure
10790 summary: create or update an existing p-interface
10792 Create or update an existing p-interface.
10794 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
10795 operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface
10804 description: Response codes found in [response codes](https://wiki.onap.org/).
10808 description: Value from executing hostname on the compute node.
10811 example: __HOSTNAME__
10812 - name: interface-name
10814 description: Name that identifies the physical interface
10817 example: __INTERFACE-NAME__
10820 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
10823 $ref: "#/definitions/p-interface"
10826 - CloudInfrastructure
10827 summary: update an existing p-interface
10829 Update an existing p-interface
10831 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10832 The PUT operation will entirely replace an existing object.
10833 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
10835 Other differences between PUT and PATCH are:
10837 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
10838 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10839 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10840 operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterface
10849 description: Response codes found in [response codes](https://wiki.onap.org/).
10853 description: Value from executing hostname on the compute node.
10856 example: __HOSTNAME__
10857 - name: interface-name
10859 description: Name that identifies the physical interface
10862 example: __INTERFACE-NAME__
10865 description: p-interface object that needs to be created or updated.
10868 $ref: "#/patchDefinitions/p-interface"
10871 - CloudInfrastructure
10872 summary: delete an existing p-interface
10873 description: delete an existing p-interface
10874 operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface
10883 description: Response codes found in [response codes](https://wiki.onap.org/).
10887 description: Value from executing hostname on the compute node.
10890 example: __HOSTNAME__
10891 - name: interface-name
10893 description: Name that identifies the physical interface
10896 example: __INTERFACE-NAME__
10897 - name: resource-version
10899 description: resource-version for concurrency
10902 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces:
10905 - CloudInfrastructure
10906 summary: returns p-interfaces
10907 description: returns p-interfaces
10908 operationId: getCloudInfrastructurePserversPserverPInterfaces
10914 description: successful operation
10916 $ref: "#/getDefinitions/p-interfaces"
10918 description: Response codes found in [response codes](https://wiki.onap.org/).
10922 description: Value from executing hostname on the compute node.
10925 example: __HOSTNAME__
10928 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
10933 description: ID of Pserver
10940 - name: pserver-name2
10942 description: alternative pserver name
10945 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
10948 - CloudInfrastructure
10949 summary: see node definition for valid relationships
10950 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
10959 description: Response codes found in [response codes](https://wiki.onap.org/).
10963 description: Value from executing hostname on the compute node.
10966 example: __HOSTNAME__
10967 - name: interface-name
10969 description: Name that identifies the link aggregate interface
10972 example: __INTERFACE-NAME__
10975 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
10978 $ref: "#/definitions/relationship"
10981 - CloudInfrastructure
10982 summary: delete an existing relationship
10983 description: delete an existing relationship
10984 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
10993 description: Response codes found in [response codes](https://wiki.onap.org/).
10997 description: Value from executing hostname on the compute node.
11000 example: __HOSTNAME__
11001 - name: interface-name
11003 description: Name that identifies the link aggregate interface
11006 example: __INTERFACE-NAME__
11007 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
11010 - CloudInfrastructure
11011 summary: see node definition for valid relationships
11012 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
11021 description: Response codes found in [response codes](https://wiki.onap.org/).
11025 description: Value from executing hostname on the compute node.
11028 example: __HOSTNAME__
11029 - name: interface-name
11031 description: Name that identifies the link aggregate interface
11034 example: __INTERFACE-NAME__
11035 - name: interface-name
11037 description: Name given to the interface
11040 example: __INTERFACE-NAME__
11041 - name: vlan-interface
11043 description: String that identifies the interface
11046 example: __VLAN-INTERFACE__
11049 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
11052 $ref: "#/definitions/relationship"
11055 - CloudInfrastructure
11056 summary: delete an existing relationship
11057 description: delete an existing relationship
11058 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
11067 description: Response codes found in [response codes](https://wiki.onap.org/).
11071 description: Value from executing hostname on the compute node.
11074 example: __HOSTNAME__
11075 - name: interface-name
11077 description: Name that identifies the link aggregate interface
11080 example: __INTERFACE-NAME__
11081 - name: interface-name
11083 description: Name given to the interface
11086 example: __INTERFACE-NAME__
11087 - name: vlan-interface
11089 description: String that identifies the interface
11092 example: __VLAN-INTERFACE__
11093 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
11096 - CloudInfrastructure
11097 summary: see node definition for valid relationships
11098 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
11107 description: Response codes found in [response codes](https://wiki.onap.org/).
11111 description: Value from executing hostname on the compute node.
11114 example: __HOSTNAME__
11115 - name: interface-name
11117 description: Name that identifies the link aggregate interface
11120 example: __INTERFACE-NAME__
11121 - name: interface-name
11123 description: Name given to the interface
11126 example: __INTERFACE-NAME__
11127 - name: vlan-interface
11129 description: String that identifies the interface
11132 example: __VLAN-INTERFACE__
11133 - name: l3-interface-ipv4-address
11135 description: IP address
11138 example: __L3-INTERFACE-IPV4-ADDRESS__
11141 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
11144 $ref: "#/definitions/relationship"
11147 - CloudInfrastructure
11148 summary: delete an existing relationship
11149 description: delete an existing relationship
11150 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
11159 description: Response codes found in [response codes](https://wiki.onap.org/).
11163 description: Value from executing hostname on the compute node.
11166 example: __HOSTNAME__
11167 - name: interface-name
11169 description: Name that identifies the link aggregate interface
11172 example: __INTERFACE-NAME__
11173 - name: interface-name
11175 description: Name given to the interface
11178 example: __INTERFACE-NAME__
11179 - name: vlan-interface
11181 description: String that identifies the interface
11184 example: __VLAN-INTERFACE__
11185 - name: l3-interface-ipv4-address
11187 description: IP address
11190 example: __L3-INTERFACE-IPV4-ADDRESS__
11191 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
11194 - CloudInfrastructure
11195 summary: returns l3-interface-ipv4-address-list
11196 description: returns l3-interface-ipv4-address-list
11197 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11203 description: successful operation
11205 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
11207 description: Response codes found in [response codes](https://wiki.onap.org/).
11211 description: Value from executing hostname on the compute node.
11214 example: __HOSTNAME__
11215 - name: interface-name
11217 description: Name that identifies the link aggregate interface
11220 example: __INTERFACE-NAME__
11221 - name: interface-name
11223 description: Name given to the interface
11226 example: __INTERFACE-NAME__
11227 - name: vlan-interface
11229 description: String that identifies the interface
11232 example: __VLAN-INTERFACE__
11233 - name: l3-interface-ipv4-address
11235 description: IP address
11238 example: __L3-INTERFACE-IPV4-ADDRESS__
11241 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
11246 description: ID of Pserver
11253 - name: pserver-name2
11255 description: alternative pserver name
11258 - name: interface-id
11260 description: ID of interface
11263 - name: interface-role
11265 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
11268 - name: interface-id
11270 description: ID of interface
11275 description: MAC address for the interface
11278 - name: network-name
11280 description: Name of the network
11283 - name: vlan-id-inner
11285 description: Inner VLAN tag
11291 description: This indicates the customers VPN ID associated with this vlan
11294 - name: vlan-id-inner
11296 description: Inner VLAN tag
11300 - name: neutron-network-id
11302 description: Neutron network id of the interface that address belongs to
11305 - name: neutron-subnet-id
11307 description: Neutron id of subnet that address belongs to
11312 - CloudInfrastructure
11313 summary: create or update an existing l3-interface-ipv4-address-list
11315 Create or update an existing l3-interface-ipv4-address-list.
11317 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11318 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11327 description: Response codes found in [response codes](https://wiki.onap.org/).
11331 description: Value from executing hostname on the compute node.
11334 example: __HOSTNAME__
11335 - name: interface-name
11337 description: Name that identifies the link aggregate interface
11340 example: __INTERFACE-NAME__
11341 - name: interface-name
11343 description: Name given to the interface
11346 example: __INTERFACE-NAME__
11347 - name: vlan-interface
11349 description: String that identifies the interface
11352 example: __VLAN-INTERFACE__
11353 - name: l3-interface-ipv4-address
11355 description: IP address
11358 example: __L3-INTERFACE-IPV4-ADDRESS__
11361 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
11364 $ref: "#/definitions/l3-interface-ipv4-address-list"
11367 - CloudInfrastructure
11368 summary: update an existing l3-interface-ipv4-address-list
11370 Update an existing l3-interface-ipv4-address-list
11372 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11373 The PUT operation will entirely replace an existing object.
11374 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11376 Other differences between PUT and PATCH are:
11378 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11379 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11380 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11381 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11390 description: Response codes found in [response codes](https://wiki.onap.org/).
11394 description: Value from executing hostname on the compute node.
11397 example: __HOSTNAME__
11398 - name: interface-name
11400 description: Name that identifies the link aggregate interface
11403 example: __INTERFACE-NAME__
11404 - name: interface-name
11406 description: Name given to the interface
11409 example: __INTERFACE-NAME__
11410 - name: vlan-interface
11412 description: String that identifies the interface
11415 example: __VLAN-INTERFACE__
11416 - name: l3-interface-ipv4-address
11418 description: IP address
11421 example: __L3-INTERFACE-IPV4-ADDRESS__
11424 description: l3-interface-ipv4-address-list object that needs to be created or updated.
11427 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
11430 - CloudInfrastructure
11431 summary: delete an existing l3-interface-ipv4-address-list
11432 description: delete an existing l3-interface-ipv4-address-list
11433 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11442 description: Response codes found in [response codes](https://wiki.onap.org/).
11446 description: Value from executing hostname on the compute node.
11449 example: __HOSTNAME__
11450 - name: interface-name
11452 description: Name that identifies the link aggregate interface
11455 example: __INTERFACE-NAME__
11456 - name: interface-name
11458 description: Name given to the interface
11461 example: __INTERFACE-NAME__
11462 - name: vlan-interface
11464 description: String that identifies the interface
11467 example: __VLAN-INTERFACE__
11468 - name: l3-interface-ipv4-address
11470 description: IP address
11473 example: __L3-INTERFACE-IPV4-ADDRESS__
11474 - name: resource-version
11476 description: resource-version for concurrency
11479 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
11482 - CloudInfrastructure
11483 summary: see node definition for valid relationships
11484 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
11493 description: Response codes found in [response codes](https://wiki.onap.org/).
11497 description: Value from executing hostname on the compute node.
11500 example: __HOSTNAME__
11501 - name: interface-name
11503 description: Name that identifies the link aggregate interface
11506 example: __INTERFACE-NAME__
11507 - name: interface-name
11509 description: Name given to the interface
11512 example: __INTERFACE-NAME__
11513 - name: vlan-interface
11515 description: String that identifies the interface
11518 example: __VLAN-INTERFACE__
11519 - name: l3-interface-ipv6-address
11521 description: IP address
11524 example: __L3-INTERFACE-IPV6-ADDRESS__
11527 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
11530 $ref: "#/definitions/relationship"
11533 - CloudInfrastructure
11534 summary: delete an existing relationship
11535 description: delete an existing relationship
11536 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
11545 description: Response codes found in [response codes](https://wiki.onap.org/).
11549 description: Value from executing hostname on the compute node.
11552 example: __HOSTNAME__
11553 - name: interface-name
11555 description: Name that identifies the link aggregate interface
11558 example: __INTERFACE-NAME__
11559 - name: interface-name
11561 description: Name given to the interface
11564 example: __INTERFACE-NAME__
11565 - name: vlan-interface
11567 description: String that identifies the interface
11570 example: __VLAN-INTERFACE__
11571 - name: l3-interface-ipv6-address
11573 description: IP address
11576 example: __L3-INTERFACE-IPV6-ADDRESS__
11577 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
11580 - CloudInfrastructure
11581 summary: returns l3-interface-ipv6-address-list
11582 description: returns l3-interface-ipv6-address-list
11583 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11589 description: successful operation
11591 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
11593 description: Response codes found in [response codes](https://wiki.onap.org/).
11597 description: Value from executing hostname on the compute node.
11600 example: __HOSTNAME__
11601 - name: interface-name
11603 description: Name that identifies the link aggregate interface
11606 example: __INTERFACE-NAME__
11607 - name: interface-name
11609 description: Name given to the interface
11612 example: __INTERFACE-NAME__
11613 - name: vlan-interface
11615 description: String that identifies the interface
11618 example: __VLAN-INTERFACE__
11619 - name: l3-interface-ipv6-address
11621 description: IP address
11624 example: __L3-INTERFACE-IPV6-ADDRESS__
11627 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
11632 description: ID of Pserver
11639 - name: pserver-name2
11641 description: alternative pserver name
11644 - name: interface-id
11646 description: ID of interface
11649 - name: interface-role
11651 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
11654 - name: interface-id
11656 description: ID of interface
11661 description: MAC address for the interface
11664 - name: network-name
11666 description: Name of the network
11669 - name: vlan-id-inner
11671 description: Inner VLAN tag
11677 description: This indicates the customers VPN ID associated with this vlan
11680 - name: vlan-id-inner
11682 description: Inner VLAN tag
11686 - name: neutron-network-id
11688 description: Neutron network id of the interface that address belongs to
11691 - name: neutron-subnet-id
11693 description: Neutron id of subnet that address belongs to
11698 - CloudInfrastructure
11699 summary: create or update an existing l3-interface-ipv6-address-list
11701 Create or update an existing l3-interface-ipv6-address-list.
11703 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11704 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11713 description: Response codes found in [response codes](https://wiki.onap.org/).
11717 description: Value from executing hostname on the compute node.
11720 example: __HOSTNAME__
11721 - name: interface-name
11723 description: Name that identifies the link aggregate interface
11726 example: __INTERFACE-NAME__
11727 - name: interface-name
11729 description: Name given to the interface
11732 example: __INTERFACE-NAME__
11733 - name: vlan-interface
11735 description: String that identifies the interface
11738 example: __VLAN-INTERFACE__
11739 - name: l3-interface-ipv6-address
11741 description: IP address
11744 example: __L3-INTERFACE-IPV6-ADDRESS__
11747 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
11750 $ref: "#/definitions/l3-interface-ipv6-address-list"
11753 - CloudInfrastructure
11754 summary: update an existing l3-interface-ipv6-address-list
11756 Update an existing l3-interface-ipv6-address-list
11758 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11759 The PUT operation will entirely replace an existing object.
11760 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
11762 Other differences between PUT and PATCH are:
11764 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
11765 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11766 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11767 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11776 description: Response codes found in [response codes](https://wiki.onap.org/).
11780 description: Value from executing hostname on the compute node.
11783 example: __HOSTNAME__
11784 - name: interface-name
11786 description: Name that identifies the link aggregate interface
11789 example: __INTERFACE-NAME__
11790 - name: interface-name
11792 description: Name given to the interface
11795 example: __INTERFACE-NAME__
11796 - name: vlan-interface
11798 description: String that identifies the interface
11801 example: __VLAN-INTERFACE__
11802 - name: l3-interface-ipv6-address
11804 description: IP address
11807 example: __L3-INTERFACE-IPV6-ADDRESS__
11810 description: l3-interface-ipv6-address-list object that needs to be created or updated.
11813 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
11816 - CloudInfrastructure
11817 summary: delete an existing l3-interface-ipv6-address-list
11818 description: delete an existing l3-interface-ipv6-address-list
11819 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11828 description: Response codes found in [response codes](https://wiki.onap.org/).
11832 description: Value from executing hostname on the compute node.
11835 example: __HOSTNAME__
11836 - name: interface-name
11838 description: Name that identifies the link aggregate interface
11841 example: __INTERFACE-NAME__
11842 - name: interface-name
11844 description: Name given to the interface
11847 example: __INTERFACE-NAME__
11848 - name: vlan-interface
11850 description: String that identifies the interface
11853 example: __VLAN-INTERFACE__
11854 - name: l3-interface-ipv6-address
11856 description: IP address
11859 example: __L3-INTERFACE-IPV6-ADDRESS__
11860 - name: resource-version
11862 description: resource-version for concurrency
11865 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
11868 - CloudInfrastructure
11869 summary: returns vlan
11870 description: returns vlan
11871 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
11877 description: successful operation
11879 $ref: "#/getDefinitions/vlan"
11881 description: Response codes found in [response codes](https://wiki.onap.org/).
11885 description: Value from executing hostname on the compute node.
11888 example: __HOSTNAME__
11889 - name: interface-name
11891 description: Name that identifies the link aggregate interface
11894 example: __INTERFACE-NAME__
11895 - name: interface-name
11897 description: Name given to the interface
11900 example: __INTERFACE-NAME__
11901 - name: vlan-interface
11903 description: String that identifies the interface
11906 example: __VLAN-INTERFACE__
11909 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
11914 description: ID of Pserver
11921 - name: pserver-name2
11923 description: alternative pserver name
11926 - name: interface-id
11928 description: ID of interface
11931 - name: interface-role
11933 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
11936 - name: interface-id
11938 description: ID of interface
11943 description: MAC address for the interface
11946 - name: network-name
11948 description: Name of the network
11951 - name: vlan-id-inner
11953 description: Inner VLAN tag
11959 description: This indicates the customers VPN ID associated with this vlan
11964 - CloudInfrastructure
11965 summary: create or update an existing vlan
11967 Create or update an existing vlan.
11969 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
11970 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
11979 description: Response codes found in [response codes](https://wiki.onap.org/).
11983 description: Value from executing hostname on the compute node.
11986 example: __HOSTNAME__
11987 - name: interface-name
11989 description: Name that identifies the link aggregate interface
11992 example: __INTERFACE-NAME__
11993 - name: interface-name
11995 description: Name given to the interface
11998 example: __INTERFACE-NAME__
11999 - name: vlan-interface
12001 description: String that identifies the interface
12004 example: __VLAN-INTERFACE__
12007 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
12010 $ref: "#/definitions/vlan"
12013 - CloudInfrastructure
12014 summary: update an existing vlan
12016 Update an existing vlan
12018 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12019 The PUT operation will entirely replace an existing object.
12020 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12022 Other differences between PUT and PATCH are:
12024 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12025 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12026 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12027 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
12036 description: Response codes found in [response codes](https://wiki.onap.org/).
12040 description: Value from executing hostname on the compute node.
12043 example: __HOSTNAME__
12044 - name: interface-name
12046 description: Name that identifies the link aggregate interface
12049 example: __INTERFACE-NAME__
12050 - name: interface-name
12052 description: Name given to the interface
12055 example: __INTERFACE-NAME__
12056 - name: vlan-interface
12058 description: String that identifies the interface
12061 example: __VLAN-INTERFACE__
12064 description: vlan object that needs to be created or updated.
12067 $ref: "#/patchDefinitions/vlan"
12070 - CloudInfrastructure
12071 summary: delete an existing vlan
12072 description: delete an existing vlan
12073 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
12082 description: Response codes found in [response codes](https://wiki.onap.org/).
12086 description: Value from executing hostname on the compute node.
12089 example: __HOSTNAME__
12090 - name: interface-name
12092 description: Name that identifies the link aggregate interface
12095 example: __INTERFACE-NAME__
12096 - name: interface-name
12098 description: Name given to the interface
12101 example: __INTERFACE-NAME__
12102 - name: vlan-interface
12104 description: String that identifies the interface
12107 example: __VLAN-INTERFACE__
12108 - name: resource-version
12110 description: resource-version for concurrency
12113 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
12116 - CloudInfrastructure
12117 summary: returns vlans
12118 description: returns vlans
12119 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
12125 description: successful operation
12127 $ref: "#/getDefinitions/vlans"
12129 description: Response codes found in [response codes](https://wiki.onap.org/).
12133 description: Value from executing hostname on the compute node.
12136 example: __HOSTNAME__
12137 - name: interface-name
12139 description: Name that identifies the link aggregate interface
12142 example: __INTERFACE-NAME__
12143 - name: interface-name
12145 description: Name given to the interface
12148 example: __INTERFACE-NAME__
12151 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
12156 description: ID of Pserver
12163 - name: pserver-name2
12165 description: alternative pserver name
12168 - name: interface-id
12170 description: ID of interface
12173 - name: interface-role
12175 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
12178 - name: interface-id
12180 description: ID of interface
12185 description: MAC address for the interface
12188 - name: network-name
12190 description: Name of the network
12193 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
12196 - CloudInfrastructure
12197 summary: see node definition for valid relationships
12198 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
12207 description: Response codes found in [response codes](https://wiki.onap.org/).
12211 description: Value from executing hostname on the compute node.
12214 example: __HOSTNAME__
12215 - name: interface-name
12217 description: Name that identifies the link aggregate interface
12220 example: __INTERFACE-NAME__
12221 - name: interface-name
12223 description: Name given to the interface
12226 example: __INTERFACE-NAME__
12229 description: PCI ID used to identify the sriov-vf
12232 example: __PCI-ID__
12235 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
12238 $ref: "#/definitions/relationship"
12241 - CloudInfrastructure
12242 summary: delete an existing relationship
12243 description: delete an existing relationship
12244 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
12253 description: Response codes found in [response codes](https://wiki.onap.org/).
12257 description: Value from executing hostname on the compute node.
12260 example: __HOSTNAME__
12261 - name: interface-name
12263 description: Name that identifies the link aggregate interface
12266 example: __INTERFACE-NAME__
12267 - name: interface-name
12269 description: Name given to the interface
12272 example: __INTERFACE-NAME__
12275 description: PCI ID used to identify the sriov-vf
12278 example: __PCI-ID__
12279 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
12282 - CloudInfrastructure
12283 summary: returns sriov-vf
12284 description: returns sriov-vf
12285 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12291 description: successful operation
12293 $ref: "#/getDefinitions/sriov-vf"
12295 description: Response codes found in [response codes](https://wiki.onap.org/).
12299 description: Value from executing hostname on the compute node.
12302 example: __HOSTNAME__
12303 - name: interface-name
12305 description: Name that identifies the link aggregate interface
12308 example: __INTERFACE-NAME__
12309 - name: interface-name
12311 description: Name given to the interface
12314 example: __INTERFACE-NAME__
12317 description: PCI ID used to identify the sriov-vf
12320 example: __PCI-ID__
12323 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
12328 description: ID of Pserver
12335 - name: pserver-name2
12337 description: alternative pserver name
12340 - name: interface-id
12342 description: ID of interface
12345 - name: interface-role
12347 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
12350 - name: interface-id
12352 description: ID of interface
12357 description: MAC address for the interface
12360 - name: network-name
12362 description: Name of the network
12365 - name: vf-vlan-filter
12367 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
12370 - name: vf-mac-filter
12372 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
12375 - name: vf-vlan-strip
12377 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
12380 - name: neutron-network-id
12382 description: Neutron network id of the interface
12387 - CloudInfrastructure
12388 summary: create or update an existing sriov-vf
12390 Create or update an existing sriov-vf.
12392 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12393 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12402 description: Response codes found in [response codes](https://wiki.onap.org/).
12406 description: Value from executing hostname on the compute node.
12409 example: __HOSTNAME__
12410 - name: interface-name
12412 description: Name that identifies the link aggregate interface
12415 example: __INTERFACE-NAME__
12416 - name: interface-name
12418 description: Name given to the interface
12421 example: __INTERFACE-NAME__
12424 description: PCI ID used to identify the sriov-vf
12427 example: __PCI-ID__
12430 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
12433 $ref: "#/definitions/sriov-vf"
12436 - CloudInfrastructure
12437 summary: update an existing sriov-vf
12439 Update an existing sriov-vf
12441 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12442 The PUT operation will entirely replace an existing object.
12443 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12445 Other differences between PUT and PATCH are:
12447 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12448 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12449 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12450 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12459 description: Response codes found in [response codes](https://wiki.onap.org/).
12463 description: Value from executing hostname on the compute node.
12466 example: __HOSTNAME__
12467 - name: interface-name
12469 description: Name that identifies the link aggregate interface
12472 example: __INTERFACE-NAME__
12473 - name: interface-name
12475 description: Name given to the interface
12478 example: __INTERFACE-NAME__
12481 description: PCI ID used to identify the sriov-vf
12484 example: __PCI-ID__
12487 description: sriov-vf object that needs to be created or updated.
12490 $ref: "#/patchDefinitions/sriov-vf"
12493 - CloudInfrastructure
12494 summary: delete an existing sriov-vf
12495 description: delete an existing sriov-vf
12496 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12505 description: Response codes found in [response codes](https://wiki.onap.org/).
12509 description: Value from executing hostname on the compute node.
12512 example: __HOSTNAME__
12513 - name: interface-name
12515 description: Name that identifies the link aggregate interface
12518 example: __INTERFACE-NAME__
12519 - name: interface-name
12521 description: Name given to the interface
12524 example: __INTERFACE-NAME__
12527 description: PCI ID used to identify the sriov-vf
12530 example: __PCI-ID__
12531 - name: resource-version
12533 description: resource-version for concurrency
12536 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
12539 - CloudInfrastructure
12540 summary: returns sriov-vfs
12541 description: returns sriov-vfs
12542 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
12548 description: successful operation
12550 $ref: "#/getDefinitions/sriov-vfs"
12552 description: Response codes found in [response codes](https://wiki.onap.org/).
12556 description: Value from executing hostname on the compute node.
12559 example: __HOSTNAME__
12560 - name: interface-name
12562 description: Name that identifies the link aggregate interface
12565 example: __INTERFACE-NAME__
12566 - name: interface-name
12568 description: Name given to the interface
12571 example: __INTERFACE-NAME__
12574 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
12579 description: ID of Pserver
12586 - name: pserver-name2
12588 description: alternative pserver name
12591 - name: interface-id
12593 description: ID of interface
12596 - name: interface-role
12598 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
12601 - name: interface-id
12603 description: ID of interface
12608 description: MAC address for the interface
12611 - name: network-name
12613 description: Name of the network
12616 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
12619 - CloudInfrastructure
12620 summary: see node definition for valid relationships
12621 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
12630 description: Response codes found in [response codes](https://wiki.onap.org/).
12634 description: Value from executing hostname on the compute node.
12637 example: __HOSTNAME__
12638 - name: interface-name
12640 description: Name that identifies the link aggregate interface
12643 example: __INTERFACE-NAME__
12644 - name: interface-name
12646 description: Name given to the interface
12649 example: __INTERFACE-NAME__
12652 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
12655 $ref: "#/definitions/relationship"
12658 - CloudInfrastructure
12659 summary: delete an existing relationship
12660 description: delete an existing relationship
12661 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
12670 description: Response codes found in [response codes](https://wiki.onap.org/).
12674 description: Value from executing hostname on the compute node.
12677 example: __HOSTNAME__
12678 - name: interface-name
12680 description: Name that identifies the link aggregate interface
12683 example: __INTERFACE-NAME__
12684 - name: interface-name
12686 description: Name given to the interface
12689 example: __INTERFACE-NAME__
12690 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
12693 - CloudInfrastructure
12694 summary: see node definition for valid relationships
12695 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
12704 description: Response codes found in [response codes](https://wiki.onap.org/).
12708 description: Value from executing hostname on the compute node.
12711 example: __HOSTNAME__
12712 - name: interface-name
12714 description: Name that identifies the link aggregate interface
12717 example: __INTERFACE-NAME__
12718 - name: interface-name
12720 description: Name given to the interface
12723 example: __INTERFACE-NAME__
12724 - name: l3-interface-ipv4-address
12726 description: IP address
12729 example: __L3-INTERFACE-IPV4-ADDRESS__
12732 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
12735 $ref: "#/definitions/relationship"
12738 - CloudInfrastructure
12739 summary: delete an existing relationship
12740 description: delete an existing relationship
12741 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
12750 description: Response codes found in [response codes](https://wiki.onap.org/).
12754 description: Value from executing hostname on the compute node.
12757 example: __HOSTNAME__
12758 - name: interface-name
12760 description: Name that identifies the link aggregate interface
12763 example: __INTERFACE-NAME__
12764 - name: interface-name
12766 description: Name given to the interface
12769 example: __INTERFACE-NAME__
12770 - name: l3-interface-ipv4-address
12772 description: IP address
12775 example: __L3-INTERFACE-IPV4-ADDRESS__
12776 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
12779 - CloudInfrastructure
12780 summary: returns l3-interface-ipv4-address-list
12781 description: returns l3-interface-ipv4-address-list
12782 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12788 description: successful operation
12790 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
12792 description: Response codes found in [response codes](https://wiki.onap.org/).
12796 description: Value from executing hostname on the compute node.
12799 example: __HOSTNAME__
12800 - name: interface-name
12802 description: Name that identifies the link aggregate interface
12805 example: __INTERFACE-NAME__
12806 - name: interface-name
12808 description: Name given to the interface
12811 example: __INTERFACE-NAME__
12812 - name: l3-interface-ipv4-address
12814 description: IP address
12817 example: __L3-INTERFACE-IPV4-ADDRESS__
12820 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
12825 description: ID of Pserver
12832 - name: pserver-name2
12834 description: alternative pserver name
12837 - name: interface-id
12839 description: ID of interface
12842 - name: interface-role
12844 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
12847 - name: interface-id
12849 description: ID of interface
12854 description: MAC address for the interface
12857 - name: network-name
12859 description: Name of the network
12862 - name: vlan-id-inner
12864 description: Inner VLAN tag
12868 - name: neutron-network-id
12870 description: Neutron network id of the interface that address belongs to
12873 - name: neutron-subnet-id
12875 description: Neutron id of subnet that address belongs to
12880 - CloudInfrastructure
12881 summary: create or update an existing l3-interface-ipv4-address-list
12883 Create or update an existing l3-interface-ipv4-address-list.
12885 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
12886 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12895 description: Response codes found in [response codes](https://wiki.onap.org/).
12899 description: Value from executing hostname on the compute node.
12902 example: __HOSTNAME__
12903 - name: interface-name
12905 description: Name that identifies the link aggregate interface
12908 example: __INTERFACE-NAME__
12909 - name: interface-name
12911 description: Name given to the interface
12914 example: __INTERFACE-NAME__
12915 - name: l3-interface-ipv4-address
12917 description: IP address
12920 example: __L3-INTERFACE-IPV4-ADDRESS__
12923 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
12926 $ref: "#/definitions/l3-interface-ipv4-address-list"
12929 - CloudInfrastructure
12930 summary: update an existing l3-interface-ipv4-address-list
12932 Update an existing l3-interface-ipv4-address-list
12934 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12935 The PUT operation will entirely replace an existing object.
12936 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
12938 Other differences between PUT and PATCH are:
12940 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
12941 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12942 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12943 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12952 description: Response codes found in [response codes](https://wiki.onap.org/).
12956 description: Value from executing hostname on the compute node.
12959 example: __HOSTNAME__
12960 - name: interface-name
12962 description: Name that identifies the link aggregate interface
12965 example: __INTERFACE-NAME__
12966 - name: interface-name
12968 description: Name given to the interface
12971 example: __INTERFACE-NAME__
12972 - name: l3-interface-ipv4-address
12974 description: IP address
12977 example: __L3-INTERFACE-IPV4-ADDRESS__
12980 description: l3-interface-ipv4-address-list object that needs to be created or updated.
12983 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
12986 - CloudInfrastructure
12987 summary: delete an existing l3-interface-ipv4-address-list
12988 description: delete an existing l3-interface-ipv4-address-list
12989 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12998 description: Response codes found in [response codes](https://wiki.onap.org/).
13002 description: Value from executing hostname on the compute node.
13005 example: __HOSTNAME__
13006 - name: interface-name
13008 description: Name that identifies the link aggregate interface
13011 example: __INTERFACE-NAME__
13012 - name: interface-name
13014 description: Name given to the interface
13017 example: __INTERFACE-NAME__
13018 - name: l3-interface-ipv4-address
13020 description: IP address
13023 example: __L3-INTERFACE-IPV4-ADDRESS__
13024 - name: resource-version
13026 description: resource-version for concurrency
13029 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
13032 - CloudInfrastructure
13033 summary: see node definition for valid relationships
13034 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
13043 description: Response codes found in [response codes](https://wiki.onap.org/).
13047 description: Value from executing hostname on the compute node.
13050 example: __HOSTNAME__
13051 - name: interface-name
13053 description: Name that identifies the link aggregate interface
13056 example: __INTERFACE-NAME__
13057 - name: interface-name
13059 description: Name given to the interface
13062 example: __INTERFACE-NAME__
13063 - name: l3-interface-ipv6-address
13065 description: IP address
13068 example: __L3-INTERFACE-IPV6-ADDRESS__
13071 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
13074 $ref: "#/definitions/relationship"
13077 - CloudInfrastructure
13078 summary: delete an existing relationship
13079 description: delete an existing relationship
13080 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
13089 description: Response codes found in [response codes](https://wiki.onap.org/).
13093 description: Value from executing hostname on the compute node.
13096 example: __HOSTNAME__
13097 - name: interface-name
13099 description: Name that identifies the link aggregate interface
13102 example: __INTERFACE-NAME__
13103 - name: interface-name
13105 description: Name given to the interface
13108 example: __INTERFACE-NAME__
13109 - name: l3-interface-ipv6-address
13111 description: IP address
13114 example: __L3-INTERFACE-IPV6-ADDRESS__
13115 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
13118 - CloudInfrastructure
13119 summary: returns l3-interface-ipv6-address-list
13120 description: returns l3-interface-ipv6-address-list
13121 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13127 description: successful operation
13129 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
13131 description: Response codes found in [response codes](https://wiki.onap.org/).
13135 description: Value from executing hostname on the compute node.
13138 example: __HOSTNAME__
13139 - name: interface-name
13141 description: Name that identifies the link aggregate interface
13144 example: __INTERFACE-NAME__
13145 - name: interface-name
13147 description: Name given to the interface
13150 example: __INTERFACE-NAME__
13151 - name: l3-interface-ipv6-address
13153 description: IP address
13156 example: __L3-INTERFACE-IPV6-ADDRESS__
13159 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
13164 description: ID of Pserver
13171 - name: pserver-name2
13173 description: alternative pserver name
13176 - name: interface-id
13178 description: ID of interface
13181 - name: interface-role
13183 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13186 - name: interface-id
13188 description: ID of interface
13193 description: MAC address for the interface
13196 - name: network-name
13198 description: Name of the network
13201 - name: vlan-id-inner
13203 description: Inner VLAN tag
13207 - name: neutron-network-id
13209 description: Neutron network id of the interface that address belongs to
13212 - name: neutron-subnet-id
13214 description: Neutron id of subnet that address belongs to
13219 - CloudInfrastructure
13220 summary: create or update an existing l3-interface-ipv6-address-list
13222 Create or update an existing l3-interface-ipv6-address-list.
13224 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13225 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13234 description: Response codes found in [response codes](https://wiki.onap.org/).
13238 description: Value from executing hostname on the compute node.
13241 example: __HOSTNAME__
13242 - name: interface-name
13244 description: Name that identifies the link aggregate interface
13247 example: __INTERFACE-NAME__
13248 - name: interface-name
13250 description: Name given to the interface
13253 example: __INTERFACE-NAME__
13254 - name: l3-interface-ipv6-address
13256 description: IP address
13259 example: __L3-INTERFACE-IPV6-ADDRESS__
13262 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
13265 $ref: "#/definitions/l3-interface-ipv6-address-list"
13268 - CloudInfrastructure
13269 summary: update an existing l3-interface-ipv6-address-list
13271 Update an existing l3-interface-ipv6-address-list
13273 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13274 The PUT operation will entirely replace an existing object.
13275 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13277 Other differences between PUT and PATCH are:
13279 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13280 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13281 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13282 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13291 description: Response codes found in [response codes](https://wiki.onap.org/).
13295 description: Value from executing hostname on the compute node.
13298 example: __HOSTNAME__
13299 - name: interface-name
13301 description: Name that identifies the link aggregate interface
13304 example: __INTERFACE-NAME__
13305 - name: interface-name
13307 description: Name given to the interface
13310 example: __INTERFACE-NAME__
13311 - name: l3-interface-ipv6-address
13313 description: IP address
13316 example: __L3-INTERFACE-IPV6-ADDRESS__
13319 description: l3-interface-ipv6-address-list object that needs to be created or updated.
13322 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
13325 - CloudInfrastructure
13326 summary: delete an existing l3-interface-ipv6-address-list
13327 description: delete an existing l3-interface-ipv6-address-list
13328 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13337 description: Response codes found in [response codes](https://wiki.onap.org/).
13341 description: Value from executing hostname on the compute node.
13344 example: __HOSTNAME__
13345 - name: interface-name
13347 description: Name that identifies the link aggregate interface
13350 example: __INTERFACE-NAME__
13351 - name: interface-name
13353 description: Name given to the interface
13356 example: __INTERFACE-NAME__
13357 - name: l3-interface-ipv6-address
13359 description: IP address
13362 example: __L3-INTERFACE-IPV6-ADDRESS__
13363 - name: resource-version
13365 description: resource-version for concurrency
13368 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
13371 - CloudInfrastructure
13372 summary: returns l-interface
13373 description: returns l-interface
13374 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13380 description: successful operation
13382 $ref: "#/getDefinitions/l-interface"
13384 description: Response codes found in [response codes](https://wiki.onap.org/).
13388 description: Value from executing hostname on the compute node.
13391 example: __HOSTNAME__
13392 - name: interface-name
13394 description: Name that identifies the link aggregate interface
13397 example: __INTERFACE-NAME__
13398 - name: interface-name
13400 description: Name given to the interface
13403 example: __INTERFACE-NAME__
13406 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
13411 description: ID of Pserver
13418 - name: pserver-name2
13420 description: alternative pserver name
13423 - name: interface-id
13425 description: ID of interface
13428 - name: interface-role
13430 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13433 - name: interface-id
13435 description: ID of interface
13440 description: MAC address for the interface
13443 - name: network-name
13445 description: Name of the network
13450 - CloudInfrastructure
13451 summary: create or update an existing l-interface
13453 Create or update an existing l-interface.
13455 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13456 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13465 description: Response codes found in [response codes](https://wiki.onap.org/).
13469 description: Value from executing hostname on the compute node.
13472 example: __HOSTNAME__
13473 - name: interface-name
13475 description: Name that identifies the link aggregate interface
13478 example: __INTERFACE-NAME__
13479 - name: interface-name
13481 description: Name given to the interface
13484 example: __INTERFACE-NAME__
13487 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
13490 $ref: "#/definitions/l-interface"
13493 - CloudInfrastructure
13494 summary: update an existing l-interface
13496 Update an existing l-interface
13498 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13499 The PUT operation will entirely replace an existing object.
13500 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13502 Other differences between PUT and PATCH are:
13504 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13505 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13506 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13507 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13516 description: Response codes found in [response codes](https://wiki.onap.org/).
13520 description: Value from executing hostname on the compute node.
13523 example: __HOSTNAME__
13524 - name: interface-name
13526 description: Name that identifies the link aggregate interface
13529 example: __INTERFACE-NAME__
13530 - name: interface-name
13532 description: Name given to the interface
13535 example: __INTERFACE-NAME__
13538 description: l-interface object that needs to be created or updated.
13541 $ref: "#/patchDefinitions/l-interface"
13544 - CloudInfrastructure
13545 summary: delete an existing l-interface
13546 description: delete an existing l-interface
13547 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13556 description: Response codes found in [response codes](https://wiki.onap.org/).
13560 description: Value from executing hostname on the compute node.
13563 example: __HOSTNAME__
13564 - name: interface-name
13566 description: Name that identifies the link aggregate interface
13569 example: __INTERFACE-NAME__
13570 - name: interface-name
13572 description: Name given to the interface
13575 example: __INTERFACE-NAME__
13576 - name: resource-version
13578 description: resource-version for concurrency
13581 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
13584 - CloudInfrastructure
13585 summary: returns l-interfaces
13586 description: returns l-interfaces
13587 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces
13593 description: successful operation
13595 $ref: "#/getDefinitions/l-interfaces"
13597 description: Response codes found in [response codes](https://wiki.onap.org/).
13601 description: Value from executing hostname on the compute node.
13604 example: __HOSTNAME__
13605 - name: interface-name
13607 description: Name that identifies the link aggregate interface
13610 example: __INTERFACE-NAME__
13613 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
13618 description: ID of Pserver
13625 - name: pserver-name2
13627 description: alternative pserver name
13630 - name: interface-id
13632 description: ID of interface
13635 - name: interface-role
13637 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13640 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}:
13643 - CloudInfrastructure
13644 summary: returns lag-interface
13645 description: returns lag-interface
13646 operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface
13652 description: successful operation
13654 $ref: "#/getDefinitions/lag-interface"
13656 description: Response codes found in [response codes](https://wiki.onap.org/).
13660 description: Value from executing hostname on the compute node.
13663 example: __HOSTNAME__
13664 - name: interface-name
13666 description: Name that identifies the link aggregate interface
13669 example: __INTERFACE-NAME__
13672 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
13677 description: ID of Pserver
13684 - name: pserver-name2
13686 description: alternative pserver name
13689 - name: interface-id
13691 description: ID of interface
13694 - name: interface-role
13696 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13701 - CloudInfrastructure
13702 summary: create or update an existing lag-interface
13704 Create or update an existing lag-interface.
13706 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13707 operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
13716 description: Response codes found in [response codes](https://wiki.onap.org/).
13720 description: Value from executing hostname on the compute node.
13723 example: __HOSTNAME__
13724 - name: interface-name
13726 description: Name that identifies the link aggregate interface
13729 example: __INTERFACE-NAME__
13732 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
13735 $ref: "#/definitions/lag-interface"
13738 - CloudInfrastructure
13739 summary: update an existing lag-interface
13741 Update an existing lag-interface
13743 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13744 The PUT operation will entirely replace an existing object.
13745 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13747 Other differences between PUT and PATCH are:
13749 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13750 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13751 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13752 operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
13761 description: Response codes found in [response codes](https://wiki.onap.org/).
13765 description: Value from executing hostname on the compute node.
13768 example: __HOSTNAME__
13769 - name: interface-name
13771 description: Name that identifies the link aggregate interface
13774 example: __INTERFACE-NAME__
13777 description: lag-interface object that needs to be created or updated.
13780 $ref: "#/patchDefinitions/lag-interface"
13783 - CloudInfrastructure
13784 summary: delete an existing lag-interface
13785 description: delete an existing lag-interface
13786 operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface
13795 description: Response codes found in [response codes](https://wiki.onap.org/).
13799 description: Value from executing hostname on the compute node.
13802 example: __HOSTNAME__
13803 - name: interface-name
13805 description: Name that identifies the link aggregate interface
13808 example: __INTERFACE-NAME__
13809 - name: resource-version
13811 description: resource-version for concurrency
13814 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces:
13817 - CloudInfrastructure
13818 summary: returns lag-interfaces
13819 description: returns lag-interfaces
13820 operationId: getCloudInfrastructurePserversPserverLagInterfaces
13826 description: successful operation
13828 $ref: "#/getDefinitions/lag-interfaces"
13830 description: Response codes found in [response codes](https://wiki.onap.org/).
13834 description: Value from executing hostname on the compute node.
13837 example: __HOSTNAME__
13840 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
13845 description: ID of Pserver
13852 - name: pserver-name2
13854 description: alternative pserver name
13857 /cloud-infrastructure/pservers/pserver/{hostname}:
13860 - CloudInfrastructure
13861 summary: returns pserver
13862 description: returns pserver
13863 operationId: getCloudInfrastructurePserversPserver
13869 description: successful operation
13871 $ref: "#/getDefinitions/pserver"
13873 description: Response codes found in [response codes](https://wiki.onap.org/).
13877 description: Value from executing hostname on the compute node.
13880 example: __HOSTNAME__
13883 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
13888 description: ID of Pserver
13895 - name: pserver-name2
13897 description: alternative pserver name
13902 - CloudInfrastructure
13903 summary: create or update an existing pserver
13905 Create or update an existing pserver.
13907 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
13908 operationId: createOrUpdateCloudInfrastructurePserversPserver
13917 description: Response codes found in [response codes](https://wiki.onap.org/).
13921 description: Value from executing hostname on the compute node.
13924 example: __HOSTNAME__
13927 description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructurePserversPserver.json)
13930 $ref: "#/definitions/pserver"
13933 - CloudInfrastructure
13934 summary: update an existing pserver
13936 Update an existing pserver
13938 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13939 The PUT operation will entirely replace an existing object.
13940 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
13942 Other differences between PUT and PATCH are:
13944 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
13945 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13946 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13947 operationId: UpdateCloudInfrastructurePserversPserver
13956 description: Response codes found in [response codes](https://wiki.onap.org/).
13960 description: Value from executing hostname on the compute node.
13963 example: __HOSTNAME__
13966 description: pserver object that needs to be created or updated.
13969 $ref: "#/patchDefinitions/pserver"
13972 - CloudInfrastructure
13973 summary: delete an existing pserver
13974 description: delete an existing pserver
13975 operationId: deleteCloudInfrastructurePserversPserver
13984 description: Response codes found in [response codes](https://wiki.onap.org/).
13988 description: Value from executing hostname on the compute node.
13991 example: __HOSTNAME__
13992 - name: resource-version
13994 description: resource-version for concurrency
13997 /cloud-infrastructure/pservers:
14000 - CloudInfrastructure
14001 summary: returns pservers
14002 description: returns pservers
14003 operationId: getCloudInfrastructurePservers
14009 description: successful operation
14011 $ref: "#/getDefinitions/pservers"
14013 description: Response codes found in [response codes](https://wiki.onap.org/).
14014 /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship:
14017 - CloudInfrastructure
14018 summary: see node definition for valid relationships
14019 operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
14028 description: Response codes found in [response codes](https://wiki.onap.org/).
14032 description: Unique ID of the vdc
14035 example: __VDC-ID__
14038 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
14041 $ref: "#/definitions/relationship"
14044 - CloudInfrastructure
14045 summary: delete an existing relationship
14046 description: delete an existing relationship
14047 operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
14056 description: Response codes found in [response codes](https://wiki.onap.org/).
14060 description: Unique ID of the vdc
14063 example: __VDC-ID__
14064 /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}:
14067 - CloudInfrastructure
14068 summary: returns virtual-data-center
14069 description: returns virtual-data-center
14070 operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter
14076 description: successful operation
14078 $ref: "#/getDefinitions/virtual-data-center"
14080 description: Response codes found in [response codes](https://wiki.onap.org/).
14084 description: Unique ID of the vdc
14087 example: __VDC-ID__
14090 description: Name of the virtual data center
14095 - CloudInfrastructure
14096 summary: create or update an existing virtual-data-center
14098 Create or update an existing virtual-data-center.
14100 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14101 operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
14110 description: Response codes found in [response codes](https://wiki.onap.org/).
14114 description: Unique ID of the vdc
14117 example: __VDC-ID__
14120 description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
14123 $ref: "#/definitions/virtual-data-center"
14126 - CloudInfrastructure
14127 summary: update an existing virtual-data-center
14129 Update an existing virtual-data-center
14131 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14132 The PUT operation will entirely replace an existing object.
14133 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14135 Other differences between PUT and PATCH are:
14137 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14138 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14139 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14140 operationId: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
14149 description: Response codes found in [response codes](https://wiki.onap.org/).
14153 description: Unique ID of the vdc
14156 example: __VDC-ID__
14159 description: virtual-data-center object that needs to be created or updated.
14162 $ref: "#/patchDefinitions/virtual-data-center"
14165 - CloudInfrastructure
14166 summary: delete an existing virtual-data-center
14167 description: delete an existing virtual-data-center
14168 operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter
14177 description: Response codes found in [response codes](https://wiki.onap.org/).
14181 description: Unique ID of the vdc
14184 example: __VDC-ID__
14185 - name: resource-version
14187 description: resource-version for concurrency
14190 /cloud-infrastructure/virtual-data-centers:
14193 - CloudInfrastructure
14194 summary: returns virtual-data-centers
14195 description: returns virtual-data-centers
14196 operationId: getCloudInfrastructureVirtualDataCenters
14202 description: successful operation
14204 $ref: "#/getDefinitions/virtual-data-centers"
14206 description: Response codes found in [response codes](https://wiki.onap.org/).
14207 /business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
14211 summary: see node definition for valid relationships
14212 operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship
14221 description: Response codes found in [response codes](https://wiki.onap.org/).
14223 - name: resource-instance-id
14225 description: Unique id of resource instance.
14228 example: __RESOURCE-INSTANCE-ID__
14231 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessConnectorsConnector.json)
14234 $ref: "#/definitions/relationship"
14238 summary: delete an existing relationship
14239 description: delete an existing relationship
14240 operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship
14249 description: Response codes found in [response codes](https://wiki.onap.org/).
14251 - name: resource-instance-id
14253 description: Unique id of resource instance.
14256 example: __RESOURCE-INSTANCE-ID__
14257 /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
14261 summary: returns metadatum
14262 description: returns metadatum
14263 operationId: getBusinessConnectorsConnectorMetadataMetadatum
14269 description: successful operation
14271 $ref: "#/getDefinitions/metadatum"
14273 description: Response codes found in [response codes](https://wiki.onap.org/).
14275 - name: resource-instance-id
14277 description: Unique id of resource instance.
14280 example: __RESOURCE-INSTANCE-ID__
14285 example: __METANAME__
14286 - name: persona-model-id
14288 description: the ASDC model id for this resource or service model.
14291 - name: persona-model-version
14293 description: the ASDC model version for this resource or service model.
14296 - name: widget-model-id
14298 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14301 - name: widget-model-version
14303 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14309 summary: create or update an existing metadatum
14311 Create or update an existing metadatum.
14313 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14314 operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum
14323 description: Response codes found in [response codes](https://wiki.onap.org/).
14325 - name: resource-instance-id
14327 description: Unique id of resource instance.
14330 example: __RESOURCE-INSTANCE-ID__
14335 example: __METANAME__
14338 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessConnectorsConnectorMetadataMetadatum.json)
14341 $ref: "#/definitions/metadatum"
14345 summary: update an existing metadatum
14347 Update an existing metadatum
14349 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14350 The PUT operation will entirely replace an existing object.
14351 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14353 Other differences between PUT and PATCH are:
14355 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14356 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14357 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14358 operationId: UpdateBusinessConnectorsConnectorMetadataMetadatum
14367 description: Response codes found in [response codes](https://wiki.onap.org/).
14369 - name: resource-instance-id
14371 description: Unique id of resource instance.
14374 example: __RESOURCE-INSTANCE-ID__
14379 example: __METANAME__
14382 description: metadatum object that needs to be created or updated.
14385 $ref: "#/patchDefinitions/metadatum"
14389 summary: delete an existing metadatum
14390 description: delete an existing metadatum
14391 operationId: deleteBusinessConnectorsConnectorMetadataMetadatum
14400 description: Response codes found in [response codes](https://wiki.onap.org/).
14402 - name: resource-instance-id
14404 description: Unique id of resource instance.
14407 example: __RESOURCE-INSTANCE-ID__
14412 example: __METANAME__
14413 - name: resource-version
14415 description: resource-version for concurrency
14418 /business/connectors/connector/{resource-instance-id}/metadata:
14422 summary: returns metadata
14423 description: returns metadata
14424 operationId: getBusinessConnectorsConnectorMetadata
14430 description: successful operation
14432 $ref: "#/getDefinitions/metadata"
14434 description: Response codes found in [response codes](https://wiki.onap.org/).
14436 - name: resource-instance-id
14438 description: Unique id of resource instance.
14441 example: __RESOURCE-INSTANCE-ID__
14442 - name: persona-model-id
14444 description: the ASDC model id for this resource or service model.
14447 - name: persona-model-version
14449 description: the ASDC model version for this resource or service model.
14452 - name: widget-model-id
14454 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14457 - name: widget-model-version
14459 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14462 /business/connectors/connector/{resource-instance-id}:
14466 summary: returns connector
14467 description: returns connector
14468 operationId: getBusinessConnectorsConnector
14474 description: successful operation
14476 $ref: "#/getDefinitions/connector"
14478 description: Response codes found in [response codes](https://wiki.onap.org/).
14480 - name: resource-instance-id
14482 description: Unique id of resource instance.
14485 example: __RESOURCE-INSTANCE-ID__
14486 - name: persona-model-id
14488 description: the ASDC model id for this resource or service model.
14491 - name: persona-model-version
14493 description: the ASDC model version for this resource or service model.
14496 - name: widget-model-id
14498 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14501 - name: widget-model-version
14503 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14509 summary: create or update an existing connector
14511 Create or update an existing connector.
14513 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14514 operationId: createOrUpdateBusinessConnectorsConnector
14523 description: Response codes found in [response codes](https://wiki.onap.org/).
14525 - name: resource-instance-id
14527 description: Unique id of resource instance.
14530 example: __RESOURCE-INSTANCE-ID__
14533 description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessConnectorsConnector.json)
14536 $ref: "#/definitions/connector"
14540 summary: update an existing connector
14542 Update an existing connector
14544 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14545 The PUT operation will entirely replace an existing object.
14546 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14548 Other differences between PUT and PATCH are:
14550 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14551 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14552 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14553 operationId: UpdateBusinessConnectorsConnector
14562 description: Response codes found in [response codes](https://wiki.onap.org/).
14564 - name: resource-instance-id
14566 description: Unique id of resource instance.
14569 example: __RESOURCE-INSTANCE-ID__
14572 description: connector object that needs to be created or updated.
14575 $ref: "#/patchDefinitions/connector"
14579 summary: delete an existing connector
14580 description: delete an existing connector
14581 operationId: deleteBusinessConnectorsConnector
14590 description: Response codes found in [response codes](https://wiki.onap.org/).
14592 - name: resource-instance-id
14594 description: Unique id of resource instance.
14597 example: __RESOURCE-INSTANCE-ID__
14598 - name: resource-version
14600 description: resource-version for concurrency
14603 /business/connectors:
14607 summary: returns connectors
14608 description: returns connectors
14609 operationId: getBusinessConnectors
14615 description: successful operation
14617 $ref: "#/getDefinitions/connectors"
14619 description: Response codes found in [response codes](https://wiki.onap.org/).
14620 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
14624 summary: see node definition for valid relationships
14625 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
14634 description: Response codes found in [response codes](https://wiki.onap.org/).
14636 - name: global-customer-id
14638 description: Global customer id used across ECOMP to uniquely identify customer.
14641 example: __GLOBAL-CUSTOMER-ID__
14642 - name: service-type
14644 description: Value defined by orchestration to identify this service across ECOMP.
14647 example: __SERVICE-TYPE__
14648 - name: service-instance-id
14650 description: Uniquely identifies this instance of a service
14653 example: __SERVICE-INSTANCE-ID__
14656 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
14659 $ref: "#/definitions/relationship"
14663 summary: delete an existing relationship
14664 description: delete an existing relationship
14665 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
14674 description: Response codes found in [response codes](https://wiki.onap.org/).
14676 - name: global-customer-id
14678 description: Global customer id used across ECOMP to uniquely identify customer.
14681 example: __GLOBAL-CUSTOMER-ID__
14682 - name: service-type
14684 description: Value defined by orchestration to identify this service across ECOMP.
14687 example: __SERVICE-TYPE__
14688 - name: service-instance-id
14690 description: Uniquely identifies this instance of a service
14693 example: __SERVICE-INSTANCE-ID__
14694 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
14698 summary: returns metadatum
14699 description: returns metadatum
14700 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
14706 description: successful operation
14708 $ref: "#/getDefinitions/metadatum"
14710 description: Response codes found in [response codes](https://wiki.onap.org/).
14712 - name: global-customer-id
14714 description: Global customer id used across ECOMP to uniquely identify customer.
14717 example: __GLOBAL-CUSTOMER-ID__
14718 - name: service-type
14720 description: Value defined by orchestration to identify this service across ECOMP.
14723 example: __SERVICE-TYPE__
14724 - name: service-instance-id
14726 description: Uniquely identifies this instance of a service
14729 example: __SERVICE-INSTANCE-ID__
14734 example: __METANAME__
14735 - name: subscriber-name
14737 description: Subscriber name, an alternate way to retrieve a customer.
14740 - name: subscriber-type
14742 description: Subscriber type, a way to provide VID with only the INFRA customers.
14745 - name: service-instance-name
14747 description: This field will store a name assigned to the service-instance.
14750 - name: persona-model-id
14752 description: the ASDC model id for this resource or service model.
14755 - name: persona-model-version
14757 description: the ASDC model version for this resource or service model.
14760 - name: widget-model-id
14762 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14765 - name: widget-model-version
14767 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14770 - name: service-instance-location-id
14772 description: An identifier that customers assign to the location where this service is being used.
14775 - name: orchestration-status
14777 description: Orchestration status of this service.
14783 summary: create or update an existing metadatum
14785 Create or update an existing metadatum.
14787 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
14788 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
14797 description: Response codes found in [response codes](https://wiki.onap.org/).
14799 - name: global-customer-id
14801 description: Global customer id used across ECOMP to uniquely identify customer.
14804 example: __GLOBAL-CUSTOMER-ID__
14805 - name: service-type
14807 description: Value defined by orchestration to identify this service across ECOMP.
14810 example: __SERVICE-TYPE__
14811 - name: service-instance-id
14813 description: Uniquely identifies this instance of a service
14816 example: __SERVICE-INSTANCE-ID__
14821 example: __METANAME__
14824 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)
14827 $ref: "#/definitions/metadatum"
14831 summary: update an existing metadatum
14833 Update an existing metadatum
14835 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14836 The PUT operation will entirely replace an existing object.
14837 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
14839 Other differences between PUT and PATCH are:
14841 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
14842 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14843 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14844 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
14853 description: Response codes found in [response codes](https://wiki.onap.org/).
14855 - name: global-customer-id
14857 description: Global customer id used across ECOMP to uniquely identify customer.
14860 example: __GLOBAL-CUSTOMER-ID__
14861 - name: service-type
14863 description: Value defined by orchestration to identify this service across ECOMP.
14866 example: __SERVICE-TYPE__
14867 - name: service-instance-id
14869 description: Uniquely identifies this instance of a service
14872 example: __SERVICE-INSTANCE-ID__
14877 example: __METANAME__
14880 description: metadatum object that needs to be created or updated.
14883 $ref: "#/patchDefinitions/metadatum"
14887 summary: delete an existing metadatum
14888 description: delete an existing metadatum
14889 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
14898 description: Response codes found in [response codes](https://wiki.onap.org/).
14900 - name: global-customer-id
14902 description: Global customer id used across ECOMP to uniquely identify customer.
14905 example: __GLOBAL-CUSTOMER-ID__
14906 - name: service-type
14908 description: Value defined by orchestration to identify this service across ECOMP.
14911 example: __SERVICE-TYPE__
14912 - name: service-instance-id
14914 description: Uniquely identifies this instance of a service
14917 example: __SERVICE-INSTANCE-ID__
14922 example: __METANAME__
14923 - name: resource-version
14925 description: resource-version for concurrency
14928 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
14932 summary: returns metadata
14933 description: returns metadata
14934 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
14940 description: successful operation
14942 $ref: "#/getDefinitions/metadata"
14944 description: Response codes found in [response codes](https://wiki.onap.org/).
14946 - name: global-customer-id
14948 description: Global customer id used across ECOMP to uniquely identify customer.
14951 example: __GLOBAL-CUSTOMER-ID__
14952 - name: service-type
14954 description: Value defined by orchestration to identify this service across ECOMP.
14957 example: __SERVICE-TYPE__
14958 - name: service-instance-id
14960 description: Uniquely identifies this instance of a service
14963 example: __SERVICE-INSTANCE-ID__
14964 - name: subscriber-name
14966 description: Subscriber name, an alternate way to retrieve a customer.
14969 - name: subscriber-type
14971 description: Subscriber type, a way to provide VID with only the INFRA customers.
14974 - name: service-instance-name
14976 description: This field will store a name assigned to the service-instance.
14979 - name: persona-model-id
14981 description: the ASDC model id for this resource or service model.
14984 - name: persona-model-version
14986 description: the ASDC model version for this resource or service model.
14989 - name: widget-model-id
14991 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14994 - name: widget-model-version
14996 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14999 - name: service-instance-location-id
15001 description: An identifier that customers assign to the location where this service is being used.
15004 - name: orchestration-status
15006 description: Orchestration status of this service.
15009 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}/relationship-list/relationship:
15013 summary: see node definition for valid relationships
15014 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
15023 description: Response codes found in [response codes](https://wiki.onap.org/).
15025 - name: global-customer-id
15027 description: Global customer id used across ECOMP to uniquely identify customer.
15030 example: __GLOBAL-CUSTOMER-ID__
15031 - name: service-type
15033 description: Value defined by orchestration to identify this service across ECOMP.
15036 example: __SERVICE-TYPE__
15037 - name: service-instance-id
15039 description: Uniquely identifies this instance of a service
15042 example: __SERVICE-INSTANCE-ID__
15045 description: Allotted Resource id UUID assigned to this instance.
15051 description: Allotted Resource id UUID assigned to this instance.
15057 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
15060 $ref: "#/definitions/relationship"
15064 summary: delete an existing relationship
15065 description: delete an existing relationship
15066 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
15075 description: Response codes found in [response codes](https://wiki.onap.org/).
15077 - name: global-customer-id
15079 description: Global customer id used across ECOMP to uniquely identify customer.
15082 example: __GLOBAL-CUSTOMER-ID__
15083 - name: service-type
15085 description: Value defined by orchestration to identify this service across ECOMP.
15088 example: __SERVICE-TYPE__
15089 - name: service-instance-id
15091 description: Uniquely identifies this instance of a service
15094 example: __SERVICE-INSTANCE-ID__
15097 description: Allotted Resource id UUID assigned to this instance.
15103 description: Allotted Resource id UUID assigned to this instance.
15107 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}:
15111 summary: returns tunnel-xconnect
15112 description: returns tunnel-xconnect
15113 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15119 description: successful operation
15121 $ref: "#/getDefinitions/tunnel-xconnect"
15123 description: Response codes found in [response codes](https://wiki.onap.org/).
15125 - name: global-customer-id
15127 description: Global customer id used across ECOMP to uniquely identify customer.
15130 example: __GLOBAL-CUSTOMER-ID__
15131 - name: service-type
15133 description: Value defined by orchestration to identify this service across ECOMP.
15136 example: __SERVICE-TYPE__
15137 - name: service-instance-id
15139 description: Uniquely identifies this instance of a service
15142 example: __SERVICE-INSTANCE-ID__
15145 description: Allotted Resource id UUID assigned to this instance.
15151 description: Allotted Resource id UUID assigned to this instance.
15155 - name: subscriber-name
15157 description: Subscriber name, an alternate way to retrieve a customer.
15160 - name: subscriber-type
15162 description: Subscriber type, a way to provide VID with only the INFRA customers.
15165 - name: service-instance-name
15167 description: This field will store a name assigned to the service-instance.
15170 - name: persona-model-id
15172 description: the ASDC model id for this resource or service model.
15175 - name: persona-model-version
15177 description: the ASDC model version for this resource or service model.
15180 - name: widget-model-id
15182 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15185 - name: widget-model-version
15187 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15190 - name: service-instance-location-id
15192 description: An identifier that customers assign to the location where this service is being used.
15195 - name: orchestration-status
15197 description: Orchestration status of this service.
15200 - name: persona-model-id
15202 description: the ASDC model id for this resource or service model.
15205 - name: persona-model-version
15207 description: the ASDC model version for this resource or service model.
15213 summary: create or update an existing tunnel-xconnect
15215 Create or update an existing tunnel-xconnect.
15217 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15218 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15227 description: Response codes found in [response codes](https://wiki.onap.org/).
15229 - name: global-customer-id
15231 description: Global customer id used across ECOMP to uniquely identify customer.
15234 example: __GLOBAL-CUSTOMER-ID__
15235 - name: service-type
15237 description: Value defined by orchestration to identify this service across ECOMP.
15240 example: __SERVICE-TYPE__
15241 - name: service-instance-id
15243 description: Uniquely identifies this instance of a service
15246 example: __SERVICE-INSTANCE-ID__
15249 description: Allotted Resource id UUID assigned to this instance.
15255 description: Allotted Resource id UUID assigned to this instance.
15261 description: tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
15264 $ref: "#/definitions/tunnel-xconnect"
15268 summary: update an existing tunnel-xconnect
15270 Update an existing tunnel-xconnect
15272 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15273 The PUT operation will entirely replace an existing object.
15274 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15276 Other differences between PUT and PATCH are:
15278 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15279 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15280 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15281 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15290 description: Response codes found in [response codes](https://wiki.onap.org/).
15292 - name: global-customer-id
15294 description: Global customer id used across ECOMP to uniquely identify customer.
15297 example: __GLOBAL-CUSTOMER-ID__
15298 - name: service-type
15300 description: Value defined by orchestration to identify this service across ECOMP.
15303 example: __SERVICE-TYPE__
15304 - name: service-instance-id
15306 description: Uniquely identifies this instance of a service
15309 example: __SERVICE-INSTANCE-ID__
15312 description: Allotted Resource id UUID assigned to this instance.
15318 description: Allotted Resource id UUID assigned to this instance.
15324 description: tunnel-xconnect object that needs to be created or updated.
15327 $ref: "#/patchDefinitions/tunnel-xconnect"
15331 summary: delete an existing tunnel-xconnect
15332 description: delete an existing tunnel-xconnect
15333 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15342 description: Response codes found in [response codes](https://wiki.onap.org/).
15344 - name: global-customer-id
15346 description: Global customer id used across ECOMP to uniquely identify customer.
15349 example: __GLOBAL-CUSTOMER-ID__
15350 - name: service-type
15352 description: Value defined by orchestration to identify this service across ECOMP.
15355 example: __SERVICE-TYPE__
15356 - name: service-instance-id
15358 description: Uniquely identifies this instance of a service
15361 example: __SERVICE-INSTANCE-ID__
15364 description: Allotted Resource id UUID assigned to this instance.
15370 description: Allotted Resource id UUID assigned to this instance.
15374 - name: resource-version
15376 description: resource-version for concurrency
15379 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects:
15383 summary: returns tunnel-xconnects
15384 description: returns tunnel-xconnects
15385 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects
15391 description: successful operation
15393 $ref: "#/getDefinitions/tunnel-xconnects"
15395 description: Response codes found in [response codes](https://wiki.onap.org/).
15397 - name: global-customer-id
15399 description: Global customer id used across ECOMP to uniquely identify customer.
15402 example: __GLOBAL-CUSTOMER-ID__
15403 - name: service-type
15405 description: Value defined by orchestration to identify this service across ECOMP.
15408 example: __SERVICE-TYPE__
15409 - name: service-instance-id
15411 description: Uniquely identifies this instance of a service
15414 example: __SERVICE-INSTANCE-ID__
15417 description: Allotted Resource id UUID assigned to this instance.
15421 - name: subscriber-name
15423 description: Subscriber name, an alternate way to retrieve a customer.
15426 - name: subscriber-type
15428 description: Subscriber type, a way to provide VID with only the INFRA customers.
15431 - name: service-instance-name
15433 description: This field will store a name assigned to the service-instance.
15436 - name: persona-model-id
15438 description: the ASDC model id for this resource or service model.
15441 - name: persona-model-version
15443 description: the ASDC model version for this resource or service model.
15446 - name: widget-model-id
15448 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15451 - name: widget-model-version
15453 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15456 - name: service-instance-location-id
15458 description: An identifier that customers assign to the location where this service is being used.
15461 - name: orchestration-status
15463 description: Orchestration status of this service.
15466 - name: persona-model-id
15468 description: the ASDC model id for this resource or service model.
15471 - name: persona-model-version
15473 description: the ASDC model version for this resource or service model.
15476 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship:
15480 summary: see node definition for valid relationships
15481 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
15490 description: Response codes found in [response codes](https://wiki.onap.org/).
15492 - name: global-customer-id
15494 description: Global customer id used across ECOMP to uniquely identify customer.
15497 example: __GLOBAL-CUSTOMER-ID__
15498 - name: service-type
15500 description: Value defined by orchestration to identify this service across ECOMP.
15503 example: __SERVICE-TYPE__
15504 - name: service-instance-id
15506 description: Uniquely identifies this instance of a service
15509 example: __SERVICE-INSTANCE-ID__
15512 description: Allotted Resource id UUID assigned to this instance.
15518 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
15521 $ref: "#/definitions/relationship"
15525 summary: delete an existing relationship
15526 description: delete an existing relationship
15527 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
15536 description: Response codes found in [response codes](https://wiki.onap.org/).
15538 - name: global-customer-id
15540 description: Global customer id used across ECOMP to uniquely identify customer.
15543 example: __GLOBAL-CUSTOMER-ID__
15544 - name: service-type
15546 description: Value defined by orchestration to identify this service across ECOMP.
15549 example: __SERVICE-TYPE__
15550 - name: service-instance-id
15552 description: Uniquely identifies this instance of a service
15555 example: __SERVICE-INSTANCE-ID__
15558 description: Allotted Resource id UUID assigned to this instance.
15562 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}:
15566 summary: returns allotted-resource
15567 description: returns allotted-resource
15568 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
15574 description: successful operation
15576 $ref: "#/getDefinitions/allotted-resource"
15578 description: Response codes found in [response codes](https://wiki.onap.org/).
15580 - name: global-customer-id
15582 description: Global customer id used across ECOMP to uniquely identify customer.
15585 example: __GLOBAL-CUSTOMER-ID__
15586 - name: service-type
15588 description: Value defined by orchestration to identify this service across ECOMP.
15591 example: __SERVICE-TYPE__
15592 - name: service-instance-id
15594 description: Uniquely identifies this instance of a service
15597 example: __SERVICE-INSTANCE-ID__
15600 description: Allotted Resource id UUID assigned to this instance.
15604 - name: subscriber-name
15606 description: Subscriber name, an alternate way to retrieve a customer.
15609 - name: subscriber-type
15611 description: Subscriber type, a way to provide VID with only the INFRA customers.
15614 - name: service-instance-name
15616 description: This field will store a name assigned to the service-instance.
15619 - name: persona-model-id
15621 description: the ASDC model id for this resource or service model.
15624 - name: persona-model-version
15626 description: the ASDC model version for this resource or service model.
15629 - name: widget-model-id
15631 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15634 - name: widget-model-version
15636 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15639 - name: service-instance-location-id
15641 description: An identifier that customers assign to the location where this service is being used.
15644 - name: orchestration-status
15646 description: Orchestration status of this service.
15649 - name: persona-model-id
15651 description: the ASDC model id for this resource or service model.
15654 - name: persona-model-version
15656 description: the ASDC model version for this resource or service model.
15662 summary: create or update an existing allotted-resource
15664 Create or update an existing allotted-resource.
15666 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15667 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
15676 description: Response codes found in [response codes](https://wiki.onap.org/).
15678 - name: global-customer-id
15680 description: Global customer id used across ECOMP to uniquely identify customer.
15683 example: __GLOBAL-CUSTOMER-ID__
15684 - name: service-type
15686 description: Value defined by orchestration to identify this service across ECOMP.
15689 example: __SERVICE-TYPE__
15690 - name: service-instance-id
15692 description: Uniquely identifies this instance of a service
15695 example: __SERVICE-INSTANCE-ID__
15698 description: Allotted Resource id UUID assigned to this instance.
15704 description: allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
15707 $ref: "#/definitions/allotted-resource"
15711 summary: update an existing allotted-resource
15713 Update an existing allotted-resource
15715 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15716 The PUT operation will entirely replace an existing object.
15717 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
15719 Other differences between PUT and PATCH are:
15721 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
15722 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15723 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15724 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
15733 description: Response codes found in [response codes](https://wiki.onap.org/).
15735 - name: global-customer-id
15737 description: Global customer id used across ECOMP to uniquely identify customer.
15740 example: __GLOBAL-CUSTOMER-ID__
15741 - name: service-type
15743 description: Value defined by orchestration to identify this service across ECOMP.
15746 example: __SERVICE-TYPE__
15747 - name: service-instance-id
15749 description: Uniquely identifies this instance of a service
15752 example: __SERVICE-INSTANCE-ID__
15755 description: Allotted Resource id UUID assigned to this instance.
15761 description: allotted-resource object that needs to be created or updated.
15764 $ref: "#/patchDefinitions/allotted-resource"
15768 summary: delete an existing allotted-resource
15769 description: delete an existing allotted-resource
15770 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
15779 description: Response codes found in [response codes](https://wiki.onap.org/).
15781 - name: global-customer-id
15783 description: Global customer id used across ECOMP to uniquely identify customer.
15786 example: __GLOBAL-CUSTOMER-ID__
15787 - name: service-type
15789 description: Value defined by orchestration to identify this service across ECOMP.
15792 example: __SERVICE-TYPE__
15793 - name: service-instance-id
15795 description: Uniquely identifies this instance of a service
15798 example: __SERVICE-INSTANCE-ID__
15801 description: Allotted Resource id UUID assigned to this instance.
15805 - name: resource-version
15807 description: resource-version for concurrency
15810 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources:
15814 summary: returns allotted-resources
15815 description: returns allotted-resources
15816 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources
15822 description: successful operation
15824 $ref: "#/getDefinitions/allotted-resources"
15826 description: Response codes found in [response codes](https://wiki.onap.org/).
15828 - name: global-customer-id
15830 description: Global customer id used across ECOMP to uniquely identify customer.
15833 example: __GLOBAL-CUSTOMER-ID__
15834 - name: service-type
15836 description: Value defined by orchestration to identify this service across ECOMP.
15839 example: __SERVICE-TYPE__
15840 - name: service-instance-id
15842 description: Uniquely identifies this instance of a service
15845 example: __SERVICE-INSTANCE-ID__
15846 - name: subscriber-name
15848 description: Subscriber name, an alternate way to retrieve a customer.
15851 - name: subscriber-type
15853 description: Subscriber type, a way to provide VID with only the INFRA customers.
15856 - name: service-instance-name
15858 description: This field will store a name assigned to the service-instance.
15861 - name: persona-model-id
15863 description: the ASDC model id for this resource or service model.
15866 - name: persona-model-version
15868 description: the ASDC model version for this resource or service model.
15871 - name: widget-model-id
15873 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15876 - name: widget-model-version
15878 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15881 - name: service-instance-location-id
15883 description: An identifier that customers assign to the location where this service is being used.
15886 - name: orchestration-status
15888 description: Orchestration status of this service.
15891 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
15895 summary: returns service-instance
15896 description: returns service-instance
15897 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
15903 description: successful operation
15905 $ref: "#/getDefinitions/service-instance"
15907 description: Response codes found in [response codes](https://wiki.onap.org/).
15909 - name: global-customer-id
15911 description: Global customer id used across ECOMP to uniquely identify customer.
15914 example: __GLOBAL-CUSTOMER-ID__
15915 - name: service-type
15917 description: Value defined by orchestration to identify this service across ECOMP.
15920 example: __SERVICE-TYPE__
15921 - name: service-instance-id
15923 description: Uniquely identifies this instance of a service
15926 example: __SERVICE-INSTANCE-ID__
15927 - name: subscriber-name
15929 description: Subscriber name, an alternate way to retrieve a customer.
15932 - name: subscriber-type
15934 description: Subscriber type, a way to provide VID with only the INFRA customers.
15937 - name: service-instance-name
15939 description: This field will store a name assigned to the service-instance.
15942 - name: persona-model-id
15944 description: the ASDC model id for this resource or service model.
15947 - name: persona-model-version
15949 description: the ASDC model version for this resource or service model.
15952 - name: widget-model-id
15954 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15957 - name: widget-model-version
15959 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15962 - name: service-instance-location-id
15964 description: An identifier that customers assign to the location where this service is being used.
15967 - name: orchestration-status
15969 description: Orchestration status of this service.
15975 summary: create or update an existing service-instance
15977 Create or update an existing service-instance.
15979 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
15980 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
15989 description: Response codes found in [response codes](https://wiki.onap.org/).
15991 - name: global-customer-id
15993 description: Global customer id used across ECOMP to uniquely identify customer.
15996 example: __GLOBAL-CUSTOMER-ID__
15997 - name: service-type
15999 description: Value defined by orchestration to identify this service across ECOMP.
16002 example: __SERVICE-TYPE__
16003 - name: service-instance-id
16005 description: Uniquely identifies this instance of a service
16008 example: __SERVICE-INSTANCE-ID__
16011 description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
16014 $ref: "#/definitions/service-instance"
16018 summary: update an existing service-instance
16020 Update an existing service-instance
16022 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16023 The PUT operation will entirely replace an existing object.
16024 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16026 Other differences between PUT and PATCH are:
16028 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16029 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16030 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16031 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
16040 description: Response codes found in [response codes](https://wiki.onap.org/).
16042 - name: global-customer-id
16044 description: Global customer id used across ECOMP to uniquely identify customer.
16047 example: __GLOBAL-CUSTOMER-ID__
16048 - name: service-type
16050 description: Value defined by orchestration to identify this service across ECOMP.
16053 example: __SERVICE-TYPE__
16054 - name: service-instance-id
16056 description: Uniquely identifies this instance of a service
16059 example: __SERVICE-INSTANCE-ID__
16062 description: service-instance object that needs to be created or updated.
16065 $ref: "#/patchDefinitions/service-instance"
16069 summary: delete an existing service-instance
16070 description: delete an existing service-instance
16071 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
16080 description: Response codes found in [response codes](https://wiki.onap.org/).
16082 - name: global-customer-id
16084 description: Global customer id used across ECOMP to uniquely identify customer.
16087 example: __GLOBAL-CUSTOMER-ID__
16088 - name: service-type
16090 description: Value defined by orchestration to identify this service across ECOMP.
16093 example: __SERVICE-TYPE__
16094 - name: service-instance-id
16096 description: Uniquely identifies this instance of a service
16099 example: __SERVICE-INSTANCE-ID__
16100 - name: resource-version
16102 description: resource-version for concurrency
16105 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances:
16109 summary: returns service-instances
16110 description: returns service-instances
16111 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances
16117 description: successful operation
16119 $ref: "#/getDefinitions/service-instances"
16121 description: Response codes found in [response codes](https://wiki.onap.org/).
16123 - name: global-customer-id
16125 description: Global customer id used across ECOMP to uniquely identify customer.
16128 example: __GLOBAL-CUSTOMER-ID__
16129 - name: service-type
16131 description: Value defined by orchestration to identify this service across ECOMP.
16134 example: __SERVICE-TYPE__
16135 - name: subscriber-name
16137 description: Subscriber name, an alternate way to retrieve a customer.
16140 - name: subscriber-type
16142 description: Subscriber type, a way to provide VID with only the INFRA customers.
16145 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship:
16149 summary: see node definition for valid relationships
16150 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
16159 description: Response codes found in [response codes](https://wiki.onap.org/).
16161 - name: global-customer-id
16163 description: Global customer id used across ECOMP to uniquely identify customer.
16166 example: __GLOBAL-CUSTOMER-ID__
16167 - name: service-type
16169 description: Value defined by orchestration to identify this service across ECOMP.
16172 example: __SERVICE-TYPE__
16175 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
16178 $ref: "#/definitions/relationship"
16182 summary: delete an existing relationship
16183 description: delete an existing relationship
16184 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
16193 description: Response codes found in [response codes](https://wiki.onap.org/).
16195 - name: global-customer-id
16197 description: Global customer id used across ECOMP to uniquely identify customer.
16200 example: __GLOBAL-CUSTOMER-ID__
16201 - name: service-type
16203 description: Value defined by orchestration to identify this service across ECOMP.
16206 example: __SERVICE-TYPE__
16207 /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}:
16211 summary: returns service-subscription
16212 description: returns service-subscription
16213 operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16219 description: successful operation
16221 $ref: "#/getDefinitions/service-subscription"
16223 description: Response codes found in [response codes](https://wiki.onap.org/).
16225 - name: global-customer-id
16227 description: Global customer id used across ECOMP to uniquely identify customer.
16230 example: __GLOBAL-CUSTOMER-ID__
16231 - name: service-type
16233 description: Value defined by orchestration to identify this service across ECOMP.
16236 example: __SERVICE-TYPE__
16237 - name: subscriber-name
16239 description: Subscriber name, an alternate way to retrieve a customer.
16242 - name: subscriber-type
16244 description: Subscriber type, a way to provide VID with only the INFRA customers.
16250 summary: create or update an existing service-subscription
16252 Create or update an existing service-subscription.
16254 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16255 operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16264 description: Response codes found in [response codes](https://wiki.onap.org/).
16266 - name: global-customer-id
16268 description: Global customer id used across ECOMP to uniquely identify customer.
16271 example: __GLOBAL-CUSTOMER-ID__
16272 - name: service-type
16274 description: Value defined by orchestration to identify this service across ECOMP.
16277 example: __SERVICE-TYPE__
16280 description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
16283 $ref: "#/definitions/service-subscription"
16287 summary: update an existing service-subscription
16289 Update an existing service-subscription
16291 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16292 The PUT operation will entirely replace an existing object.
16293 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16295 Other differences between PUT and PATCH are:
16297 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16298 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16299 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16300 operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16309 description: Response codes found in [response codes](https://wiki.onap.org/).
16311 - name: global-customer-id
16313 description: Global customer id used across ECOMP to uniquely identify customer.
16316 example: __GLOBAL-CUSTOMER-ID__
16317 - name: service-type
16319 description: Value defined by orchestration to identify this service across ECOMP.
16322 example: __SERVICE-TYPE__
16325 description: service-subscription object that needs to be created or updated.
16328 $ref: "#/patchDefinitions/service-subscription"
16332 summary: delete an existing service-subscription
16333 description: delete an existing service-subscription
16334 operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16343 description: Response codes found in [response codes](https://wiki.onap.org/).
16345 - name: global-customer-id
16347 description: Global customer id used across ECOMP to uniquely identify customer.
16350 example: __GLOBAL-CUSTOMER-ID__
16351 - name: service-type
16353 description: Value defined by orchestration to identify this service across ECOMP.
16356 example: __SERVICE-TYPE__
16357 - name: resource-version
16359 description: resource-version for concurrency
16362 /business/customers/customer/{global-customer-id}/service-subscriptions:
16366 summary: returns service-subscriptions
16367 description: returns service-subscriptions
16368 operationId: getBusinessCustomersCustomerServiceSubscriptions
16374 description: successful operation
16376 $ref: "#/getDefinitions/service-subscriptions"
16378 description: Response codes found in [response codes](https://wiki.onap.org/).
16380 - name: global-customer-id
16382 description: Global customer id used across ECOMP to uniquely identify customer.
16385 example: __GLOBAL-CUSTOMER-ID__
16386 - name: subscriber-name
16388 description: Subscriber name, an alternate way to retrieve a customer.
16391 - name: subscriber-type
16393 description: Subscriber type, a way to provide VID with only the INFRA customers.
16396 /business/customers/customer/{global-customer-id}/relationship-list/relationship:
16400 summary: see node definition for valid relationships
16401 operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship
16410 description: Response codes found in [response codes](https://wiki.onap.org/).
16412 - name: global-customer-id
16414 description: Global customer id used across ECOMP to uniquely identify customer.
16417 example: __GLOBAL-CUSTOMER-ID__
16420 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomer.json)
16423 $ref: "#/definitions/relationship"
16427 summary: delete an existing relationship
16428 description: delete an existing relationship
16429 operationId: deleteBusinessCustomersCustomerRelationshipListRelationship
16438 description: Response codes found in [response codes](https://wiki.onap.org/).
16440 - name: global-customer-id
16442 description: Global customer id used across ECOMP to uniquely identify customer.
16445 example: __GLOBAL-CUSTOMER-ID__
16446 /business/customers/customer/{global-customer-id}:
16450 summary: returns customer
16451 description: returns customer
16452 operationId: getBusinessCustomersCustomer
16458 description: successful operation
16460 $ref: "#/getDefinitions/customer"
16462 description: Response codes found in [response codes](https://wiki.onap.org/).
16464 - name: global-customer-id
16466 description: Global customer id used across ECOMP to uniquely identify customer.
16469 example: __GLOBAL-CUSTOMER-ID__
16470 - name: subscriber-name
16472 description: Subscriber name, an alternate way to retrieve a customer.
16475 - name: subscriber-type
16477 description: Subscriber type, a way to provide VID with only the INFRA customers.
16483 summary: create or update an existing customer
16485 Create or update an existing customer.
16487 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16488 operationId: createOrUpdateBusinessCustomersCustomer
16497 description: Response codes found in [response codes](https://wiki.onap.org/).
16499 - name: global-customer-id
16501 description: Global customer id used across ECOMP to uniquely identify customer.
16504 example: __GLOBAL-CUSTOMER-ID__
16507 description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/BusinessCustomersCustomer.json)
16510 $ref: "#/definitions/customer"
16514 summary: update an existing customer
16516 Update an existing customer
16518 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16519 The PUT operation will entirely replace an existing object.
16520 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16522 Other differences between PUT and PATCH are:
16524 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16525 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16526 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16527 operationId: UpdateBusinessCustomersCustomer
16536 description: Response codes found in [response codes](https://wiki.onap.org/).
16538 - name: global-customer-id
16540 description: Global customer id used across ECOMP to uniquely identify customer.
16543 example: __GLOBAL-CUSTOMER-ID__
16546 description: customer object that needs to be created or updated.
16549 $ref: "#/patchDefinitions/customer"
16553 summary: delete an existing customer
16554 description: delete an existing customer
16555 operationId: deleteBusinessCustomersCustomer
16564 description: Response codes found in [response codes](https://wiki.onap.org/).
16566 - name: global-customer-id
16568 description: Global customer id used across ECOMP to uniquely identify customer.
16571 example: __GLOBAL-CUSTOMER-ID__
16572 - name: resource-version
16574 description: resource-version for concurrency
16577 /business/customers:
16581 summary: returns customers
16582 description: returns customers
16583 operationId: getBusinessCustomers
16589 description: successful operation
16591 $ref: "#/getDefinitions/customers"
16593 description: Response codes found in [response codes](https://wiki.onap.org/).
16594 /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
16597 - ServiceDesignAndCreation
16598 summary: see node definition for valid relationships
16599 operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
16608 description: Response codes found in [response codes](https://wiki.onap.org/).
16610 - name: vnf-image-uuid
16612 description: Unique ID of this asset
16615 example: __VNF-IMAGE-UUID__
16618 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationVnfImagesVnfImage.json)
16621 $ref: "#/definitions/relationship"
16624 - ServiceDesignAndCreation
16625 summary: delete an existing relationship
16626 description: delete an existing relationship
16627 operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
16636 description: Response codes found in [response codes](https://wiki.onap.org/).
16638 - name: vnf-image-uuid
16640 description: Unique ID of this asset
16643 example: __VNF-IMAGE-UUID__
16644 /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}:
16647 - ServiceDesignAndCreation
16648 summary: returns vnf-image
16649 description: returns vnf-image
16650 operationId: getServiceDesignAndCreationVnfImagesVnfImage
16656 description: successful operation
16658 $ref: "#/getDefinitions/vnf-image"
16660 description: Response codes found in [response codes](https://wiki.onap.org/).
16662 - name: vnf-image-uuid
16664 description: Unique ID of this asset
16667 example: __VNF-IMAGE-UUID__
16668 - name: application
16670 description: The application that the image instantiates.
16673 - name: application-vendor
16675 description: The vendor of the application.
16678 - name: application-version
16680 description: The version of the application.
16685 - ServiceDesignAndCreation
16686 summary: create or update an existing vnf-image
16688 Create or update an existing vnf-image.
16690 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16691 operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage
16700 description: Response codes found in [response codes](https://wiki.onap.org/).
16702 - name: vnf-image-uuid
16704 description: Unique ID of this asset
16707 example: __VNF-IMAGE-UUID__
16710 description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationVnfImagesVnfImage.json)
16713 $ref: "#/definitions/vnf-image"
16716 - ServiceDesignAndCreation
16717 summary: update an existing vnf-image
16719 Update an existing vnf-image
16721 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16722 The PUT operation will entirely replace an existing object.
16723 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16725 Other differences between PUT and PATCH are:
16727 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16728 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16729 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16730 operationId: UpdateServiceDesignAndCreationVnfImagesVnfImage
16739 description: Response codes found in [response codes](https://wiki.onap.org/).
16741 - name: vnf-image-uuid
16743 description: Unique ID of this asset
16746 example: __VNF-IMAGE-UUID__
16749 description: vnf-image object that needs to be created or updated.
16752 $ref: "#/patchDefinitions/vnf-image"
16755 - ServiceDesignAndCreation
16756 summary: delete an existing vnf-image
16757 description: delete an existing vnf-image
16758 operationId: deleteServiceDesignAndCreationVnfImagesVnfImage
16767 description: Response codes found in [response codes](https://wiki.onap.org/).
16769 - name: vnf-image-uuid
16771 description: Unique ID of this asset
16774 example: __VNF-IMAGE-UUID__
16775 - name: resource-version
16777 description: resource-version for concurrency
16780 /service-design-and-creation/vnf-images:
16783 - ServiceDesignAndCreation
16784 summary: returns vnf-images
16785 description: returns vnf-images
16786 operationId: getServiceDesignAndCreationVnfImages
16792 description: successful operation
16794 $ref: "#/getDefinitions/vnf-images"
16796 description: Response codes found in [response codes](https://wiki.onap.org/).
16797 /service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
16800 - ServiceDesignAndCreation
16801 summary: see node definition for valid relationships
16802 operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship
16811 description: Response codes found in [response codes](https://wiki.onap.org/).
16815 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16818 example: __SERVICE-ID__
16821 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationServicesService.json)
16824 $ref: "#/definitions/relationship"
16827 - ServiceDesignAndCreation
16828 summary: delete an existing relationship
16829 description: delete an existing relationship
16830 operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship
16839 description: Response codes found in [response codes](https://wiki.onap.org/).
16843 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16846 example: __SERVICE-ID__
16847 /service-design-and-creation/services/service/{service-id}:
16850 - ServiceDesignAndCreation
16851 summary: returns service
16852 description: returns service
16853 operationId: getServiceDesignAndCreationServicesService
16859 description: successful operation
16861 $ref: "#/getDefinitions/service"
16863 description: Response codes found in [response codes](https://wiki.onap.org/).
16867 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16870 example: __SERVICE-ID__
16871 - name: service-description
16873 description: Description of the service
16878 - ServiceDesignAndCreation
16879 summary: create or update an existing service
16881 Create or update an existing service.
16883 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
16884 operationId: createOrUpdateServiceDesignAndCreationServicesService
16893 description: Response codes found in [response codes](https://wiki.onap.org/).
16897 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16900 example: __SERVICE-ID__
16903 description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationServicesService.json)
16906 $ref: "#/definitions/service"
16909 - ServiceDesignAndCreation
16910 summary: update an existing service
16912 Update an existing service
16914 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16915 The PUT operation will entirely replace an existing object.
16916 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
16918 Other differences between PUT and PATCH are:
16920 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
16921 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16922 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16923 operationId: UpdateServiceDesignAndCreationServicesService
16932 description: Response codes found in [response codes](https://wiki.onap.org/).
16936 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16939 example: __SERVICE-ID__
16942 description: service object that needs to be created or updated.
16945 $ref: "#/patchDefinitions/service"
16948 - ServiceDesignAndCreation
16949 summary: delete an existing service
16950 description: delete an existing service
16951 operationId: deleteServiceDesignAndCreationServicesService
16960 description: Response codes found in [response codes](https://wiki.onap.org/).
16964 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16967 example: __SERVICE-ID__
16968 - name: resource-version
16970 description: resource-version for concurrency
16973 /service-design-and-creation/services:
16976 - ServiceDesignAndCreation
16977 summary: returns services
16978 description: returns services
16979 operationId: getServiceDesignAndCreationServices
16985 description: successful operation
16987 $ref: "#/getDefinitions/services"
16989 description: Response codes found in [response codes](https://wiki.onap.org/).
16990 /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
16993 - ServiceDesignAndCreation
16994 summary: see node definition for valid relationships
16995 operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
17004 description: Response codes found in [response codes](https://wiki.onap.org/).
17006 - name: service-type
17008 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17011 example: __SERVICE-TYPE__
17014 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
17017 example: __VNF-TYPE__
17020 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
17023 $ref: "#/definitions/relationship"
17026 - ServiceDesignAndCreation
17027 summary: delete an existing relationship
17028 description: delete an existing relationship
17029 operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
17038 description: Response codes found in [response codes](https://wiki.onap.org/).
17040 - name: service-type
17042 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17045 example: __SERVICE-TYPE__
17048 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
17051 example: __VNF-TYPE__
17052 /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
17055 - ServiceDesignAndCreation
17056 summary: returns service-capability
17057 description: returns service-capability
17058 operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability
17064 description: successful operation
17066 $ref: "#/getDefinitions/service-capability"
17068 description: Response codes found in [response codes](https://wiki.onap.org/).
17070 - name: service-type
17072 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17075 example: __SERVICE-TYPE__
17078 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
17081 example: __VNF-TYPE__
17084 - ServiceDesignAndCreation
17085 summary: create or update an existing service-capability
17087 Create or update an existing service-capability.
17089 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17090 operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
17099 description: Response codes found in [response codes](https://wiki.onap.org/).
17101 - name: service-type
17103 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17106 example: __SERVICE-TYPE__
17109 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
17112 example: __VNF-TYPE__
17115 description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
17118 $ref: "#/definitions/service-capability"
17121 - ServiceDesignAndCreation
17122 summary: update an existing service-capability
17124 Update an existing service-capability
17126 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17127 The PUT operation will entirely replace an existing object.
17128 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17130 Other differences between PUT and PATCH are:
17132 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17133 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17134 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17135 operationId: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
17144 description: Response codes found in [response codes](https://wiki.onap.org/).
17146 - name: service-type
17148 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17151 example: __SERVICE-TYPE__
17154 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
17157 example: __VNF-TYPE__
17160 description: service-capability object that needs to be created or updated.
17163 $ref: "#/patchDefinitions/service-capability"
17166 - ServiceDesignAndCreation
17167 summary: delete an existing service-capability
17168 description: delete an existing service-capability
17169 operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
17178 description: Response codes found in [response codes](https://wiki.onap.org/).
17180 - name: service-type
17182 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17185 example: __SERVICE-TYPE__
17188 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
17191 example: __VNF-TYPE__
17192 - name: resource-version
17194 description: resource-version for concurrency
17197 /service-design-and-creation/service-capabilities:
17200 - ServiceDesignAndCreation
17201 summary: returns service-capabilities
17202 description: returns service-capabilities
17203 operationId: getServiceDesignAndCreationServiceCapabilities
17209 description: successful operation
17211 $ref: "#/getDefinitions/service-capabilities"
17213 description: Response codes found in [response codes](https://wiki.onap.org/).
17214 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship:
17217 - ServiceDesignAndCreation
17218 summary: see node definition for valid relationships
17219 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
17228 description: Response codes found in [response codes](https://wiki.onap.org/).
17230 - name: model-invariant-id
17232 description: Unique identifier corresponding to the main definition of a model in ASDC
17235 example: __MODEL-INVARIANT-ID__
17236 - name: model-version-id
17238 description: Unique identifier corresponding to one version of a model in ASDC
17241 example: __MODEL-VERSION-ID__
17242 - name: model-element-uuid
17246 example: __MODEL-ELEMENT-UUID__
17247 - name: model-constraint-uuid
17251 example: __MODEL-CONSTRAINT-UUID__
17252 - name: constrained-element-set-uuid
17256 example: __CONSTRAINED-ELEMENT-SET-UUID__
17257 - name: element-choice-set-uuid
17261 example: __ELEMENT-CHOICE-SET-UUID__
17264 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
17267 $ref: "#/definitions/relationship"
17270 - ServiceDesignAndCreation
17271 summary: delete an existing relationship
17272 description: delete an existing relationship
17273 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
17282 description: Response codes found in [response codes](https://wiki.onap.org/).
17284 - name: model-invariant-id
17286 description: Unique identifier corresponding to the main definition of a model in ASDC
17289 example: __MODEL-INVARIANT-ID__
17290 - name: model-version-id
17292 description: Unique identifier corresponding to one version of a model in ASDC
17295 example: __MODEL-VERSION-ID__
17296 - name: model-element-uuid
17300 example: __MODEL-ELEMENT-UUID__
17301 - name: model-constraint-uuid
17305 example: __MODEL-CONSTRAINT-UUID__
17306 - name: constrained-element-set-uuid
17310 example: __CONSTRAINED-ELEMENT-SET-UUID__
17311 - name: element-choice-set-uuid
17315 example: __ELEMENT-CHOICE-SET-UUID__
17316 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}:
17319 - ServiceDesignAndCreation
17320 summary: returns element-choice-set
17321 description: returns element-choice-set
17322 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
17328 description: successful operation
17330 $ref: "#/getDefinitions/element-choice-set"
17332 description: Response codes found in [response codes](https://wiki.onap.org/).
17334 - name: model-invariant-id
17336 description: Unique identifier corresponding to the main definition of a model in ASDC
17339 example: __MODEL-INVARIANT-ID__
17340 - name: model-version-id
17342 description: Unique identifier corresponding to one version of a model in ASDC
17345 example: __MODEL-VERSION-ID__
17346 - name: model-element-uuid
17350 example: __MODEL-ELEMENT-UUID__
17351 - name: model-constraint-uuid
17355 example: __MODEL-CONSTRAINT-UUID__
17356 - name: constrained-element-set-uuid
17360 example: __CONSTRAINED-ELEMENT-SET-UUID__
17361 - name: element-choice-set-uuid
17365 example: __ELEMENT-CHOICE-SET-UUID__
17368 description: Type of the model, e.g., service, resource, widget, etc.
17373 description: Name of the model, which can change from version to version.
17376 - name: model-version
17378 description: Version
17383 - ServiceDesignAndCreation
17384 summary: create or update an existing element-choice-set
17386 Create or update an existing element-choice-set.
17388 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17389 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
17398 description: Response codes found in [response codes](https://wiki.onap.org/).
17400 - name: model-invariant-id
17402 description: Unique identifier corresponding to the main definition of a model in ASDC
17405 example: __MODEL-INVARIANT-ID__
17406 - name: model-version-id
17408 description: Unique identifier corresponding to one version of a model in ASDC
17411 example: __MODEL-VERSION-ID__
17412 - name: model-element-uuid
17416 example: __MODEL-ELEMENT-UUID__
17417 - name: model-constraint-uuid
17421 example: __MODEL-CONSTRAINT-UUID__
17422 - name: constrained-element-set-uuid
17426 example: __CONSTRAINED-ELEMENT-SET-UUID__
17427 - name: element-choice-set-uuid
17431 example: __ELEMENT-CHOICE-SET-UUID__
17434 description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
17437 $ref: "#/definitions/element-choice-set"
17440 - ServiceDesignAndCreation
17441 summary: update an existing element-choice-set
17443 Update an existing element-choice-set
17445 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17446 The PUT operation will entirely replace an existing object.
17447 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17449 Other differences between PUT and PATCH are:
17451 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17452 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17453 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17454 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
17463 description: Response codes found in [response codes](https://wiki.onap.org/).
17465 - name: model-invariant-id
17467 description: Unique identifier corresponding to the main definition of a model in ASDC
17470 example: __MODEL-INVARIANT-ID__
17471 - name: model-version-id
17473 description: Unique identifier corresponding to one version of a model in ASDC
17476 example: __MODEL-VERSION-ID__
17477 - name: model-element-uuid
17481 example: __MODEL-ELEMENT-UUID__
17482 - name: model-constraint-uuid
17486 example: __MODEL-CONSTRAINT-UUID__
17487 - name: constrained-element-set-uuid
17491 example: __CONSTRAINED-ELEMENT-SET-UUID__
17492 - name: element-choice-set-uuid
17496 example: __ELEMENT-CHOICE-SET-UUID__
17499 description: element-choice-set object that needs to be created or updated.
17502 $ref: "#/patchDefinitions/element-choice-set"
17505 - ServiceDesignAndCreation
17506 summary: delete an existing element-choice-set
17507 description: delete an existing element-choice-set
17508 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
17517 description: Response codes found in [response codes](https://wiki.onap.org/).
17519 - name: model-invariant-id
17521 description: Unique identifier corresponding to the main definition of a model in ASDC
17524 example: __MODEL-INVARIANT-ID__
17525 - name: model-version-id
17527 description: Unique identifier corresponding to one version of a model in ASDC
17530 example: __MODEL-VERSION-ID__
17531 - name: model-element-uuid
17535 example: __MODEL-ELEMENT-UUID__
17536 - name: model-constraint-uuid
17540 example: __MODEL-CONSTRAINT-UUID__
17541 - name: constrained-element-set-uuid
17545 example: __CONSTRAINED-ELEMENT-SET-UUID__
17546 - name: element-choice-set-uuid
17550 example: __ELEMENT-CHOICE-SET-UUID__
17551 - name: resource-version
17553 description: resource-version for concurrency
17556 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets:
17559 - ServiceDesignAndCreation
17560 summary: returns element-choice-sets
17561 description: returns element-choice-sets
17562 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
17568 description: successful operation
17570 $ref: "#/getDefinitions/element-choice-sets"
17572 description: Response codes found in [response codes](https://wiki.onap.org/).
17574 - name: model-invariant-id
17576 description: Unique identifier corresponding to the main definition of a model in ASDC
17579 example: __MODEL-INVARIANT-ID__
17580 - name: model-version-id
17582 description: Unique identifier corresponding to one version of a model in ASDC
17585 example: __MODEL-VERSION-ID__
17586 - name: model-element-uuid
17590 example: __MODEL-ELEMENT-UUID__
17591 - name: model-constraint-uuid
17595 example: __MODEL-CONSTRAINT-UUID__
17596 - name: constrained-element-set-uuid
17600 example: __CONSTRAINED-ELEMENT-SET-UUID__
17603 description: Type of the model, e.g., service, resource, widget, etc.
17608 description: Name of the model, which can change from version to version.
17611 - name: model-version
17613 description: Version
17616 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship:
17619 - ServiceDesignAndCreation
17620 summary: see node definition for valid relationships
17621 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
17630 description: Response codes found in [response codes](https://wiki.onap.org/).
17632 - name: model-invariant-id
17634 description: Unique identifier corresponding to the main definition of a model in ASDC
17637 example: __MODEL-INVARIANT-ID__
17638 - name: model-version-id
17640 description: Unique identifier corresponding to one version of a model in ASDC
17643 example: __MODEL-VERSION-ID__
17644 - name: model-element-uuid
17648 example: __MODEL-ELEMENT-UUID__
17649 - name: model-constraint-uuid
17653 example: __MODEL-CONSTRAINT-UUID__
17654 - name: constrained-element-set-uuid
17658 example: __CONSTRAINED-ELEMENT-SET-UUID__
17661 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
17664 $ref: "#/definitions/relationship"
17667 - ServiceDesignAndCreation
17668 summary: delete an existing relationship
17669 description: delete an existing relationship
17670 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
17679 description: Response codes found in [response codes](https://wiki.onap.org/).
17681 - name: model-invariant-id
17683 description: Unique identifier corresponding to the main definition of a model in ASDC
17686 example: __MODEL-INVARIANT-ID__
17687 - name: model-version-id
17689 description: Unique identifier corresponding to one version of a model in ASDC
17692 example: __MODEL-VERSION-ID__
17693 - name: model-element-uuid
17697 example: __MODEL-ELEMENT-UUID__
17698 - name: model-constraint-uuid
17702 example: __MODEL-CONSTRAINT-UUID__
17703 - name: constrained-element-set-uuid
17707 example: __CONSTRAINED-ELEMENT-SET-UUID__
17708 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}:
17711 - ServiceDesignAndCreation
17712 summary: returns constrained-element-set
17713 description: returns constrained-element-set
17714 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
17720 description: successful operation
17722 $ref: "#/getDefinitions/constrained-element-set"
17724 description: Response codes found in [response codes](https://wiki.onap.org/).
17726 - name: model-invariant-id
17728 description: Unique identifier corresponding to the main definition of a model in ASDC
17731 example: __MODEL-INVARIANT-ID__
17732 - name: model-version-id
17734 description: Unique identifier corresponding to one version of a model in ASDC
17737 example: __MODEL-VERSION-ID__
17738 - name: model-element-uuid
17742 example: __MODEL-ELEMENT-UUID__
17743 - name: model-constraint-uuid
17747 example: __MODEL-CONSTRAINT-UUID__
17748 - name: constrained-element-set-uuid
17752 example: __CONSTRAINED-ELEMENT-SET-UUID__
17755 description: Type of the model, e.g., service, resource, widget, etc.
17760 description: Name of the model, which can change from version to version.
17763 - name: model-version
17765 description: Version
17770 - ServiceDesignAndCreation
17771 summary: create or update an existing constrained-element-set
17773 Create or update an existing constrained-element-set.
17775 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
17776 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
17785 description: Response codes found in [response codes](https://wiki.onap.org/).
17787 - name: model-invariant-id
17789 description: Unique identifier corresponding to the main definition of a model in ASDC
17792 example: __MODEL-INVARIANT-ID__
17793 - name: model-version-id
17795 description: Unique identifier corresponding to one version of a model in ASDC
17798 example: __MODEL-VERSION-ID__
17799 - name: model-element-uuid
17803 example: __MODEL-ELEMENT-UUID__
17804 - name: model-constraint-uuid
17808 example: __MODEL-CONSTRAINT-UUID__
17809 - name: constrained-element-set-uuid
17813 example: __CONSTRAINED-ELEMENT-SET-UUID__
17816 description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
17819 $ref: "#/definitions/constrained-element-set"
17822 - ServiceDesignAndCreation
17823 summary: update an existing constrained-element-set
17825 Update an existing constrained-element-set
17827 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17828 The PUT operation will entirely replace an existing object.
17829 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
17831 Other differences between PUT and PATCH are:
17833 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
17834 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17835 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17836 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
17845 description: Response codes found in [response codes](https://wiki.onap.org/).
17847 - name: model-invariant-id
17849 description: Unique identifier corresponding to the main definition of a model in ASDC
17852 example: __MODEL-INVARIANT-ID__
17853 - name: model-version-id
17855 description: Unique identifier corresponding to one version of a model in ASDC
17858 example: __MODEL-VERSION-ID__
17859 - name: model-element-uuid
17863 example: __MODEL-ELEMENT-UUID__
17864 - name: model-constraint-uuid
17868 example: __MODEL-CONSTRAINT-UUID__
17869 - name: constrained-element-set-uuid
17873 example: __CONSTRAINED-ELEMENT-SET-UUID__
17876 description: constrained-element-set object that needs to be created or updated.
17879 $ref: "#/patchDefinitions/constrained-element-set"
17882 - ServiceDesignAndCreation
17883 summary: delete an existing constrained-element-set
17884 description: delete an existing constrained-element-set
17885 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
17894 description: Response codes found in [response codes](https://wiki.onap.org/).
17896 - name: model-invariant-id
17898 description: Unique identifier corresponding to the main definition of a model in ASDC
17901 example: __MODEL-INVARIANT-ID__
17902 - name: model-version-id
17904 description: Unique identifier corresponding to one version of a model in ASDC
17907 example: __MODEL-VERSION-ID__
17908 - name: model-element-uuid
17912 example: __MODEL-ELEMENT-UUID__
17913 - name: model-constraint-uuid
17917 example: __MODEL-CONSTRAINT-UUID__
17918 - name: constrained-element-set-uuid
17922 example: __CONSTRAINED-ELEMENT-SET-UUID__
17923 - name: resource-version
17925 description: resource-version for concurrency
17928 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets:
17931 - ServiceDesignAndCreation
17932 summary: returns constrained-element-sets
17933 description: returns constrained-element-sets
17934 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
17940 description: successful operation
17942 $ref: "#/getDefinitions/constrained-element-sets"
17944 description: Response codes found in [response codes](https://wiki.onap.org/).
17946 - name: model-invariant-id
17948 description: Unique identifier corresponding to the main definition of a model in ASDC
17951 example: __MODEL-INVARIANT-ID__
17952 - name: model-version-id
17954 description: Unique identifier corresponding to one version of a model in ASDC
17957 example: __MODEL-VERSION-ID__
17958 - name: model-element-uuid
17962 example: __MODEL-ELEMENT-UUID__
17963 - name: model-constraint-uuid
17967 example: __MODEL-CONSTRAINT-UUID__
17970 description: Type of the model, e.g., service, resource, widget, etc.
17975 description: Name of the model, which can change from version to version.
17978 - name: model-version
17980 description: Version
17983 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}:
17986 - ServiceDesignAndCreation
17987 summary: returns model-constraint
17988 description: returns model-constraint
17989 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
17995 description: successful operation
17997 $ref: "#/getDefinitions/model-constraint"
17999 description: Response codes found in [response codes](https://wiki.onap.org/).
18001 - name: model-invariant-id
18003 description: Unique identifier corresponding to the main definition of a model in ASDC
18006 example: __MODEL-INVARIANT-ID__
18007 - name: model-version-id
18009 description: Unique identifier corresponding to one version of a model in ASDC
18012 example: __MODEL-VERSION-ID__
18013 - name: model-element-uuid
18017 example: __MODEL-ELEMENT-UUID__
18018 - name: model-constraint-uuid
18022 example: __MODEL-CONSTRAINT-UUID__
18025 description: Type of the model, e.g., service, resource, widget, etc.
18030 description: Name of the model, which can change from version to version.
18033 - name: model-version
18035 description: Version
18040 - ServiceDesignAndCreation
18041 summary: create or update an existing model-constraint
18043 Create or update an existing model-constraint.
18045 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18046 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
18055 description: Response codes found in [response codes](https://wiki.onap.org/).
18057 - name: model-invariant-id
18059 description: Unique identifier corresponding to the main definition of a model in ASDC
18062 example: __MODEL-INVARIANT-ID__
18063 - name: model-version-id
18065 description: Unique identifier corresponding to one version of a model in ASDC
18068 example: __MODEL-VERSION-ID__
18069 - name: model-element-uuid
18073 example: __MODEL-ELEMENT-UUID__
18074 - name: model-constraint-uuid
18078 example: __MODEL-CONSTRAINT-UUID__
18081 description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)
18084 $ref: "#/definitions/model-constraint"
18087 - ServiceDesignAndCreation
18088 summary: update an existing model-constraint
18090 Update an existing model-constraint
18092 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18093 The PUT operation will entirely replace an existing object.
18094 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18096 Other differences between PUT and PATCH are:
18098 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18099 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18100 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18101 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
18110 description: Response codes found in [response codes](https://wiki.onap.org/).
18112 - name: model-invariant-id
18114 description: Unique identifier corresponding to the main definition of a model in ASDC
18117 example: __MODEL-INVARIANT-ID__
18118 - name: model-version-id
18120 description: Unique identifier corresponding to one version of a model in ASDC
18123 example: __MODEL-VERSION-ID__
18124 - name: model-element-uuid
18128 example: __MODEL-ELEMENT-UUID__
18129 - name: model-constraint-uuid
18133 example: __MODEL-CONSTRAINT-UUID__
18136 description: model-constraint object that needs to be created or updated.
18139 $ref: "#/patchDefinitions/model-constraint"
18142 - ServiceDesignAndCreation
18143 summary: delete an existing model-constraint
18144 description: delete an existing model-constraint
18145 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
18154 description: Response codes found in [response codes](https://wiki.onap.org/).
18156 - name: model-invariant-id
18158 description: Unique identifier corresponding to the main definition of a model in ASDC
18161 example: __MODEL-INVARIANT-ID__
18162 - name: model-version-id
18164 description: Unique identifier corresponding to one version of a model in ASDC
18167 example: __MODEL-VERSION-ID__
18168 - name: model-element-uuid
18172 example: __MODEL-ELEMENT-UUID__
18173 - name: model-constraint-uuid
18177 example: __MODEL-CONSTRAINT-UUID__
18178 - name: resource-version
18180 description: resource-version for concurrency
18183 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints:
18186 - ServiceDesignAndCreation
18187 summary: returns model-constraints
18188 description: returns model-constraints
18189 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints
18195 description: successful operation
18197 $ref: "#/getDefinitions/model-constraints"
18199 description: Response codes found in [response codes](https://wiki.onap.org/).
18201 - name: model-invariant-id
18203 description: Unique identifier corresponding to the main definition of a model in ASDC
18206 example: __MODEL-INVARIANT-ID__
18207 - name: model-version-id
18209 description: Unique identifier corresponding to one version of a model in ASDC
18212 example: __MODEL-VERSION-ID__
18213 - name: model-element-uuid
18217 example: __MODEL-ELEMENT-UUID__
18220 description: Type of the model, e.g., service, resource, widget, etc.
18225 description: Name of the model, which can change from version to version.
18228 - name: model-version
18230 description: Version
18233 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship:
18236 - ServiceDesignAndCreation
18237 summary: see node definition for valid relationships
18238 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
18247 description: Response codes found in [response codes](https://wiki.onap.org/).
18249 - name: model-invariant-id
18251 description: Unique identifier corresponding to the main definition of a model in ASDC
18254 example: __MODEL-INVARIANT-ID__
18255 - name: model-version-id
18257 description: Unique identifier corresponding to one version of a model in ASDC
18260 example: __MODEL-VERSION-ID__
18261 - name: model-element-uuid
18265 example: __MODEL-ELEMENT-UUID__
18268 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
18271 $ref: "#/definitions/relationship"
18274 - ServiceDesignAndCreation
18275 summary: delete an existing relationship
18276 description: delete an existing relationship
18277 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
18286 description: Response codes found in [response codes](https://wiki.onap.org/).
18288 - name: model-invariant-id
18290 description: Unique identifier corresponding to the main definition of a model in ASDC
18293 example: __MODEL-INVARIANT-ID__
18294 - name: model-version-id
18296 description: Unique identifier corresponding to one version of a model in ASDC
18299 example: __MODEL-VERSION-ID__
18300 - name: model-element-uuid
18304 example: __MODEL-ELEMENT-UUID__
18305 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}:
18308 - ServiceDesignAndCreation
18309 summary: returns model-element
18310 description: returns model-element
18311 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
18317 description: successful operation
18319 $ref: "#/getDefinitions/model-element"
18321 description: Response codes found in [response codes](https://wiki.onap.org/).
18323 - name: model-invariant-id
18325 description: Unique identifier corresponding to the main definition of a model in ASDC
18328 example: __MODEL-INVARIANT-ID__
18329 - name: model-version-id
18331 description: Unique identifier corresponding to one version of a model in ASDC
18334 example: __MODEL-VERSION-ID__
18335 - name: model-element-uuid
18339 example: __MODEL-ELEMENT-UUID__
18342 description: Type of the model, e.g., service, resource, widget, etc.
18347 description: Name of the model, which can change from version to version.
18350 - name: model-version
18352 description: Version
18357 - ServiceDesignAndCreation
18358 summary: create or update an existing model-element
18360 Create or update an existing model-element.
18362 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18363 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
18372 description: Response codes found in [response codes](https://wiki.onap.org/).
18374 - name: model-invariant-id
18376 description: Unique identifier corresponding to the main definition of a model in ASDC
18379 example: __MODEL-INVARIANT-ID__
18380 - name: model-version-id
18382 description: Unique identifier corresponding to one version of a model in ASDC
18385 example: __MODEL-VERSION-ID__
18386 - name: model-element-uuid
18390 example: __MODEL-ELEMENT-UUID__
18393 description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
18396 $ref: "#/definitions/model-element"
18399 - ServiceDesignAndCreation
18400 summary: update an existing model-element
18402 Update an existing model-element
18404 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18405 The PUT operation will entirely replace an existing object.
18406 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18408 Other differences between PUT and PATCH are:
18410 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18411 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18412 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18413 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
18422 description: Response codes found in [response codes](https://wiki.onap.org/).
18424 - name: model-invariant-id
18426 description: Unique identifier corresponding to the main definition of a model in ASDC
18429 example: __MODEL-INVARIANT-ID__
18430 - name: model-version-id
18432 description: Unique identifier corresponding to one version of a model in ASDC
18435 example: __MODEL-VERSION-ID__
18436 - name: model-element-uuid
18440 example: __MODEL-ELEMENT-UUID__
18443 description: model-element object that needs to be created or updated.
18446 $ref: "#/patchDefinitions/model-element"
18449 - ServiceDesignAndCreation
18450 summary: delete an existing model-element
18451 description: delete an existing model-element
18452 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
18461 description: Response codes found in [response codes](https://wiki.onap.org/).
18463 - name: model-invariant-id
18465 description: Unique identifier corresponding to the main definition of a model in ASDC
18468 example: __MODEL-INVARIANT-ID__
18469 - name: model-version-id
18471 description: Unique identifier corresponding to one version of a model in ASDC
18474 example: __MODEL-VERSION-ID__
18475 - name: model-element-uuid
18479 example: __MODEL-ELEMENT-UUID__
18480 - name: resource-version
18482 description: resource-version for concurrency
18485 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements:
18488 - ServiceDesignAndCreation
18489 summary: returns model-elements
18490 description: returns model-elements
18491 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements
18497 description: successful operation
18499 $ref: "#/getDefinitions/model-elements"
18501 description: Response codes found in [response codes](https://wiki.onap.org/).
18503 - name: model-invariant-id
18505 description: Unique identifier corresponding to the main definition of a model in ASDC
18508 example: __MODEL-INVARIANT-ID__
18509 - name: model-version-id
18511 description: Unique identifier corresponding to one version of a model in ASDC
18514 example: __MODEL-VERSION-ID__
18517 description: Type of the model, e.g., service, resource, widget, etc.
18522 description: Name of the model, which can change from version to version.
18525 - name: model-version
18527 description: Version
18530 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}:
18533 - ServiceDesignAndCreation
18534 summary: returns metadatum
18535 description: returns metadatum
18536 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
18542 description: successful operation
18544 $ref: "#/getDefinitions/metadatum"
18546 description: Response codes found in [response codes](https://wiki.onap.org/).
18548 - name: model-invariant-id
18550 description: Unique identifier corresponding to the main definition of a model in ASDC
18553 example: __MODEL-INVARIANT-ID__
18554 - name: model-version-id
18556 description: Unique identifier corresponding to one version of a model in ASDC
18559 example: __MODEL-VERSION-ID__
18564 example: __METANAME__
18567 description: Type of the model, e.g., service, resource, widget, etc.
18572 description: Name of the model, which can change from version to version.
18575 - name: model-version
18577 description: Version
18582 - ServiceDesignAndCreation
18583 summary: create or update an existing metadatum
18585 Create or update an existing metadatum.
18587 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18588 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
18597 description: Response codes found in [response codes](https://wiki.onap.org/).
18599 - name: model-invariant-id
18601 description: Unique identifier corresponding to the main definition of a model in ASDC
18604 example: __MODEL-INVARIANT-ID__
18605 - name: model-version-id
18607 description: Unique identifier corresponding to one version of a model in ASDC
18610 example: __MODEL-VERSION-ID__
18615 example: __METANAME__
18618 description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json)
18621 $ref: "#/definitions/metadatum"
18624 - ServiceDesignAndCreation
18625 summary: update an existing metadatum
18627 Update an existing metadatum
18629 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18630 The PUT operation will entirely replace an existing object.
18631 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18633 Other differences between PUT and PATCH are:
18635 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18636 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18637 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18638 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
18647 description: Response codes found in [response codes](https://wiki.onap.org/).
18649 - name: model-invariant-id
18651 description: Unique identifier corresponding to the main definition of a model in ASDC
18654 example: __MODEL-INVARIANT-ID__
18655 - name: model-version-id
18657 description: Unique identifier corresponding to one version of a model in ASDC
18660 example: __MODEL-VERSION-ID__
18665 example: __METANAME__
18668 description: metadatum object that needs to be created or updated.
18671 $ref: "#/patchDefinitions/metadatum"
18674 - ServiceDesignAndCreation
18675 summary: delete an existing metadatum
18676 description: delete an existing metadatum
18677 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
18686 description: Response codes found in [response codes](https://wiki.onap.org/).
18688 - name: model-invariant-id
18690 description: Unique identifier corresponding to the main definition of a model in ASDC
18693 example: __MODEL-INVARIANT-ID__
18694 - name: model-version-id
18696 description: Unique identifier corresponding to one version of a model in ASDC
18699 example: __MODEL-VERSION-ID__
18704 example: __METANAME__
18705 - name: resource-version
18707 description: resource-version for concurrency
18710 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata:
18713 - ServiceDesignAndCreation
18714 summary: returns metadata
18715 description: returns metadata
18716 operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata
18722 description: successful operation
18724 $ref: "#/getDefinitions/metadata"
18726 description: Response codes found in [response codes](https://wiki.onap.org/).
18728 - name: model-invariant-id
18730 description: Unique identifier corresponding to the main definition of a model in ASDC
18733 example: __MODEL-INVARIANT-ID__
18734 - name: model-version-id
18736 description: Unique identifier corresponding to one version of a model in ASDC
18739 example: __MODEL-VERSION-ID__
18742 description: Type of the model, e.g., service, resource, widget, etc.
18747 description: Name of the model, which can change from version to version.
18750 - name: model-version
18752 description: Version
18755 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship:
18758 - ServiceDesignAndCreation
18759 summary: see node definition for valid relationships
18760 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
18769 description: Response codes found in [response codes](https://wiki.onap.org/).
18771 - name: model-invariant-id
18773 description: Unique identifier corresponding to the main definition of a model in ASDC
18776 example: __MODEL-INVARIANT-ID__
18777 - name: model-version-id
18779 description: Unique identifier corresponding to one version of a model in ASDC
18782 example: __MODEL-VERSION-ID__
18785 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
18788 $ref: "#/definitions/relationship"
18791 - ServiceDesignAndCreation
18792 summary: delete an existing relationship
18793 description: delete an existing relationship
18794 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
18803 description: Response codes found in [response codes](https://wiki.onap.org/).
18805 - name: model-invariant-id
18807 description: Unique identifier corresponding to the main definition of a model in ASDC
18810 example: __MODEL-INVARIANT-ID__
18811 - name: model-version-id
18813 description: Unique identifier corresponding to one version of a model in ASDC
18816 example: __MODEL-VERSION-ID__
18817 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}:
18820 - ServiceDesignAndCreation
18821 summary: returns model-ver
18822 description: returns model-ver
18823 operationId: getServiceDesignAndCreationModelsModelModelVersModelVer
18829 description: successful operation
18831 $ref: "#/getDefinitions/model-ver"
18833 description: Response codes found in [response codes](https://wiki.onap.org/).
18835 - name: model-invariant-id
18837 description: Unique identifier corresponding to the main definition of a model in ASDC
18840 example: __MODEL-INVARIANT-ID__
18841 - name: model-version-id
18843 description: Unique identifier corresponding to one version of a model in ASDC
18846 example: __MODEL-VERSION-ID__
18849 description: Type of the model, e.g., service, resource, widget, etc.
18854 description: Name of the model, which can change from version to version.
18857 - name: model-version
18859 description: Version
18864 - ServiceDesignAndCreation
18865 summary: create or update an existing model-ver
18867 Create or update an existing model-ver.
18869 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
18870 operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer
18879 description: Response codes found in [response codes](https://wiki.onap.org/).
18881 - name: model-invariant-id
18883 description: Unique identifier corresponding to the main definition of a model in ASDC
18886 example: __MODEL-INVARIANT-ID__
18887 - name: model-version-id
18889 description: Unique identifier corresponding to one version of a model in ASDC
18892 example: __MODEL-VERSION-ID__
18895 description: model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
18898 $ref: "#/definitions/model-ver"
18901 - ServiceDesignAndCreation
18902 summary: update an existing model-ver
18904 Update an existing model-ver
18906 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18907 The PUT operation will entirely replace an existing object.
18908 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
18910 Other differences between PUT and PATCH are:
18912 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
18913 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18914 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18915 operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVer
18924 description: Response codes found in [response codes](https://wiki.onap.org/).
18926 - name: model-invariant-id
18928 description: Unique identifier corresponding to the main definition of a model in ASDC
18931 example: __MODEL-INVARIANT-ID__
18932 - name: model-version-id
18934 description: Unique identifier corresponding to one version of a model in ASDC
18937 example: __MODEL-VERSION-ID__
18940 description: model-ver object that needs to be created or updated.
18943 $ref: "#/patchDefinitions/model-ver"
18946 - ServiceDesignAndCreation
18947 summary: delete an existing model-ver
18948 description: delete an existing model-ver
18949 operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVer
18958 description: Response codes found in [response codes](https://wiki.onap.org/).
18960 - name: model-invariant-id
18962 description: Unique identifier corresponding to the main definition of a model in ASDC
18965 example: __MODEL-INVARIANT-ID__
18966 - name: model-version-id
18968 description: Unique identifier corresponding to one version of a model in ASDC
18971 example: __MODEL-VERSION-ID__
18972 - name: resource-version
18974 description: resource-version for concurrency
18977 /service-design-and-creation/models/model/{model-invariant-id}/model-vers:
18980 - ServiceDesignAndCreation
18981 summary: returns model-vers
18982 description: returns model-vers
18983 operationId: getServiceDesignAndCreationModelsModelModelVers
18989 description: successful operation
18991 $ref: "#/getDefinitions/model-vers"
18993 description: Response codes found in [response codes](https://wiki.onap.org/).
18995 - name: model-invariant-id
18997 description: Unique identifier corresponding to the main definition of a model in ASDC
19000 example: __MODEL-INVARIANT-ID__
19003 description: Type of the model, e.g., service, resource, widget, etc.
19006 /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship:
19009 - ServiceDesignAndCreation
19010 summary: see node definition for valid relationships
19011 operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship
19020 description: Response codes found in [response codes](https://wiki.onap.org/).
19022 - name: model-invariant-id
19024 description: Unique identifier corresponding to the main definition of a model in ASDC
19027 example: __MODEL-INVARIANT-ID__
19030 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModel.json)
19033 $ref: "#/definitions/relationship"
19036 - ServiceDesignAndCreation
19037 summary: delete an existing relationship
19038 description: delete an existing relationship
19039 operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship
19048 description: Response codes found in [response codes](https://wiki.onap.org/).
19050 - name: model-invariant-id
19052 description: Unique identifier corresponding to the main definition of a model in ASDC
19055 example: __MODEL-INVARIANT-ID__
19056 /service-design-and-creation/models/model/{model-invariant-id}:
19059 - ServiceDesignAndCreation
19060 summary: returns model
19061 description: returns model
19062 operationId: getServiceDesignAndCreationModelsModel
19068 description: successful operation
19070 $ref: "#/getDefinitions/model"
19072 description: Response codes found in [response codes](https://wiki.onap.org/).
19074 - name: model-invariant-id
19076 description: Unique identifier corresponding to the main definition of a model in ASDC
19079 example: __MODEL-INVARIANT-ID__
19082 description: Type of the model, e.g., service, resource, widget, etc.
19087 - ServiceDesignAndCreation
19088 summary: create or update an existing model
19090 Create or update an existing model.
19092 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19093 operationId: createOrUpdateServiceDesignAndCreationModelsModel
19102 description: Response codes found in [response codes](https://wiki.onap.org/).
19104 - name: model-invariant-id
19106 description: Unique identifier corresponding to the main definition of a model in ASDC
19109 example: __MODEL-INVARIANT-ID__
19112 description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationModelsModel.json)
19115 $ref: "#/definitions/model"
19118 - ServiceDesignAndCreation
19119 summary: update an existing model
19121 Update an existing model
19123 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19124 The PUT operation will entirely replace an existing object.
19125 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19127 Other differences between PUT and PATCH are:
19129 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19130 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19131 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19132 operationId: UpdateServiceDesignAndCreationModelsModel
19141 description: Response codes found in [response codes](https://wiki.onap.org/).
19143 - name: model-invariant-id
19145 description: Unique identifier corresponding to the main definition of a model in ASDC
19148 example: __MODEL-INVARIANT-ID__
19151 description: model object that needs to be created or updated.
19154 $ref: "#/patchDefinitions/model"
19157 - ServiceDesignAndCreation
19158 summary: delete an existing model
19159 description: delete an existing model
19160 operationId: deleteServiceDesignAndCreationModelsModel
19169 description: Response codes found in [response codes](https://wiki.onap.org/).
19171 - name: model-invariant-id
19173 description: Unique identifier corresponding to the main definition of a model in ASDC
19176 example: __MODEL-INVARIANT-ID__
19177 - name: resource-version
19179 description: resource-version for concurrency
19182 /service-design-and-creation/models:
19185 - ServiceDesignAndCreation
19186 summary: returns models
19187 description: returns models
19188 operationId: getServiceDesignAndCreationModels
19194 description: successful operation
19196 $ref: "#/getDefinitions/models"
19198 description: Response codes found in [response codes](https://wiki.onap.org/).
19199 /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:
19202 - ServiceDesignAndCreation
19203 summary: see node definition for valid relationships
19204 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
19213 description: Response codes found in [response codes](https://wiki.onap.org/).
19215 - name: named-query-uuid
19219 example: __NAMED-QUERY-UUID__
19220 - name: named-query-element-uuid
19224 example: __NAMED-QUERY-ELEMENT-UUID__
19225 - name: related-lookup-uuid
19229 example: __RELATED-LOOKUP-UUID__
19232 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
19235 $ref: "#/definitions/relationship"
19238 - ServiceDesignAndCreation
19239 summary: delete an existing relationship
19240 description: delete an existing relationship
19241 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
19250 description: Response codes found in [response codes](https://wiki.onap.org/).
19252 - name: named-query-uuid
19256 example: __NAMED-QUERY-UUID__
19257 - name: named-query-element-uuid
19261 example: __NAMED-QUERY-ELEMENT-UUID__
19262 - name: related-lookup-uuid
19266 example: __RELATED-LOOKUP-UUID__
19267 /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}:
19270 - ServiceDesignAndCreation
19271 summary: returns related-lookup
19272 description: returns related-lookup
19273 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
19279 description: successful operation
19281 $ref: "#/getDefinitions/related-lookup"
19283 description: Response codes found in [response codes](https://wiki.onap.org/).
19285 - name: named-query-uuid
19289 example: __NAMED-QUERY-UUID__
19290 - name: named-query-element-uuid
19294 example: __NAMED-QUERY-ELEMENT-UUID__
19295 - name: related-lookup-uuid
19299 example: __RELATED-LOOKUP-UUID__
19300 - name: named-query-name
19306 - ServiceDesignAndCreation
19307 summary: create or update an existing related-lookup
19309 Create or update an existing related-lookup.
19311 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19312 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
19321 description: Response codes found in [response codes](https://wiki.onap.org/).
19323 - name: named-query-uuid
19327 example: __NAMED-QUERY-UUID__
19328 - name: named-query-element-uuid
19332 example: __NAMED-QUERY-ELEMENT-UUID__
19333 - name: related-lookup-uuid
19337 example: __RELATED-LOOKUP-UUID__
19340 description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
19343 $ref: "#/definitions/related-lookup"
19346 - ServiceDesignAndCreation
19347 summary: update an existing related-lookup
19349 Update an existing related-lookup
19351 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19352 The PUT operation will entirely replace an existing object.
19353 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19355 Other differences between PUT and PATCH are:
19357 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19358 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19359 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19360 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
19369 description: Response codes found in [response codes](https://wiki.onap.org/).
19371 - name: named-query-uuid
19375 example: __NAMED-QUERY-UUID__
19376 - name: named-query-element-uuid
19380 example: __NAMED-QUERY-ELEMENT-UUID__
19381 - name: related-lookup-uuid
19385 example: __RELATED-LOOKUP-UUID__
19388 description: related-lookup object that needs to be created or updated.
19391 $ref: "#/patchDefinitions/related-lookup"
19394 - ServiceDesignAndCreation
19395 summary: delete an existing related-lookup
19396 description: delete an existing related-lookup
19397 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
19406 description: Response codes found in [response codes](https://wiki.onap.org/).
19408 - name: named-query-uuid
19412 example: __NAMED-QUERY-UUID__
19413 - name: named-query-element-uuid
19417 example: __NAMED-QUERY-ELEMENT-UUID__
19418 - name: related-lookup-uuid
19422 example: __RELATED-LOOKUP-UUID__
19423 - name: resource-version
19425 description: resource-version for concurrency
19428 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups:
19431 - ServiceDesignAndCreation
19432 summary: returns related-lookups
19433 description: returns related-lookups
19434 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups
19440 description: successful operation
19442 $ref: "#/getDefinitions/related-lookups"
19444 description: Response codes found in [response codes](https://wiki.onap.org/).
19446 - name: named-query-uuid
19450 example: __NAMED-QUERY-UUID__
19451 - name: named-query-element-uuid
19455 example: __NAMED-QUERY-ELEMENT-UUID__
19456 - name: named-query-name
19460 /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}:
19463 - ServiceDesignAndCreation
19464 summary: returns property-constraint
19465 description: returns property-constraint
19466 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
19472 description: successful operation
19474 $ref: "#/getDefinitions/property-constraint"
19476 description: Response codes found in [response codes](https://wiki.onap.org/).
19478 - name: named-query-uuid
19482 example: __NAMED-QUERY-UUID__
19483 - name: named-query-element-uuid
19487 example: __NAMED-QUERY-ELEMENT-UUID__
19488 - name: property-constraint-uuid
19492 example: __PROPERTY-CONSTRAINT-UUID__
19493 - name: named-query-name
19499 - ServiceDesignAndCreation
19500 summary: create or update an existing property-constraint
19502 Create or update an existing property-constraint.
19504 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19505 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
19514 description: Response codes found in [response codes](https://wiki.onap.org/).
19516 - name: named-query-uuid
19520 example: __NAMED-QUERY-UUID__
19521 - name: named-query-element-uuid
19525 example: __NAMED-QUERY-ELEMENT-UUID__
19526 - name: property-constraint-uuid
19530 example: __PROPERTY-CONSTRAINT-UUID__
19533 description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)
19536 $ref: "#/definitions/property-constraint"
19539 - ServiceDesignAndCreation
19540 summary: update an existing property-constraint
19542 Update an existing property-constraint
19544 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19545 The PUT operation will entirely replace an existing object.
19546 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19548 Other differences between PUT and PATCH are:
19550 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19551 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19552 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19553 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
19562 description: Response codes found in [response codes](https://wiki.onap.org/).
19564 - name: named-query-uuid
19568 example: __NAMED-QUERY-UUID__
19569 - name: named-query-element-uuid
19573 example: __NAMED-QUERY-ELEMENT-UUID__
19574 - name: property-constraint-uuid
19578 example: __PROPERTY-CONSTRAINT-UUID__
19581 description: property-constraint object that needs to be created or updated.
19584 $ref: "#/patchDefinitions/property-constraint"
19587 - ServiceDesignAndCreation
19588 summary: delete an existing property-constraint
19589 description: delete an existing property-constraint
19590 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
19599 description: Response codes found in [response codes](https://wiki.onap.org/).
19601 - name: named-query-uuid
19605 example: __NAMED-QUERY-UUID__
19606 - name: named-query-element-uuid
19610 example: __NAMED-QUERY-ELEMENT-UUID__
19611 - name: property-constraint-uuid
19615 example: __PROPERTY-CONSTRAINT-UUID__
19616 - name: resource-version
19618 description: resource-version for concurrency
19621 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints:
19624 - ServiceDesignAndCreation
19625 summary: returns property-constraints
19626 description: returns property-constraints
19627 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints
19633 description: successful operation
19635 $ref: "#/getDefinitions/property-constraints"
19637 description: Response codes found in [response codes](https://wiki.onap.org/).
19639 - name: named-query-uuid
19643 example: __NAMED-QUERY-UUID__
19644 - name: named-query-element-uuid
19648 example: __NAMED-QUERY-ELEMENT-UUID__
19649 - name: named-query-name
19653 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship:
19656 - ServiceDesignAndCreation
19657 summary: see node definition for valid relationships
19658 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
19667 description: Response codes found in [response codes](https://wiki.onap.org/).
19669 - name: named-query-uuid
19673 example: __NAMED-QUERY-UUID__
19674 - name: named-query-element-uuid
19678 example: __NAMED-QUERY-ELEMENT-UUID__
19681 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
19684 $ref: "#/definitions/relationship"
19687 - ServiceDesignAndCreation
19688 summary: delete an existing relationship
19689 description: delete an existing relationship
19690 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
19699 description: Response codes found in [response codes](https://wiki.onap.org/).
19701 - name: named-query-uuid
19705 example: __NAMED-QUERY-UUID__
19706 - name: named-query-element-uuid
19710 example: __NAMED-QUERY-ELEMENT-UUID__
19711 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}:
19714 - ServiceDesignAndCreation
19715 summary: returns named-query-element
19716 description: returns named-query-element
19717 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
19723 description: successful operation
19725 $ref: "#/getDefinitions/named-query-element"
19727 description: Response codes found in [response codes](https://wiki.onap.org/).
19729 - name: named-query-uuid
19733 example: __NAMED-QUERY-UUID__
19734 - name: named-query-element-uuid
19738 example: __NAMED-QUERY-ELEMENT-UUID__
19739 - name: named-query-name
19745 - ServiceDesignAndCreation
19746 summary: create or update an existing named-query-element
19748 Create or update an existing named-query-element.
19750 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19751 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
19760 description: Response codes found in [response codes](https://wiki.onap.org/).
19762 - name: named-query-uuid
19766 example: __NAMED-QUERY-UUID__
19767 - name: named-query-element-uuid
19771 example: __NAMED-QUERY-ELEMENT-UUID__
19774 description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
19777 $ref: "#/definitions/named-query-element"
19780 - ServiceDesignAndCreation
19781 summary: update an existing named-query-element
19783 Update an existing named-query-element
19785 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19786 The PUT operation will entirely replace an existing object.
19787 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19789 Other differences between PUT and PATCH are:
19791 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19792 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19793 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19794 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
19803 description: Response codes found in [response codes](https://wiki.onap.org/).
19805 - name: named-query-uuid
19809 example: __NAMED-QUERY-UUID__
19810 - name: named-query-element-uuid
19814 example: __NAMED-QUERY-ELEMENT-UUID__
19817 description: named-query-element object that needs to be created or updated.
19820 $ref: "#/patchDefinitions/named-query-element"
19823 - ServiceDesignAndCreation
19824 summary: delete an existing named-query-element
19825 description: delete an existing named-query-element
19826 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
19835 description: Response codes found in [response codes](https://wiki.onap.org/).
19837 - name: named-query-uuid
19841 example: __NAMED-QUERY-UUID__
19842 - name: named-query-element-uuid
19846 example: __NAMED-QUERY-ELEMENT-UUID__
19847 - name: resource-version
19849 description: resource-version for concurrency
19852 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements:
19855 - ServiceDesignAndCreation
19856 summary: returns named-query-elements
19857 description: returns named-query-elements
19858 operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements
19864 description: successful operation
19866 $ref: "#/getDefinitions/named-query-elements"
19868 description: Response codes found in [response codes](https://wiki.onap.org/).
19870 - name: named-query-uuid
19874 example: __NAMED-QUERY-UUID__
19875 - name: named-query-name
19879 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship:
19882 - ServiceDesignAndCreation
19883 summary: see node definition for valid relationships
19884 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
19893 description: Response codes found in [response codes](https://wiki.onap.org/).
19895 - name: named-query-uuid
19899 example: __NAMED-QUERY-UUID__
19902 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
19905 $ref: "#/definitions/relationship"
19908 - ServiceDesignAndCreation
19909 summary: delete an existing relationship
19910 description: delete an existing relationship
19911 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
19920 description: Response codes found in [response codes](https://wiki.onap.org/).
19922 - name: named-query-uuid
19926 example: __NAMED-QUERY-UUID__
19927 /service-design-and-creation/named-queries/named-query/{named-query-uuid}:
19930 - ServiceDesignAndCreation
19931 summary: returns named-query
19932 description: returns named-query
19933 operationId: getServiceDesignAndCreationNamedQueriesNamedQuery
19939 description: successful operation
19941 $ref: "#/getDefinitions/named-query"
19943 description: Response codes found in [response codes](https://wiki.onap.org/).
19945 - name: named-query-uuid
19949 example: __NAMED-QUERY-UUID__
19950 - name: named-query-name
19956 - ServiceDesignAndCreation
19957 summary: create or update an existing named-query
19959 Create or update an existing named-query.
19961 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
19962 operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery
19971 description: Response codes found in [response codes](https://wiki.onap.org/).
19973 - name: named-query-uuid
19977 example: __NAMED-QUERY-UUID__
19980 description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
19983 $ref: "#/definitions/named-query"
19986 - ServiceDesignAndCreation
19987 summary: update an existing named-query
19989 Update an existing named-query
19991 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19992 The PUT operation will entirely replace an existing object.
19993 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
19995 Other differences between PUT and PATCH are:
19997 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
19998 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19999 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20000 operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQuery
20009 description: Response codes found in [response codes](https://wiki.onap.org/).
20011 - name: named-query-uuid
20015 example: __NAMED-QUERY-UUID__
20018 description: named-query object that needs to be created or updated.
20021 $ref: "#/patchDefinitions/named-query"
20024 - ServiceDesignAndCreation
20025 summary: delete an existing named-query
20026 description: delete an existing named-query
20027 operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery
20036 description: Response codes found in [response codes](https://wiki.onap.org/).
20038 - name: named-query-uuid
20042 example: __NAMED-QUERY-UUID__
20043 - name: resource-version
20045 description: resource-version for concurrency
20048 /service-design-and-creation/named-queries:
20051 - ServiceDesignAndCreation
20052 summary: returns named-queries
20053 description: returns named-queries
20054 operationId: getServiceDesignAndCreationNamedQueries
20060 description: successful operation
20062 $ref: "#/getDefinitions/named-queries"
20064 description: Response codes found in [response codes](https://wiki.onap.org/).
20065 /network/logical-links/logical-link/{link-name}/relationship-list/relationship:
20069 summary: see node definition for valid relationships
20070 operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship
20079 description: Response codes found in [response codes](https://wiki.onap.org/).
20083 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20086 example: __LINK-NAME__
20089 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkLogicalLinksLogicalLink.json)
20092 $ref: "#/definitions/relationship"
20096 summary: delete an existing relationship
20097 description: delete an existing relationship
20098 operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship
20107 description: Response codes found in [response codes](https://wiki.onap.org/).
20111 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20114 example: __LINK-NAME__
20115 /network/logical-links/logical-link/{link-name}:
20119 summary: returns logical-link
20120 description: returns logical-link
20121 operationId: getNetworkLogicalLinksLogicalLink
20127 description: successful operation
20129 $ref: "#/getDefinitions/logical-link"
20131 description: Response codes found in [response codes](https://wiki.onap.org/).
20135 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20138 example: __LINK-NAME__
20139 - name: persona-model-id
20141 description: the ASDC model id for this resource or service model.
20144 - name: persona-model-version
20146 description: the ASDC model version for this resource or service model.
20149 - name: widget-model-id
20151 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
20154 - name: widget-model-version
20156 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
20159 - name: prov-status
20161 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
20166 description: UUID of the logical-link, SDNC generates this.
20171 description: Circuit id
20176 description: Reason for this entity, role it is playing
20182 summary: create or update an existing logical-link
20184 Create or update an existing logical-link.
20186 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20187 operationId: createOrUpdateNetworkLogicalLinksLogicalLink
20196 description: Response codes found in [response codes](https://wiki.onap.org/).
20200 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20203 example: __LINK-NAME__
20206 description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkLogicalLinksLogicalLink.json)
20209 $ref: "#/definitions/logical-link"
20213 summary: update an existing logical-link
20215 Update an existing logical-link
20217 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20218 The PUT operation will entirely replace an existing object.
20219 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20221 Other differences between PUT and PATCH are:
20223 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20224 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20225 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20226 operationId: UpdateNetworkLogicalLinksLogicalLink
20235 description: Response codes found in [response codes](https://wiki.onap.org/).
20239 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20242 example: __LINK-NAME__
20245 description: logical-link object that needs to be created or updated.
20248 $ref: "#/patchDefinitions/logical-link"
20252 summary: delete an existing logical-link
20253 description: delete an existing logical-link
20254 operationId: deleteNetworkLogicalLinksLogicalLink
20263 description: Response codes found in [response codes](https://wiki.onap.org/).
20267 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20270 example: __LINK-NAME__
20271 - name: resource-version
20273 description: resource-version for concurrency
20276 /network/logical-links:
20280 summary: returns logical-links
20281 description: returns logical-links
20282 operationId: getNetworkLogicalLinks
20288 description: successful operation
20290 $ref: "#/getDefinitions/logical-links"
20292 description: Response codes found in [response codes](https://wiki.onap.org/).
20293 /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:
20297 summary: see node definition for valid relationships
20298 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
20307 description: Response codes found in [response codes](https://wiki.onap.org/).
20309 - name: site-pair-set-id
20311 description: Unique id of site pair set.
20314 example: __SITE-PAIR-SET-ID__
20315 - name: routing-instance-id
20317 description: Unique id of routing instance
20320 example: __ROUTING-INSTANCE-ID__
20321 - name: site-pair-id
20323 description: unique identifier of probe
20326 example: __SITE-PAIR-ID__
20329 description: unique identifier of probe
20335 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
20338 $ref: "#/definitions/relationship"
20342 summary: delete an existing relationship
20343 description: delete an existing relationship
20344 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
20353 description: Response codes found in [response codes](https://wiki.onap.org/).
20355 - name: site-pair-set-id
20357 description: Unique id of site pair set.
20360 example: __SITE-PAIR-SET-ID__
20361 - name: routing-instance-id
20363 description: Unique id of routing instance
20366 example: __ROUTING-INSTANCE-ID__
20367 - name: site-pair-id
20369 description: unique identifier of probe
20372 example: __SITE-PAIR-ID__
20375 description: unique identifier of probe
20379 /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}:
20383 summary: returns class-of-service
20384 description: returns class-of-service
20385 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
20391 description: successful operation
20393 $ref: "#/getDefinitions/class-of-service"
20395 description: Response codes found in [response codes](https://wiki.onap.org/).
20397 - name: site-pair-set-id
20399 description: Unique id of site pair set.
20402 example: __SITE-PAIR-SET-ID__
20403 - name: routing-instance-id
20405 description: Unique id of routing instance
20408 example: __ROUTING-INSTANCE-ID__
20409 - name: site-pair-id
20411 description: unique identifier of probe
20414 example: __SITE-PAIR-ID__
20417 description: unique identifier of probe
20424 summary: create or update an existing class-of-service
20426 Create or update an existing class-of-service.
20428 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20429 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
20438 description: Response codes found in [response codes](https://wiki.onap.org/).
20440 - name: site-pair-set-id
20442 description: Unique id of site pair set.
20445 example: __SITE-PAIR-SET-ID__
20446 - name: routing-instance-id
20448 description: Unique id of routing instance
20451 example: __ROUTING-INSTANCE-ID__
20452 - name: site-pair-id
20454 description: unique identifier of probe
20457 example: __SITE-PAIR-ID__
20460 description: unique identifier of probe
20466 description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
20469 $ref: "#/definitions/class-of-service"
20473 summary: update an existing class-of-service
20475 Update an existing class-of-service
20477 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20478 The PUT operation will entirely replace an existing object.
20479 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20481 Other differences between PUT and PATCH are:
20483 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20484 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20485 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20486 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
20495 description: Response codes found in [response codes](https://wiki.onap.org/).
20497 - name: site-pair-set-id
20499 description: Unique id of site pair set.
20502 example: __SITE-PAIR-SET-ID__
20503 - name: routing-instance-id
20505 description: Unique id of routing instance
20508 example: __ROUTING-INSTANCE-ID__
20509 - name: site-pair-id
20511 description: unique identifier of probe
20514 example: __SITE-PAIR-ID__
20517 description: unique identifier of probe
20523 description: class-of-service object that needs to be created or updated.
20526 $ref: "#/patchDefinitions/class-of-service"
20530 summary: delete an existing class-of-service
20531 description: delete an existing class-of-service
20532 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
20541 description: Response codes found in [response codes](https://wiki.onap.org/).
20543 - name: site-pair-set-id
20545 description: Unique id of site pair set.
20548 example: __SITE-PAIR-SET-ID__
20549 - name: routing-instance-id
20551 description: Unique id of routing instance
20554 example: __ROUTING-INSTANCE-ID__
20555 - name: site-pair-id
20557 description: unique identifier of probe
20560 example: __SITE-PAIR-ID__
20563 description: unique identifier of probe
20567 - name: resource-version
20569 description: resource-version for concurrency
20572 /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:
20576 summary: returns classes-of-service
20577 description: returns classes-of-service
20578 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService
20584 description: successful operation
20586 $ref: "#/getDefinitions/classes-of-service"
20588 description: Response codes found in [response codes](https://wiki.onap.org/).
20590 - name: site-pair-set-id
20592 description: Unique id of site pair set.
20595 example: __SITE-PAIR-SET-ID__
20596 - name: routing-instance-id
20598 description: Unique id of routing instance
20601 example: __ROUTING-INSTANCE-ID__
20602 - name: site-pair-id
20604 description: unique identifier of probe
20607 example: __SITE-PAIR-ID__
20608 /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:
20612 summary: see node definition for valid relationships
20613 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
20622 description: Response codes found in [response codes](https://wiki.onap.org/).
20624 - name: site-pair-set-id
20626 description: Unique id of site pair set.
20629 example: __SITE-PAIR-SET-ID__
20630 - name: routing-instance-id
20632 description: Unique id of routing instance
20635 example: __ROUTING-INSTANCE-ID__
20636 - name: site-pair-id
20638 description: unique identifier of probe
20641 example: __SITE-PAIR-ID__
20644 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
20647 $ref: "#/definitions/relationship"
20651 summary: delete an existing relationship
20652 description: delete an existing relationship
20653 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
20662 description: Response codes found in [response codes](https://wiki.onap.org/).
20664 - name: site-pair-set-id
20666 description: Unique id of site pair set.
20669 example: __SITE-PAIR-SET-ID__
20670 - name: routing-instance-id
20672 description: Unique id of routing instance
20675 example: __ROUTING-INSTANCE-ID__
20676 - name: site-pair-id
20678 description: unique identifier of probe
20681 example: __SITE-PAIR-ID__
20682 /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}:
20686 summary: returns site-pair
20687 description: returns site-pair
20688 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
20694 description: successful operation
20696 $ref: "#/getDefinitions/site-pair"
20698 description: Response codes found in [response codes](https://wiki.onap.org/).
20700 - name: site-pair-set-id
20702 description: Unique id of site pair set.
20705 example: __SITE-PAIR-SET-ID__
20706 - name: routing-instance-id
20708 description: Unique id of routing instance
20711 example: __ROUTING-INSTANCE-ID__
20712 - name: site-pair-id
20714 description: unique identifier of probe
20717 example: __SITE-PAIR-ID__
20721 summary: create or update an existing site-pair
20723 Create or update an existing site-pair.
20725 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20726 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
20735 description: Response codes found in [response codes](https://wiki.onap.org/).
20737 - name: site-pair-set-id
20739 description: Unique id of site pair set.
20742 example: __SITE-PAIR-SET-ID__
20743 - name: routing-instance-id
20745 description: Unique id of routing instance
20748 example: __ROUTING-INSTANCE-ID__
20749 - name: site-pair-id
20751 description: unique identifier of probe
20754 example: __SITE-PAIR-ID__
20757 description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
20760 $ref: "#/definitions/site-pair"
20764 summary: update an existing site-pair
20766 Update an existing site-pair
20768 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20769 The PUT operation will entirely replace an existing object.
20770 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
20772 Other differences between PUT and PATCH are:
20774 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
20775 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20776 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20777 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
20786 description: Response codes found in [response codes](https://wiki.onap.org/).
20788 - name: site-pair-set-id
20790 description: Unique id of site pair set.
20793 example: __SITE-PAIR-SET-ID__
20794 - name: routing-instance-id
20796 description: Unique id of routing instance
20799 example: __ROUTING-INSTANCE-ID__
20800 - name: site-pair-id
20802 description: unique identifier of probe
20805 example: __SITE-PAIR-ID__
20808 description: site-pair object that needs to be created or updated.
20811 $ref: "#/patchDefinitions/site-pair"
20815 summary: delete an existing site-pair
20816 description: delete an existing site-pair
20817 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
20826 description: Response codes found in [response codes](https://wiki.onap.org/).
20828 - name: site-pair-set-id
20830 description: Unique id of site pair set.
20833 example: __SITE-PAIR-SET-ID__
20834 - name: routing-instance-id
20836 description: Unique id of routing instance
20839 example: __ROUTING-INSTANCE-ID__
20840 - name: site-pair-id
20842 description: unique identifier of probe
20845 example: __SITE-PAIR-ID__
20846 - name: resource-version
20848 description: resource-version for concurrency
20851 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs:
20855 summary: returns site-pairs
20856 description: returns site-pairs
20857 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs
20863 description: successful operation
20865 $ref: "#/getDefinitions/site-pairs"
20867 description: Response codes found in [response codes](https://wiki.onap.org/).
20869 - name: site-pair-set-id
20871 description: Unique id of site pair set.
20874 example: __SITE-PAIR-SET-ID__
20875 - name: routing-instance-id
20877 description: Unique id of routing instance
20880 example: __ROUTING-INSTANCE-ID__
20881 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship:
20885 summary: see node definition for valid relationships
20886 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
20895 description: Response codes found in [response codes](https://wiki.onap.org/).
20897 - name: site-pair-set-id
20899 description: Unique id of site pair set.
20902 example: __SITE-PAIR-SET-ID__
20903 - name: routing-instance-id
20905 description: Unique id of routing instance
20908 example: __ROUTING-INSTANCE-ID__
20911 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
20914 $ref: "#/definitions/relationship"
20918 summary: delete an existing relationship
20919 description: delete an existing relationship
20920 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
20929 description: Response codes found in [response codes](https://wiki.onap.org/).
20931 - name: site-pair-set-id
20933 description: Unique id of site pair set.
20936 example: __SITE-PAIR-SET-ID__
20937 - name: routing-instance-id
20939 description: Unique id of routing instance
20942 example: __ROUTING-INSTANCE-ID__
20943 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}:
20947 summary: returns routing-instance
20948 description: returns routing-instance
20949 operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
20955 description: successful operation
20957 $ref: "#/getDefinitions/routing-instance"
20959 description: Response codes found in [response codes](https://wiki.onap.org/).
20961 - name: site-pair-set-id
20963 description: Unique id of site pair set.
20966 example: __SITE-PAIR-SET-ID__
20967 - name: routing-instance-id
20969 description: Unique id of routing instance
20972 example: __ROUTING-INSTANCE-ID__
20976 summary: create or update an existing routing-instance
20978 Create or update an existing routing-instance.
20980 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
20981 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
20990 description: Response codes found in [response codes](https://wiki.onap.org/).
20992 - name: site-pair-set-id
20994 description: Unique id of site pair set.
20997 example: __SITE-PAIR-SET-ID__
20998 - name: routing-instance-id
21000 description: Unique id of routing instance
21003 example: __ROUTING-INSTANCE-ID__
21006 description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
21009 $ref: "#/definitions/routing-instance"
21013 summary: update an existing routing-instance
21015 Update an existing routing-instance
21017 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21018 The PUT operation will entirely replace an existing object.
21019 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21021 Other differences between PUT and PATCH are:
21023 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21024 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21025 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21026 operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
21035 description: Response codes found in [response codes](https://wiki.onap.org/).
21037 - name: site-pair-set-id
21039 description: Unique id of site pair set.
21042 example: __SITE-PAIR-SET-ID__
21043 - name: routing-instance-id
21045 description: Unique id of routing instance
21048 example: __ROUTING-INSTANCE-ID__
21051 description: routing-instance object that needs to be created or updated.
21054 $ref: "#/patchDefinitions/routing-instance"
21058 summary: delete an existing routing-instance
21059 description: delete an existing routing-instance
21060 operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
21069 description: Response codes found in [response codes](https://wiki.onap.org/).
21071 - name: site-pair-set-id
21073 description: Unique id of site pair set.
21076 example: __SITE-PAIR-SET-ID__
21077 - name: routing-instance-id
21079 description: Unique id of routing instance
21082 example: __ROUTING-INSTANCE-ID__
21083 - name: resource-version
21085 description: resource-version for concurrency
21088 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances:
21092 summary: returns routing-instances
21093 description: returns routing-instances
21094 operationId: getNetworkSitePairSetsSitePairSetRoutingInstances
21100 description: successful operation
21102 $ref: "#/getDefinitions/routing-instances"
21104 description: Response codes found in [response codes](https://wiki.onap.org/).
21106 - name: site-pair-set-id
21108 description: Unique id of site pair set.
21111 example: __SITE-PAIR-SET-ID__
21112 /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship:
21116 summary: see node definition for valid relationships
21117 operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship
21126 description: Response codes found in [response codes](https://wiki.onap.org/).
21128 - name: site-pair-set-id
21130 description: Unique id of site pair set.
21133 example: __SITE-PAIR-SET-ID__
21136 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSet.json)
21139 $ref: "#/definitions/relationship"
21143 summary: delete an existing relationship
21144 description: delete an existing relationship
21145 operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship
21154 description: Response codes found in [response codes](https://wiki.onap.org/).
21156 - name: site-pair-set-id
21158 description: Unique id of site pair set.
21161 example: __SITE-PAIR-SET-ID__
21162 /network/site-pair-sets/site-pair-set/{site-pair-set-id}:
21166 summary: returns site-pair-set
21167 description: returns site-pair-set
21168 operationId: getNetworkSitePairSetsSitePairSet
21174 description: successful operation
21176 $ref: "#/getDefinitions/site-pair-set"
21178 description: Response codes found in [response codes](https://wiki.onap.org/).
21180 - name: site-pair-set-id
21182 description: Unique id of site pair set.
21185 example: __SITE-PAIR-SET-ID__
21189 summary: create or update an existing site-pair-set
21191 Create or update an existing site-pair-set.
21193 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21194 operationId: createOrUpdateNetworkSitePairSetsSitePairSet
21203 description: Response codes found in [response codes](https://wiki.onap.org/).
21205 - name: site-pair-set-id
21207 description: Unique id of site pair set.
21210 example: __SITE-PAIR-SET-ID__
21213 description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkSitePairSetsSitePairSet.json)
21216 $ref: "#/definitions/site-pair-set"
21220 summary: update an existing site-pair-set
21222 Update an existing site-pair-set
21224 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21225 The PUT operation will entirely replace an existing object.
21226 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21228 Other differences between PUT and PATCH are:
21230 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21231 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21232 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21233 operationId: UpdateNetworkSitePairSetsSitePairSet
21242 description: Response codes found in [response codes](https://wiki.onap.org/).
21244 - name: site-pair-set-id
21246 description: Unique id of site pair set.
21249 example: __SITE-PAIR-SET-ID__
21252 description: site-pair-set object that needs to be created or updated.
21255 $ref: "#/patchDefinitions/site-pair-set"
21259 summary: delete an existing site-pair-set
21260 description: delete an existing site-pair-set
21261 operationId: deleteNetworkSitePairSetsSitePairSet
21270 description: Response codes found in [response codes](https://wiki.onap.org/).
21272 - name: site-pair-set-id
21274 description: Unique id of site pair set.
21277 example: __SITE-PAIR-SET-ID__
21278 - name: resource-version
21280 description: resource-version for concurrency
21283 /network/site-pair-sets:
21287 summary: returns site-pair-sets
21288 description: returns site-pair-sets
21289 operationId: getNetworkSitePairSets
21295 description: successful operation
21297 $ref: "#/getDefinitions/site-pair-sets"
21299 description: Response codes found in [response codes](https://wiki.onap.org/).
21300 /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship:
21304 summary: see node definition for valid relationships
21305 operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship
21314 description: Response codes found in [response codes](https://wiki.onap.org/).
21318 description: VPN ID, globally unique within A&AI
21321 example: __VPN-ID__
21324 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVpnBindingsVpnBinding.json)
21327 $ref: "#/definitions/relationship"
21331 summary: delete an existing relationship
21332 description: delete an existing relationship
21333 operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship
21342 description: Response codes found in [response codes](https://wiki.onap.org/).
21346 description: VPN ID, globally unique within A&AI
21349 example: __VPN-ID__
21350 /network/vpn-bindings/vpn-binding/{vpn-id}:
21354 summary: returns vpn-binding
21355 description: returns vpn-binding
21356 operationId: getNetworkVpnBindingsVpnBinding
21362 description: successful operation
21364 $ref: "#/getDefinitions/vpn-binding"
21366 description: Response codes found in [response codes](https://wiki.onap.org/).
21370 description: VPN ID, globally unique within A&AI
21373 example: __VPN-ID__
21376 description: VPN Name
21379 - name: global-route-target
21381 description: Number used to identify a VPN, globally unique in the network
21386 description: Type of the vpn, should be taken from enumerated/valid values
21392 summary: create or update an existing vpn-binding
21394 Create or update an existing vpn-binding.
21396 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21397 operationId: createOrUpdateNetworkVpnBindingsVpnBinding
21406 description: Response codes found in [response codes](https://wiki.onap.org/).
21410 description: VPN ID, globally unique within A&AI
21413 example: __VPN-ID__
21416 description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVpnBindingsVpnBinding.json)
21419 $ref: "#/definitions/vpn-binding"
21423 summary: update an existing vpn-binding
21425 Update an existing vpn-binding
21427 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21428 The PUT operation will entirely replace an existing object.
21429 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21431 Other differences between PUT and PATCH are:
21433 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21434 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21435 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21436 operationId: UpdateNetworkVpnBindingsVpnBinding
21445 description: Response codes found in [response codes](https://wiki.onap.org/).
21449 description: VPN ID, globally unique within A&AI
21452 example: __VPN-ID__
21455 description: vpn-binding object that needs to be created or updated.
21458 $ref: "#/patchDefinitions/vpn-binding"
21462 summary: delete an existing vpn-binding
21463 description: delete an existing vpn-binding
21464 operationId: deleteNetworkVpnBindingsVpnBinding
21473 description: Response codes found in [response codes](https://wiki.onap.org/).
21477 description: VPN ID, globally unique within A&AI
21480 example: __VPN-ID__
21481 - name: resource-version
21483 description: resource-version for concurrency
21486 /network/vpn-bindings:
21490 summary: returns vpn-bindings
21491 description: returns vpn-bindings
21492 operationId: getNetworkVpnBindings
21498 description: successful operation
21500 $ref: "#/getDefinitions/vpn-bindings"
21502 description: Response codes found in [response codes](https://wiki.onap.org/).
21503 /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
21507 summary: see node definition for valid relationships
21508 operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship
21517 description: Response codes found in [response codes](https://wiki.onap.org/).
21519 - name: equipment-name
21523 example: __EQUIPMENT-NAME__
21526 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPe.json)
21529 $ref: "#/definitions/relationship"
21533 summary: delete an existing relationship
21534 description: delete an existing relationship
21535 operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship
21544 description: Response codes found in [response codes](https://wiki.onap.org/).
21546 - name: equipment-name
21550 example: __EQUIPMENT-NAME__
21551 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
21555 summary: see node definition for valid relationships
21556 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
21565 description: Response codes found in [response codes](https://wiki.onap.org/).
21567 - name: equipment-name
21571 example: __EQUIPMENT-NAME__
21572 - name: interface-name
21574 description: Name that identifies the physical interface
21577 example: __INTERFACE-NAME__
21580 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterface.json)
21583 $ref: "#/definitions/relationship"
21587 summary: delete an existing relationship
21588 description: delete an existing relationship
21589 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
21598 description: Response codes found in [response codes](https://wiki.onap.org/).
21600 - name: equipment-name
21604 example: __EQUIPMENT-NAME__
21605 - name: interface-name
21607 description: Name that identifies the physical interface
21610 example: __INTERFACE-NAME__
21611 /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:
21615 summary: see node definition for valid relationships
21616 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
21625 description: Response codes found in [response codes](https://wiki.onap.org/).
21627 - name: equipment-name
21631 example: __EQUIPMENT-NAME__
21632 - name: interface-name
21634 description: Name that identifies the physical interface
21637 example: __INTERFACE-NAME__
21638 - name: interface-name
21640 description: Name given to the interface
21643 example: __INTERFACE-NAME__
21644 - name: vlan-interface
21646 description: String that identifies the interface
21649 example: __VLAN-INTERFACE__
21652 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
21655 $ref: "#/definitions/relationship"
21659 summary: delete an existing relationship
21660 description: delete an existing relationship
21661 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
21670 description: Response codes found in [response codes](https://wiki.onap.org/).
21672 - name: equipment-name
21676 example: __EQUIPMENT-NAME__
21677 - name: interface-name
21679 description: Name that identifies the physical interface
21682 example: __INTERFACE-NAME__
21683 - name: interface-name
21685 description: Name given to the interface
21688 example: __INTERFACE-NAME__
21689 - name: vlan-interface
21691 description: String that identifies the interface
21694 example: __VLAN-INTERFACE__
21695 /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:
21699 summary: see node definition for valid relationships
21700 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
21709 description: Response codes found in [response codes](https://wiki.onap.org/).
21711 - name: equipment-name
21715 example: __EQUIPMENT-NAME__
21716 - name: interface-name
21718 description: Name that identifies the physical interface
21721 example: __INTERFACE-NAME__
21722 - name: interface-name
21724 description: Name given to the interface
21727 example: __INTERFACE-NAME__
21728 - name: vlan-interface
21730 description: String that identifies the interface
21733 example: __VLAN-INTERFACE__
21734 - name: l3-interface-ipv4-address
21736 description: IP address
21739 example: __L3-INTERFACE-IPV4-ADDRESS__
21742 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
21745 $ref: "#/definitions/relationship"
21749 summary: delete an existing relationship
21750 description: delete an existing relationship
21751 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
21760 description: Response codes found in [response codes](https://wiki.onap.org/).
21762 - name: equipment-name
21766 example: __EQUIPMENT-NAME__
21767 - name: interface-name
21769 description: Name that identifies the physical interface
21772 example: __INTERFACE-NAME__
21773 - name: interface-name
21775 description: Name given to the interface
21778 example: __INTERFACE-NAME__
21779 - name: vlan-interface
21781 description: String that identifies the interface
21784 example: __VLAN-INTERFACE__
21785 - name: l3-interface-ipv4-address
21787 description: IP address
21790 example: __L3-INTERFACE-IPV4-ADDRESS__
21791 /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}:
21795 summary: returns l3-interface-ipv4-address-list
21796 description: returns l3-interface-ipv4-address-list
21797 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
21803 description: successful operation
21805 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
21807 description: Response codes found in [response codes](https://wiki.onap.org/).
21809 - name: equipment-name
21813 example: __EQUIPMENT-NAME__
21814 - name: interface-name
21816 description: Name that identifies the physical interface
21819 example: __INTERFACE-NAME__
21820 - name: interface-name
21822 description: Name given to the interface
21825 example: __INTERFACE-NAME__
21826 - name: vlan-interface
21828 description: String that identifies the interface
21831 example: __VLAN-INTERFACE__
21832 - name: l3-interface-ipv4-address
21834 description: IP address
21837 example: __L3-INTERFACE-IPV4-ADDRESS__
21838 - name: prov-status
21840 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
21843 - name: prov-status
21845 description: Trigger for operational monitoring of this resource by Service Assurance systems.
21848 - name: interface-id
21850 description: ID of interface
21855 description: MAC address for the interface
21858 - name: network-name
21860 description: Name of the network
21863 - name: vlan-id-inner
21865 description: Inner VLAN tag
21871 description: This indicates the customers VPN ID associated with this vlan
21874 - name: vlan-id-inner
21876 description: Inner VLAN tag
21880 - name: neutron-network-id
21882 description: Neutron network id of the interface that address belongs to
21885 - name: neutron-subnet-id
21887 description: Neutron id of subnet that address belongs to
21893 summary: create or update an existing l3-interface-ipv4-address-list
21895 Create or update an existing l3-interface-ipv4-address-list.
21897 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
21898 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
21907 description: Response codes found in [response codes](https://wiki.onap.org/).
21909 - name: equipment-name
21913 example: __EQUIPMENT-NAME__
21914 - name: interface-name
21916 description: Name that identifies the physical interface
21919 example: __INTERFACE-NAME__
21920 - name: interface-name
21922 description: Name given to the interface
21925 example: __INTERFACE-NAME__
21926 - name: vlan-interface
21928 description: String that identifies the interface
21931 example: __VLAN-INTERFACE__
21932 - name: l3-interface-ipv4-address
21934 description: IP address
21937 example: __L3-INTERFACE-IPV4-ADDRESS__
21940 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
21943 $ref: "#/definitions/l3-interface-ipv4-address-list"
21947 summary: update an existing l3-interface-ipv4-address-list
21949 Update an existing l3-interface-ipv4-address-list
21951 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21952 The PUT operation will entirely replace an existing object.
21953 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
21955 Other differences between PUT and PATCH are:
21957 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
21958 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21959 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21960 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
21969 description: Response codes found in [response codes](https://wiki.onap.org/).
21971 - name: equipment-name
21975 example: __EQUIPMENT-NAME__
21976 - name: interface-name
21978 description: Name that identifies the physical interface
21981 example: __INTERFACE-NAME__
21982 - name: interface-name
21984 description: Name given to the interface
21987 example: __INTERFACE-NAME__
21988 - name: vlan-interface
21990 description: String that identifies the interface
21993 example: __VLAN-INTERFACE__
21994 - name: l3-interface-ipv4-address
21996 description: IP address
21999 example: __L3-INTERFACE-IPV4-ADDRESS__
22002 description: l3-interface-ipv4-address-list object that needs to be created or updated.
22005 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
22009 summary: delete an existing l3-interface-ipv4-address-list
22010 description: delete an existing l3-interface-ipv4-address-list
22011 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22020 description: Response codes found in [response codes](https://wiki.onap.org/).
22022 - name: equipment-name
22026 example: __EQUIPMENT-NAME__
22027 - name: interface-name
22029 description: Name that identifies the physical interface
22032 example: __INTERFACE-NAME__
22033 - name: interface-name
22035 description: Name given to the interface
22038 example: __INTERFACE-NAME__
22039 - name: vlan-interface
22041 description: String that identifies the interface
22044 example: __VLAN-INTERFACE__
22045 - name: l3-interface-ipv4-address
22047 description: IP address
22050 example: __L3-INTERFACE-IPV4-ADDRESS__
22051 - name: resource-version
22053 description: resource-version for concurrency
22056 /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:
22060 summary: see node definition for valid relationships
22061 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
22070 description: Response codes found in [response codes](https://wiki.onap.org/).
22072 - name: equipment-name
22076 example: __EQUIPMENT-NAME__
22077 - name: interface-name
22079 description: Name that identifies the physical interface
22082 example: __INTERFACE-NAME__
22083 - name: interface-name
22085 description: Name given to the interface
22088 example: __INTERFACE-NAME__
22089 - name: vlan-interface
22091 description: String that identifies the interface
22094 example: __VLAN-INTERFACE__
22095 - name: l3-interface-ipv6-address
22097 description: IP address
22100 example: __L3-INTERFACE-IPV6-ADDRESS__
22103 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
22106 $ref: "#/definitions/relationship"
22110 summary: delete an existing relationship
22111 description: delete an existing relationship
22112 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
22121 description: Response codes found in [response codes](https://wiki.onap.org/).
22123 - name: equipment-name
22127 example: __EQUIPMENT-NAME__
22128 - name: interface-name
22130 description: Name that identifies the physical interface
22133 example: __INTERFACE-NAME__
22134 - name: interface-name
22136 description: Name given to the interface
22139 example: __INTERFACE-NAME__
22140 - name: vlan-interface
22142 description: String that identifies the interface
22145 example: __VLAN-INTERFACE__
22146 - name: l3-interface-ipv6-address
22148 description: IP address
22151 example: __L3-INTERFACE-IPV6-ADDRESS__
22152 /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}:
22156 summary: returns l3-interface-ipv6-address-list
22157 description: returns l3-interface-ipv6-address-list
22158 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22164 description: successful operation
22166 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
22168 description: Response codes found in [response codes](https://wiki.onap.org/).
22170 - name: equipment-name
22174 example: __EQUIPMENT-NAME__
22175 - name: interface-name
22177 description: Name that identifies the physical interface
22180 example: __INTERFACE-NAME__
22181 - name: interface-name
22183 description: Name given to the interface
22186 example: __INTERFACE-NAME__
22187 - name: vlan-interface
22189 description: String that identifies the interface
22192 example: __VLAN-INTERFACE__
22193 - name: l3-interface-ipv6-address
22195 description: IP address
22198 example: __L3-INTERFACE-IPV6-ADDRESS__
22199 - name: prov-status
22201 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22204 - name: prov-status
22206 description: Trigger for operational monitoring of this resource by Service Assurance systems.
22209 - name: interface-id
22211 description: ID of interface
22216 description: MAC address for the interface
22219 - name: network-name
22221 description: Name of the network
22224 - name: vlan-id-inner
22226 description: Inner VLAN tag
22232 description: This indicates the customers VPN ID associated with this vlan
22235 - name: vlan-id-inner
22237 description: Inner VLAN tag
22241 - name: neutron-network-id
22243 description: Neutron network id of the interface that address belongs to
22246 - name: neutron-subnet-id
22248 description: Neutron id of subnet that address belongs to
22254 summary: create or update an existing l3-interface-ipv6-address-list
22256 Create or update an existing l3-interface-ipv6-address-list.
22258 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22259 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22268 description: Response codes found in [response codes](https://wiki.onap.org/).
22270 - name: equipment-name
22274 example: __EQUIPMENT-NAME__
22275 - name: interface-name
22277 description: Name that identifies the physical interface
22280 example: __INTERFACE-NAME__
22281 - name: interface-name
22283 description: Name given to the interface
22286 example: __INTERFACE-NAME__
22287 - name: vlan-interface
22289 description: String that identifies the interface
22292 example: __VLAN-INTERFACE__
22293 - name: l3-interface-ipv6-address
22295 description: IP address
22298 example: __L3-INTERFACE-IPV6-ADDRESS__
22301 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
22304 $ref: "#/definitions/l3-interface-ipv6-address-list"
22308 summary: update an existing l3-interface-ipv6-address-list
22310 Update an existing l3-interface-ipv6-address-list
22312 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22313 The PUT operation will entirely replace an existing object.
22314 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22316 Other differences between PUT and PATCH are:
22318 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22319 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22320 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22321 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22330 description: Response codes found in [response codes](https://wiki.onap.org/).
22332 - name: equipment-name
22336 example: __EQUIPMENT-NAME__
22337 - name: interface-name
22339 description: Name that identifies the physical interface
22342 example: __INTERFACE-NAME__
22343 - name: interface-name
22345 description: Name given to the interface
22348 example: __INTERFACE-NAME__
22349 - name: vlan-interface
22351 description: String that identifies the interface
22354 example: __VLAN-INTERFACE__
22355 - name: l3-interface-ipv6-address
22357 description: IP address
22360 example: __L3-INTERFACE-IPV6-ADDRESS__
22363 description: l3-interface-ipv6-address-list object that needs to be created or updated.
22366 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
22370 summary: delete an existing l3-interface-ipv6-address-list
22371 description: delete an existing l3-interface-ipv6-address-list
22372 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22381 description: Response codes found in [response codes](https://wiki.onap.org/).
22383 - name: equipment-name
22387 example: __EQUIPMENT-NAME__
22388 - name: interface-name
22390 description: Name that identifies the physical interface
22393 example: __INTERFACE-NAME__
22394 - name: interface-name
22396 description: Name given to the interface
22399 example: __INTERFACE-NAME__
22400 - name: vlan-interface
22402 description: String that identifies the interface
22405 example: __VLAN-INTERFACE__
22406 - name: l3-interface-ipv6-address
22408 description: IP address
22411 example: __L3-INTERFACE-IPV6-ADDRESS__
22412 - name: resource-version
22414 description: resource-version for concurrency
22417 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
22421 summary: returns vlan
22422 description: returns vlan
22423 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
22429 description: successful operation
22431 $ref: "#/getDefinitions/vlan"
22433 description: Response codes found in [response codes](https://wiki.onap.org/).
22435 - name: equipment-name
22439 example: __EQUIPMENT-NAME__
22440 - name: interface-name
22442 description: Name that identifies the physical interface
22445 example: __INTERFACE-NAME__
22446 - name: interface-name
22448 description: Name given to the interface
22451 example: __INTERFACE-NAME__
22452 - name: vlan-interface
22454 description: String that identifies the interface
22457 example: __VLAN-INTERFACE__
22458 - name: prov-status
22460 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22463 - name: prov-status
22465 description: Trigger for operational monitoring of this resource by Service Assurance systems.
22468 - name: interface-id
22470 description: ID of interface
22475 description: MAC address for the interface
22478 - name: network-name
22480 description: Name of the network
22483 - name: vlan-id-inner
22485 description: Inner VLAN tag
22491 description: This indicates the customers VPN ID associated with this vlan
22497 summary: create or update an existing vlan
22499 Create or update an existing vlan.
22501 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22502 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
22511 description: Response codes found in [response codes](https://wiki.onap.org/).
22513 - name: equipment-name
22517 example: __EQUIPMENT-NAME__
22518 - name: interface-name
22520 description: Name that identifies the physical interface
22523 example: __INTERFACE-NAME__
22524 - name: interface-name
22526 description: Name given to the interface
22529 example: __INTERFACE-NAME__
22530 - name: vlan-interface
22532 description: String that identifies the interface
22535 example: __VLAN-INTERFACE__
22538 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
22541 $ref: "#/definitions/vlan"
22545 summary: update an existing vlan
22547 Update an existing vlan
22549 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22550 The PUT operation will entirely replace an existing object.
22551 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22553 Other differences between PUT and PATCH are:
22555 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22556 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22557 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22558 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
22567 description: Response codes found in [response codes](https://wiki.onap.org/).
22569 - name: equipment-name
22573 example: __EQUIPMENT-NAME__
22574 - name: interface-name
22576 description: Name that identifies the physical interface
22579 example: __INTERFACE-NAME__
22580 - name: interface-name
22582 description: Name given to the interface
22585 example: __INTERFACE-NAME__
22586 - name: vlan-interface
22588 description: String that identifies the interface
22591 example: __VLAN-INTERFACE__
22594 description: vlan object that needs to be created or updated.
22597 $ref: "#/patchDefinitions/vlan"
22601 summary: delete an existing vlan
22602 description: delete an existing vlan
22603 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
22612 description: Response codes found in [response codes](https://wiki.onap.org/).
22614 - name: equipment-name
22618 example: __EQUIPMENT-NAME__
22619 - name: interface-name
22621 description: Name that identifies the physical interface
22624 example: __INTERFACE-NAME__
22625 - name: interface-name
22627 description: Name given to the interface
22630 example: __INTERFACE-NAME__
22631 - name: vlan-interface
22633 description: String that identifies the interface
22636 example: __VLAN-INTERFACE__
22637 - name: resource-version
22639 description: resource-version for concurrency
22642 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
22646 summary: returns vlans
22647 description: returns vlans
22648 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans
22654 description: successful operation
22656 $ref: "#/getDefinitions/vlans"
22658 description: Response codes found in [response codes](https://wiki.onap.org/).
22660 - name: equipment-name
22664 example: __EQUIPMENT-NAME__
22665 - name: interface-name
22667 description: Name that identifies the physical interface
22670 example: __INTERFACE-NAME__
22671 - name: interface-name
22673 description: Name given to the interface
22676 example: __INTERFACE-NAME__
22677 - name: prov-status
22679 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22682 - name: prov-status
22684 description: Trigger for operational monitoring of this resource by Service Assurance systems.
22687 - name: interface-id
22689 description: ID of interface
22694 description: MAC address for the interface
22697 - name: network-name
22699 description: Name of the network
22702 /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:
22706 summary: see node definition for valid relationships
22707 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
22716 description: Response codes found in [response codes](https://wiki.onap.org/).
22718 - name: equipment-name
22722 example: __EQUIPMENT-NAME__
22723 - name: interface-name
22725 description: Name that identifies the physical interface
22728 example: __INTERFACE-NAME__
22729 - name: interface-name
22731 description: Name given to the interface
22734 example: __INTERFACE-NAME__
22737 description: PCI ID used to identify the sriov-vf
22740 example: __PCI-ID__
22743 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
22746 $ref: "#/definitions/relationship"
22750 summary: delete an existing relationship
22751 description: delete an existing relationship
22752 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
22761 description: Response codes found in [response codes](https://wiki.onap.org/).
22763 - name: equipment-name
22767 example: __EQUIPMENT-NAME__
22768 - name: interface-name
22770 description: Name that identifies the physical interface
22773 example: __INTERFACE-NAME__
22774 - name: interface-name
22776 description: Name given to the interface
22779 example: __INTERFACE-NAME__
22782 description: PCI ID used to identify the sriov-vf
22785 example: __PCI-ID__
22786 /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}:
22790 summary: returns sriov-vf
22791 description: returns sriov-vf
22792 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
22798 description: successful operation
22800 $ref: "#/getDefinitions/sriov-vf"
22802 description: Response codes found in [response codes](https://wiki.onap.org/).
22804 - name: equipment-name
22808 example: __EQUIPMENT-NAME__
22809 - name: interface-name
22811 description: Name that identifies the physical interface
22814 example: __INTERFACE-NAME__
22815 - name: interface-name
22817 description: Name given to the interface
22820 example: __INTERFACE-NAME__
22823 description: PCI ID used to identify the sriov-vf
22826 example: __PCI-ID__
22827 - name: prov-status
22829 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22832 - name: prov-status
22834 description: Trigger for operational monitoring of this resource by Service Assurance systems.
22837 - name: interface-id
22839 description: ID of interface
22844 description: MAC address for the interface
22847 - name: network-name
22849 description: Name of the network
22852 - name: vf-vlan-filter
22854 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
22857 - name: vf-mac-filter
22859 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
22862 - name: vf-vlan-strip
22864 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
22867 - name: neutron-network-id
22869 description: Neutron network id of the interface
22875 summary: create or update an existing sriov-vf
22877 Create or update an existing sriov-vf.
22879 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
22880 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
22889 description: Response codes found in [response codes](https://wiki.onap.org/).
22891 - name: equipment-name
22895 example: __EQUIPMENT-NAME__
22896 - name: interface-name
22898 description: Name that identifies the physical interface
22901 example: __INTERFACE-NAME__
22902 - name: interface-name
22904 description: Name given to the interface
22907 example: __INTERFACE-NAME__
22910 description: PCI ID used to identify the sriov-vf
22913 example: __PCI-ID__
22916 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
22919 $ref: "#/definitions/sriov-vf"
22923 summary: update an existing sriov-vf
22925 Update an existing sriov-vf
22927 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22928 The PUT operation will entirely replace an existing object.
22929 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
22931 Other differences between PUT and PATCH are:
22933 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
22934 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22935 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22936 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
22945 description: Response codes found in [response codes](https://wiki.onap.org/).
22947 - name: equipment-name
22951 example: __EQUIPMENT-NAME__
22952 - name: interface-name
22954 description: Name that identifies the physical interface
22957 example: __INTERFACE-NAME__
22958 - name: interface-name
22960 description: Name given to the interface
22963 example: __INTERFACE-NAME__
22966 description: PCI ID used to identify the sriov-vf
22969 example: __PCI-ID__
22972 description: sriov-vf object that needs to be created or updated.
22975 $ref: "#/patchDefinitions/sriov-vf"
22979 summary: delete an existing sriov-vf
22980 description: delete an existing sriov-vf
22981 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
22990 description: Response codes found in [response codes](https://wiki.onap.org/).
22992 - name: equipment-name
22996 example: __EQUIPMENT-NAME__
22997 - name: interface-name
22999 description: Name that identifies the physical interface
23002 example: __INTERFACE-NAME__
23003 - name: interface-name
23005 description: Name given to the interface
23008 example: __INTERFACE-NAME__
23011 description: PCI ID used to identify the sriov-vf
23014 example: __PCI-ID__
23015 - name: resource-version
23017 description: resource-version for concurrency
23020 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
23024 summary: returns sriov-vfs
23025 description: returns sriov-vfs
23026 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
23032 description: successful operation
23034 $ref: "#/getDefinitions/sriov-vfs"
23036 description: Response codes found in [response codes](https://wiki.onap.org/).
23038 - name: equipment-name
23042 example: __EQUIPMENT-NAME__
23043 - name: interface-name
23045 description: Name that identifies the physical interface
23048 example: __INTERFACE-NAME__
23049 - name: interface-name
23051 description: Name given to the interface
23054 example: __INTERFACE-NAME__
23055 - name: prov-status
23057 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
23060 - name: prov-status
23062 description: Trigger for operational monitoring of this resource by Service Assurance systems.
23065 - name: interface-id
23067 description: ID of interface
23072 description: MAC address for the interface
23075 - name: network-name
23077 description: Name of the network
23080 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
23084 summary: see node definition for valid relationships
23085 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
23094 description: Response codes found in [response codes](https://wiki.onap.org/).
23096 - name: equipment-name
23100 example: __EQUIPMENT-NAME__
23101 - name: interface-name
23103 description: Name that identifies the physical interface
23106 example: __INTERFACE-NAME__
23107 - name: interface-name
23109 description: Name given to the interface
23112 example: __INTERFACE-NAME__
23115 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
23118 $ref: "#/definitions/relationship"
23122 summary: delete an existing relationship
23123 description: delete an existing relationship
23124 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
23133 description: Response codes found in [response codes](https://wiki.onap.org/).
23135 - name: equipment-name
23139 example: __EQUIPMENT-NAME__
23140 - name: interface-name
23142 description: Name that identifies the physical interface
23145 example: __INTERFACE-NAME__
23146 - name: interface-name
23148 description: Name given to the interface
23151 example: __INTERFACE-NAME__
23152 /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:
23156 summary: see node definition for valid relationships
23157 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
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 physical interface
23178 example: __INTERFACE-NAME__
23179 - name: interface-name
23181 description: Name given to the interface
23184 example: __INTERFACE-NAME__
23185 - name: l3-interface-ipv4-address
23187 description: IP address
23190 example: __L3-INTERFACE-IPV4-ADDRESS__
23193 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
23196 $ref: "#/definitions/relationship"
23200 summary: delete an existing relationship
23201 description: delete an existing relationship
23202 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
23211 description: Response codes found in [response codes](https://wiki.onap.org/).
23213 - name: equipment-name
23217 example: __EQUIPMENT-NAME__
23218 - name: interface-name
23220 description: Name that identifies the physical interface
23223 example: __INTERFACE-NAME__
23224 - name: interface-name
23226 description: Name given to the interface
23229 example: __INTERFACE-NAME__
23230 - name: l3-interface-ipv4-address
23232 description: IP address
23235 example: __L3-INTERFACE-IPV4-ADDRESS__
23236 /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}:
23240 summary: returns l3-interface-ipv4-address-list
23241 description: returns l3-interface-ipv4-address-list
23242 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23248 description: successful operation
23250 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
23252 description: Response codes found in [response codes](https://wiki.onap.org/).
23254 - name: equipment-name
23258 example: __EQUIPMENT-NAME__
23259 - name: interface-name
23261 description: Name that identifies the physical interface
23264 example: __INTERFACE-NAME__
23265 - name: interface-name
23267 description: Name given to the interface
23270 example: __INTERFACE-NAME__
23271 - name: l3-interface-ipv4-address
23273 description: IP address
23276 example: __L3-INTERFACE-IPV4-ADDRESS__
23277 - name: prov-status
23279 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
23282 - name: prov-status
23284 description: Trigger for operational monitoring of this resource by Service Assurance systems.
23287 - name: interface-id
23289 description: ID of interface
23294 description: MAC address for the interface
23297 - name: network-name
23299 description: Name of the network
23302 - name: vlan-id-inner
23304 description: Inner VLAN tag
23308 - name: neutron-network-id
23310 description: Neutron network id of the interface that address belongs to
23313 - name: neutron-subnet-id
23315 description: Neutron id of subnet that address belongs to
23321 summary: create or update an existing l3-interface-ipv4-address-list
23323 Create or update an existing l3-interface-ipv4-address-list.
23325 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23326 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23335 description: Response codes found in [response codes](https://wiki.onap.org/).
23337 - name: equipment-name
23341 example: __EQUIPMENT-NAME__
23342 - name: interface-name
23344 description: Name that identifies the physical interface
23347 example: __INTERFACE-NAME__
23348 - name: interface-name
23350 description: Name given to the interface
23353 example: __INTERFACE-NAME__
23354 - name: l3-interface-ipv4-address
23356 description: IP address
23359 example: __L3-INTERFACE-IPV4-ADDRESS__
23362 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
23365 $ref: "#/definitions/l3-interface-ipv4-address-list"
23369 summary: update an existing l3-interface-ipv4-address-list
23371 Update an existing l3-interface-ipv4-address-list
23373 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23374 The PUT operation will entirely replace an existing object.
23375 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23377 Other differences between PUT and PATCH are:
23379 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23380 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23381 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23382 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23391 description: Response codes found in [response codes](https://wiki.onap.org/).
23393 - name: equipment-name
23397 example: __EQUIPMENT-NAME__
23398 - name: interface-name
23400 description: Name that identifies the physical interface
23403 example: __INTERFACE-NAME__
23404 - name: interface-name
23406 description: Name given to the interface
23409 example: __INTERFACE-NAME__
23410 - name: l3-interface-ipv4-address
23412 description: IP address
23415 example: __L3-INTERFACE-IPV4-ADDRESS__
23418 description: l3-interface-ipv4-address-list object that needs to be created or updated.
23421 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
23425 summary: delete an existing l3-interface-ipv4-address-list
23426 description: delete an existing l3-interface-ipv4-address-list
23427 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23436 description: Response codes found in [response codes](https://wiki.onap.org/).
23438 - name: equipment-name
23442 example: __EQUIPMENT-NAME__
23443 - name: interface-name
23445 description: Name that identifies the physical interface
23448 example: __INTERFACE-NAME__
23449 - name: interface-name
23451 description: Name given to the interface
23454 example: __INTERFACE-NAME__
23455 - name: l3-interface-ipv4-address
23457 description: IP address
23460 example: __L3-INTERFACE-IPV4-ADDRESS__
23461 - name: resource-version
23463 description: resource-version for concurrency
23466 /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:
23470 summary: see node definition for valid relationships
23471 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
23480 description: Response codes found in [response codes](https://wiki.onap.org/).
23482 - name: equipment-name
23486 example: __EQUIPMENT-NAME__
23487 - name: interface-name
23489 description: Name that identifies the physical interface
23492 example: __INTERFACE-NAME__
23493 - name: interface-name
23495 description: Name given to the interface
23498 example: __INTERFACE-NAME__
23499 - name: l3-interface-ipv6-address
23501 description: IP address
23504 example: __L3-INTERFACE-IPV6-ADDRESS__
23507 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
23510 $ref: "#/definitions/relationship"
23514 summary: delete an existing relationship
23515 description: delete an existing relationship
23516 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
23525 description: Response codes found in [response codes](https://wiki.onap.org/).
23527 - name: equipment-name
23531 example: __EQUIPMENT-NAME__
23532 - name: interface-name
23534 description: Name that identifies the physical interface
23537 example: __INTERFACE-NAME__
23538 - name: interface-name
23540 description: Name given to the interface
23543 example: __INTERFACE-NAME__
23544 - name: l3-interface-ipv6-address
23546 description: IP address
23549 example: __L3-INTERFACE-IPV6-ADDRESS__
23550 /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}:
23554 summary: returns l3-interface-ipv6-address-list
23555 description: returns l3-interface-ipv6-address-list
23556 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23562 description: successful operation
23564 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
23566 description: Response codes found in [response codes](https://wiki.onap.org/).
23568 - name: equipment-name
23572 example: __EQUIPMENT-NAME__
23573 - name: interface-name
23575 description: Name that identifies the physical interface
23578 example: __INTERFACE-NAME__
23579 - name: interface-name
23581 description: Name given to the interface
23584 example: __INTERFACE-NAME__
23585 - name: l3-interface-ipv6-address
23587 description: IP address
23590 example: __L3-INTERFACE-IPV6-ADDRESS__
23591 - name: prov-status
23593 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
23596 - name: prov-status
23598 description: Trigger for operational monitoring of this resource by Service Assurance systems.
23601 - name: interface-id
23603 description: ID of interface
23608 description: MAC address for the interface
23611 - name: network-name
23613 description: Name of the network
23616 - name: vlan-id-inner
23618 description: Inner VLAN tag
23622 - name: neutron-network-id
23624 description: Neutron network id of the interface that address belongs to
23627 - name: neutron-subnet-id
23629 description: Neutron id of subnet that address belongs to
23635 summary: create or update an existing l3-interface-ipv6-address-list
23637 Create or update an existing l3-interface-ipv6-address-list.
23639 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23640 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23649 description: Response codes found in [response codes](https://wiki.onap.org/).
23651 - name: equipment-name
23655 example: __EQUIPMENT-NAME__
23656 - name: interface-name
23658 description: Name that identifies the physical interface
23661 example: __INTERFACE-NAME__
23662 - name: interface-name
23664 description: Name given to the interface
23667 example: __INTERFACE-NAME__
23668 - name: l3-interface-ipv6-address
23670 description: IP address
23673 example: __L3-INTERFACE-IPV6-ADDRESS__
23676 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
23679 $ref: "#/definitions/l3-interface-ipv6-address-list"
23683 summary: update an existing l3-interface-ipv6-address-list
23685 Update an existing l3-interface-ipv6-address-list
23687 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23688 The PUT operation will entirely replace an existing object.
23689 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23691 Other differences between PUT and PATCH are:
23693 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23694 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23695 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23696 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23705 description: Response codes found in [response codes](https://wiki.onap.org/).
23707 - name: equipment-name
23711 example: __EQUIPMENT-NAME__
23712 - name: interface-name
23714 description: Name that identifies the physical interface
23717 example: __INTERFACE-NAME__
23718 - name: interface-name
23720 description: Name given to the interface
23723 example: __INTERFACE-NAME__
23724 - name: l3-interface-ipv6-address
23726 description: IP address
23729 example: __L3-INTERFACE-IPV6-ADDRESS__
23732 description: l3-interface-ipv6-address-list object that needs to be created or updated.
23735 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
23739 summary: delete an existing l3-interface-ipv6-address-list
23740 description: delete an existing l3-interface-ipv6-address-list
23741 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23750 description: Response codes found in [response codes](https://wiki.onap.org/).
23752 - name: equipment-name
23756 example: __EQUIPMENT-NAME__
23757 - name: interface-name
23759 description: Name that identifies the physical interface
23762 example: __INTERFACE-NAME__
23763 - name: interface-name
23765 description: Name given to the interface
23768 example: __INTERFACE-NAME__
23769 - name: l3-interface-ipv6-address
23771 description: IP address
23774 example: __L3-INTERFACE-IPV6-ADDRESS__
23775 - name: resource-version
23777 description: resource-version for concurrency
23780 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
23784 summary: returns l-interface
23785 description: returns l-interface
23786 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
23792 description: successful operation
23794 $ref: "#/getDefinitions/l-interface"
23796 description: Response codes found in [response codes](https://wiki.onap.org/).
23798 - name: equipment-name
23802 example: __EQUIPMENT-NAME__
23803 - name: interface-name
23805 description: Name that identifies the physical interface
23808 example: __INTERFACE-NAME__
23809 - name: interface-name
23811 description: Name given to the interface
23814 example: __INTERFACE-NAME__
23815 - name: prov-status
23817 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
23820 - name: prov-status
23822 description: Trigger for operational monitoring of this resource by Service Assurance systems.
23825 - name: interface-id
23827 description: ID of interface
23832 description: MAC address for the interface
23835 - name: network-name
23837 description: Name of the network
23843 summary: create or update an existing l-interface
23845 Create or update an existing l-interface.
23847 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
23848 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
23857 description: Response codes found in [response codes](https://wiki.onap.org/).
23859 - name: equipment-name
23863 example: __EQUIPMENT-NAME__
23864 - name: interface-name
23866 description: Name that identifies the physical interface
23869 example: __INTERFACE-NAME__
23870 - name: interface-name
23872 description: Name given to the interface
23875 example: __INTERFACE-NAME__
23878 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
23881 $ref: "#/definitions/l-interface"
23885 summary: update an existing l-interface
23887 Update an existing l-interface
23889 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23890 The PUT operation will entirely replace an existing object.
23891 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
23893 Other differences between PUT and PATCH are:
23895 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
23896 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23897 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23898 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
23907 description: Response codes found in [response codes](https://wiki.onap.org/).
23909 - name: equipment-name
23913 example: __EQUIPMENT-NAME__
23914 - name: interface-name
23916 description: Name that identifies the physical interface
23919 example: __INTERFACE-NAME__
23920 - name: interface-name
23922 description: Name given to the interface
23925 example: __INTERFACE-NAME__
23928 description: l-interface object that needs to be created or updated.
23931 $ref: "#/patchDefinitions/l-interface"
23935 summary: delete an existing l-interface
23936 description: delete an existing l-interface
23937 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
23946 description: Response codes found in [response codes](https://wiki.onap.org/).
23948 - name: equipment-name
23952 example: __EQUIPMENT-NAME__
23953 - name: interface-name
23955 description: Name that identifies the physical interface
23958 example: __INTERFACE-NAME__
23959 - name: interface-name
23961 description: Name given to the interface
23964 example: __INTERFACE-NAME__
23965 - name: resource-version
23967 description: resource-version for concurrency
23970 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
23974 summary: returns l-interfaces
23975 description: returns l-interfaces
23976 operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces
23982 description: successful operation
23984 $ref: "#/getDefinitions/l-interfaces"
23986 description: Response codes found in [response codes](https://wiki.onap.org/).
23988 - name: equipment-name
23992 example: __EQUIPMENT-NAME__
23993 - name: interface-name
23995 description: Name that identifies the physical interface
23998 example: __INTERFACE-NAME__
23999 - name: prov-status
24001 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24004 - name: prov-status
24006 description: Trigger for operational monitoring of this resource by Service Assurance systems.
24009 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}:
24013 summary: returns p-interface
24014 description: returns p-interface
24015 operationId: getNetworkVplsPesVplsPePInterfacesPInterface
24021 description: successful operation
24023 $ref: "#/getDefinitions/p-interface"
24025 description: Response codes found in [response codes](https://wiki.onap.org/).
24027 - name: equipment-name
24031 example: __EQUIPMENT-NAME__
24032 - name: interface-name
24034 description: Name that identifies the physical interface
24037 example: __INTERFACE-NAME__
24038 - name: prov-status
24040 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24043 - name: prov-status
24045 description: Trigger for operational monitoring of this resource by Service Assurance systems.
24051 summary: create or update an existing p-interface
24053 Create or update an existing p-interface.
24055 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24056 operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface
24065 description: Response codes found in [response codes](https://wiki.onap.org/).
24067 - name: equipment-name
24071 example: __EQUIPMENT-NAME__
24072 - name: interface-name
24074 description: Name that identifies the physical interface
24077 example: __INTERFACE-NAME__
24080 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPePInterfacesPInterface.json)
24083 $ref: "#/definitions/p-interface"
24087 summary: update an existing p-interface
24089 Update an existing p-interface
24091 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24092 The PUT operation will entirely replace an existing object.
24093 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24095 Other differences between PUT and PATCH are:
24097 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24098 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24099 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24100 operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterface
24109 description: Response codes found in [response codes](https://wiki.onap.org/).
24111 - name: equipment-name
24115 example: __EQUIPMENT-NAME__
24116 - name: interface-name
24118 description: Name that identifies the physical interface
24121 example: __INTERFACE-NAME__
24124 description: p-interface object that needs to be created or updated.
24127 $ref: "#/patchDefinitions/p-interface"
24131 summary: delete an existing p-interface
24132 description: delete an existing p-interface
24133 operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface
24142 description: Response codes found in [response codes](https://wiki.onap.org/).
24144 - name: equipment-name
24148 example: __EQUIPMENT-NAME__
24149 - name: interface-name
24151 description: Name that identifies the physical interface
24154 example: __INTERFACE-NAME__
24155 - name: resource-version
24157 description: resource-version for concurrency
24160 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces:
24164 summary: returns p-interfaces
24165 description: returns p-interfaces
24166 operationId: getNetworkVplsPesVplsPePInterfaces
24172 description: successful operation
24174 $ref: "#/getDefinitions/p-interfaces"
24176 description: Response codes found in [response codes](https://wiki.onap.org/).
24178 - name: equipment-name
24182 example: __EQUIPMENT-NAME__
24183 - name: prov-status
24185 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24188 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
24192 summary: see node definition for valid relationships
24193 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
24202 description: Response codes found in [response codes](https://wiki.onap.org/).
24204 - name: equipment-name
24208 example: __EQUIPMENT-NAME__
24209 - name: interface-name
24211 description: Name that identifies the link aggregate interface
24214 example: __INTERFACE-NAME__
24217 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
24220 $ref: "#/definitions/relationship"
24224 summary: delete an existing relationship
24225 description: delete an existing relationship
24226 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
24235 description: Response codes found in [response codes](https://wiki.onap.org/).
24237 - name: equipment-name
24241 example: __EQUIPMENT-NAME__
24242 - name: interface-name
24244 description: Name that identifies the link aggregate interface
24247 example: __INTERFACE-NAME__
24248 /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:
24252 summary: see node definition for valid relationships
24253 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
24262 description: Response codes found in [response codes](https://wiki.onap.org/).
24264 - name: equipment-name
24268 example: __EQUIPMENT-NAME__
24269 - name: interface-name
24271 description: Name that identifies the link aggregate interface
24274 example: __INTERFACE-NAME__
24275 - name: interface-name
24277 description: Name given to the interface
24280 example: __INTERFACE-NAME__
24281 - name: vlan-interface
24283 description: String that identifies the interface
24286 example: __VLAN-INTERFACE__
24289 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
24292 $ref: "#/definitions/relationship"
24296 summary: delete an existing relationship
24297 description: delete an existing relationship
24298 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
24307 description: Response codes found in [response codes](https://wiki.onap.org/).
24309 - name: equipment-name
24313 example: __EQUIPMENT-NAME__
24314 - name: interface-name
24316 description: Name that identifies the link aggregate interface
24319 example: __INTERFACE-NAME__
24320 - name: interface-name
24322 description: Name given to the interface
24325 example: __INTERFACE-NAME__
24326 - name: vlan-interface
24328 description: String that identifies the interface
24331 example: __VLAN-INTERFACE__
24332 /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:
24336 summary: see node definition for valid relationships
24337 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
24346 description: Response codes found in [response codes](https://wiki.onap.org/).
24348 - name: equipment-name
24352 example: __EQUIPMENT-NAME__
24353 - name: interface-name
24355 description: Name that identifies the link aggregate interface
24358 example: __INTERFACE-NAME__
24359 - name: interface-name
24361 description: Name given to the interface
24364 example: __INTERFACE-NAME__
24365 - name: vlan-interface
24367 description: String that identifies the interface
24370 example: __VLAN-INTERFACE__
24371 - name: l3-interface-ipv4-address
24373 description: IP address
24376 example: __L3-INTERFACE-IPV4-ADDRESS__
24379 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
24382 $ref: "#/definitions/relationship"
24386 summary: delete an existing relationship
24387 description: delete an existing relationship
24388 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
24397 description: Response codes found in [response codes](https://wiki.onap.org/).
24399 - name: equipment-name
24403 example: __EQUIPMENT-NAME__
24404 - name: interface-name
24406 description: Name that identifies the link aggregate interface
24409 example: __INTERFACE-NAME__
24410 - name: interface-name
24412 description: Name given to the interface
24415 example: __INTERFACE-NAME__
24416 - name: vlan-interface
24418 description: String that identifies the interface
24421 example: __VLAN-INTERFACE__
24422 - name: l3-interface-ipv4-address
24424 description: IP address
24427 example: __L3-INTERFACE-IPV4-ADDRESS__
24428 /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}:
24432 summary: returns l3-interface-ipv4-address-list
24433 description: returns l3-interface-ipv4-address-list
24434 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24440 description: successful operation
24442 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
24444 description: Response codes found in [response codes](https://wiki.onap.org/).
24446 - name: equipment-name
24450 example: __EQUIPMENT-NAME__
24451 - name: interface-name
24453 description: Name that identifies the link aggregate interface
24456 example: __INTERFACE-NAME__
24457 - name: interface-name
24459 description: Name given to the interface
24462 example: __INTERFACE-NAME__
24463 - name: vlan-interface
24465 description: String that identifies the interface
24468 example: __VLAN-INTERFACE__
24469 - name: l3-interface-ipv4-address
24471 description: IP address
24474 example: __L3-INTERFACE-IPV4-ADDRESS__
24475 - name: prov-status
24477 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24480 - name: interface-id
24482 description: ID of interface
24485 - name: interface-role
24487 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
24490 - name: interface-id
24492 description: ID of interface
24497 description: MAC address for the interface
24500 - name: network-name
24502 description: Name of the network
24505 - name: vlan-id-inner
24507 description: Inner VLAN tag
24513 description: This indicates the customers VPN ID associated with this vlan
24516 - name: vlan-id-inner
24518 description: Inner VLAN tag
24522 - name: neutron-network-id
24524 description: Neutron network id of the interface that address belongs to
24527 - name: neutron-subnet-id
24529 description: Neutron id of subnet that address belongs to
24535 summary: create or update an existing l3-interface-ipv4-address-list
24537 Create or update an existing l3-interface-ipv4-address-list.
24539 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24540 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24549 description: Response codes found in [response codes](https://wiki.onap.org/).
24551 - name: equipment-name
24555 example: __EQUIPMENT-NAME__
24556 - name: interface-name
24558 description: Name that identifies the link aggregate interface
24561 example: __INTERFACE-NAME__
24562 - name: interface-name
24564 description: Name given to the interface
24567 example: __INTERFACE-NAME__
24568 - name: vlan-interface
24570 description: String that identifies the interface
24573 example: __VLAN-INTERFACE__
24574 - name: l3-interface-ipv4-address
24576 description: IP address
24579 example: __L3-INTERFACE-IPV4-ADDRESS__
24582 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
24585 $ref: "#/definitions/l3-interface-ipv4-address-list"
24589 summary: update an existing l3-interface-ipv4-address-list
24591 Update an existing l3-interface-ipv4-address-list
24593 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24594 The PUT operation will entirely replace an existing object.
24595 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24597 Other differences between PUT and PATCH are:
24599 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24600 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24601 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24602 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24611 description: Response codes found in [response codes](https://wiki.onap.org/).
24613 - name: equipment-name
24617 example: __EQUIPMENT-NAME__
24618 - name: interface-name
24620 description: Name that identifies the link aggregate interface
24623 example: __INTERFACE-NAME__
24624 - name: interface-name
24626 description: Name given to the interface
24629 example: __INTERFACE-NAME__
24630 - name: vlan-interface
24632 description: String that identifies the interface
24635 example: __VLAN-INTERFACE__
24636 - name: l3-interface-ipv4-address
24638 description: IP address
24641 example: __L3-INTERFACE-IPV4-ADDRESS__
24644 description: l3-interface-ipv4-address-list object that needs to be created or updated.
24647 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
24651 summary: delete an existing l3-interface-ipv4-address-list
24652 description: delete an existing l3-interface-ipv4-address-list
24653 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24662 description: Response codes found in [response codes](https://wiki.onap.org/).
24664 - name: equipment-name
24668 example: __EQUIPMENT-NAME__
24669 - name: interface-name
24671 description: Name that identifies the link aggregate interface
24674 example: __INTERFACE-NAME__
24675 - name: interface-name
24677 description: Name given to the interface
24680 example: __INTERFACE-NAME__
24681 - name: vlan-interface
24683 description: String that identifies the interface
24686 example: __VLAN-INTERFACE__
24687 - name: l3-interface-ipv4-address
24689 description: IP address
24692 example: __L3-INTERFACE-IPV4-ADDRESS__
24693 - name: resource-version
24695 description: resource-version for concurrency
24698 /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:
24702 summary: see node definition for valid relationships
24703 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
24712 description: Response codes found in [response codes](https://wiki.onap.org/).
24714 - name: equipment-name
24718 example: __EQUIPMENT-NAME__
24719 - name: interface-name
24721 description: Name that identifies the link aggregate interface
24724 example: __INTERFACE-NAME__
24725 - name: interface-name
24727 description: Name given to the interface
24730 example: __INTERFACE-NAME__
24731 - name: vlan-interface
24733 description: String that identifies the interface
24736 example: __VLAN-INTERFACE__
24737 - name: l3-interface-ipv6-address
24739 description: IP address
24742 example: __L3-INTERFACE-IPV6-ADDRESS__
24745 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
24748 $ref: "#/definitions/relationship"
24752 summary: delete an existing relationship
24753 description: delete an existing relationship
24754 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
24763 description: Response codes found in [response codes](https://wiki.onap.org/).
24765 - name: equipment-name
24769 example: __EQUIPMENT-NAME__
24770 - name: interface-name
24772 description: Name that identifies the link aggregate interface
24775 example: __INTERFACE-NAME__
24776 - name: interface-name
24778 description: Name given to the interface
24781 example: __INTERFACE-NAME__
24782 - name: vlan-interface
24784 description: String that identifies the interface
24787 example: __VLAN-INTERFACE__
24788 - name: l3-interface-ipv6-address
24790 description: IP address
24793 example: __L3-INTERFACE-IPV6-ADDRESS__
24794 /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}:
24798 summary: returns l3-interface-ipv6-address-list
24799 description: returns l3-interface-ipv6-address-list
24800 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
24806 description: successful operation
24808 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
24810 description: Response codes found in [response codes](https://wiki.onap.org/).
24812 - name: equipment-name
24816 example: __EQUIPMENT-NAME__
24817 - name: interface-name
24819 description: Name that identifies the link aggregate interface
24822 example: __INTERFACE-NAME__
24823 - name: interface-name
24825 description: Name given to the interface
24828 example: __INTERFACE-NAME__
24829 - name: vlan-interface
24831 description: String that identifies the interface
24834 example: __VLAN-INTERFACE__
24835 - name: l3-interface-ipv6-address
24837 description: IP address
24840 example: __L3-INTERFACE-IPV6-ADDRESS__
24841 - name: prov-status
24843 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24846 - name: interface-id
24848 description: ID of interface
24851 - name: interface-role
24853 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
24856 - name: interface-id
24858 description: ID of interface
24863 description: MAC address for the interface
24866 - name: network-name
24868 description: Name of the network
24871 - name: vlan-id-inner
24873 description: Inner VLAN tag
24879 description: This indicates the customers VPN ID associated with this vlan
24882 - name: vlan-id-inner
24884 description: Inner VLAN tag
24888 - name: neutron-network-id
24890 description: Neutron network id of the interface that address belongs to
24893 - name: neutron-subnet-id
24895 description: Neutron id of subnet that address belongs to
24901 summary: create or update an existing l3-interface-ipv6-address-list
24903 Create or update an existing l3-interface-ipv6-address-list.
24905 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
24906 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
24915 description: Response codes found in [response codes](https://wiki.onap.org/).
24917 - name: equipment-name
24921 example: __EQUIPMENT-NAME__
24922 - name: interface-name
24924 description: Name that identifies the link aggregate interface
24927 example: __INTERFACE-NAME__
24928 - name: interface-name
24930 description: Name given to the interface
24933 example: __INTERFACE-NAME__
24934 - name: vlan-interface
24936 description: String that identifies the interface
24939 example: __VLAN-INTERFACE__
24940 - name: l3-interface-ipv6-address
24942 description: IP address
24945 example: __L3-INTERFACE-IPV6-ADDRESS__
24948 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
24951 $ref: "#/definitions/l3-interface-ipv6-address-list"
24955 summary: update an existing l3-interface-ipv6-address-list
24957 Update an existing l3-interface-ipv6-address-list
24959 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24960 The PUT operation will entirely replace an existing object.
24961 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
24963 Other differences between PUT and PATCH are:
24965 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
24966 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24967 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24968 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
24977 description: Response codes found in [response codes](https://wiki.onap.org/).
24979 - name: equipment-name
24983 example: __EQUIPMENT-NAME__
24984 - name: interface-name
24986 description: Name that identifies the link aggregate interface
24989 example: __INTERFACE-NAME__
24990 - name: interface-name
24992 description: Name given to the interface
24995 example: __INTERFACE-NAME__
24996 - name: vlan-interface
24998 description: String that identifies the interface
25001 example: __VLAN-INTERFACE__
25002 - name: l3-interface-ipv6-address
25004 description: IP address
25007 example: __L3-INTERFACE-IPV6-ADDRESS__
25010 description: l3-interface-ipv6-address-list object that needs to be created or updated.
25013 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
25017 summary: delete an existing l3-interface-ipv6-address-list
25018 description: delete an existing l3-interface-ipv6-address-list
25019 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25028 description: Response codes found in [response codes](https://wiki.onap.org/).
25030 - name: equipment-name
25034 example: __EQUIPMENT-NAME__
25035 - name: interface-name
25037 description: Name that identifies the link aggregate interface
25040 example: __INTERFACE-NAME__
25041 - name: interface-name
25043 description: Name given to the interface
25046 example: __INTERFACE-NAME__
25047 - name: vlan-interface
25049 description: String that identifies the interface
25052 example: __VLAN-INTERFACE__
25053 - name: l3-interface-ipv6-address
25055 description: IP address
25058 example: __L3-INTERFACE-IPV6-ADDRESS__
25059 - name: resource-version
25061 description: resource-version for concurrency
25064 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
25068 summary: returns vlan
25069 description: returns vlan
25070 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
25076 description: successful operation
25078 $ref: "#/getDefinitions/vlan"
25080 description: Response codes found in [response codes](https://wiki.onap.org/).
25082 - name: equipment-name
25086 example: __EQUIPMENT-NAME__
25087 - name: interface-name
25089 description: Name that identifies the link aggregate interface
25092 example: __INTERFACE-NAME__
25093 - name: interface-name
25095 description: Name given to the interface
25098 example: __INTERFACE-NAME__
25099 - name: vlan-interface
25101 description: String that identifies the interface
25104 example: __VLAN-INTERFACE__
25105 - name: prov-status
25107 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25110 - name: interface-id
25112 description: ID of interface
25115 - name: interface-role
25117 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
25120 - name: interface-id
25122 description: ID of interface
25127 description: MAC address for the interface
25130 - name: network-name
25132 description: Name of the network
25135 - name: vlan-id-inner
25137 description: Inner VLAN tag
25143 description: This indicates the customers VPN ID associated with this vlan
25149 summary: create or update an existing vlan
25151 Create or update an existing vlan.
25153 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25154 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
25163 description: Response codes found in [response codes](https://wiki.onap.org/).
25165 - name: equipment-name
25169 example: __EQUIPMENT-NAME__
25170 - name: interface-name
25172 description: Name that identifies the link aggregate interface
25175 example: __INTERFACE-NAME__
25176 - name: interface-name
25178 description: Name given to the interface
25181 example: __INTERFACE-NAME__
25182 - name: vlan-interface
25184 description: String that identifies the interface
25187 example: __VLAN-INTERFACE__
25190 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
25193 $ref: "#/definitions/vlan"
25197 summary: update an existing vlan
25199 Update an existing vlan
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: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
25219 description: Response codes found in [response codes](https://wiki.onap.org/).
25221 - name: equipment-name
25225 example: __EQUIPMENT-NAME__
25226 - name: interface-name
25228 description: Name that identifies the link aggregate interface
25231 example: __INTERFACE-NAME__
25232 - name: interface-name
25234 description: Name given to the interface
25237 example: __INTERFACE-NAME__
25238 - name: vlan-interface
25240 description: String that identifies the interface
25243 example: __VLAN-INTERFACE__
25246 description: vlan object that needs to be created or updated.
25249 $ref: "#/patchDefinitions/vlan"
25253 summary: delete an existing vlan
25254 description: delete an existing vlan
25255 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
25264 description: Response codes found in [response codes](https://wiki.onap.org/).
25266 - name: equipment-name
25270 example: __EQUIPMENT-NAME__
25271 - name: interface-name
25273 description: Name that identifies the link aggregate interface
25276 example: __INTERFACE-NAME__
25277 - name: interface-name
25279 description: Name given to the interface
25282 example: __INTERFACE-NAME__
25283 - name: vlan-interface
25285 description: String that identifies the interface
25288 example: __VLAN-INTERFACE__
25289 - name: resource-version
25291 description: resource-version for concurrency
25294 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
25298 summary: returns vlans
25299 description: returns vlans
25300 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
25306 description: successful operation
25308 $ref: "#/getDefinitions/vlans"
25310 description: Response codes found in [response codes](https://wiki.onap.org/).
25312 - name: equipment-name
25316 example: __EQUIPMENT-NAME__
25317 - name: interface-name
25319 description: Name that identifies the link aggregate interface
25322 example: __INTERFACE-NAME__
25323 - name: interface-name
25325 description: Name given to the interface
25328 example: __INTERFACE-NAME__
25329 - name: prov-status
25331 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25334 - name: interface-id
25336 description: ID of interface
25339 - name: interface-role
25341 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
25344 - name: interface-id
25346 description: ID of interface
25351 description: MAC address for the interface
25354 - name: network-name
25356 description: Name of the network
25359 /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:
25363 summary: see node definition for valid relationships
25364 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
25373 description: Response codes found in [response codes](https://wiki.onap.org/).
25375 - name: equipment-name
25379 example: __EQUIPMENT-NAME__
25380 - name: interface-name
25382 description: Name that identifies the link aggregate interface
25385 example: __INTERFACE-NAME__
25386 - name: interface-name
25388 description: Name given to the interface
25391 example: __INTERFACE-NAME__
25394 description: PCI ID used to identify the sriov-vf
25397 example: __PCI-ID__
25400 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
25403 $ref: "#/definitions/relationship"
25407 summary: delete an existing relationship
25408 description: delete an existing relationship
25409 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
25418 description: Response codes found in [response codes](https://wiki.onap.org/).
25420 - name: equipment-name
25424 example: __EQUIPMENT-NAME__
25425 - name: interface-name
25427 description: Name that identifies the link aggregate interface
25430 example: __INTERFACE-NAME__
25431 - name: interface-name
25433 description: Name given to the interface
25436 example: __INTERFACE-NAME__
25439 description: PCI ID used to identify the sriov-vf
25442 example: __PCI-ID__
25443 /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}:
25447 summary: returns sriov-vf
25448 description: returns sriov-vf
25449 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25455 description: successful operation
25457 $ref: "#/getDefinitions/sriov-vf"
25459 description: Response codes found in [response codes](https://wiki.onap.org/).
25461 - name: equipment-name
25465 example: __EQUIPMENT-NAME__
25466 - name: interface-name
25468 description: Name that identifies the link aggregate interface
25471 example: __INTERFACE-NAME__
25472 - name: interface-name
25474 description: Name given to the interface
25477 example: __INTERFACE-NAME__
25480 description: PCI ID used to identify the sriov-vf
25483 example: __PCI-ID__
25484 - name: prov-status
25486 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25489 - name: interface-id
25491 description: ID of interface
25494 - name: interface-role
25496 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
25499 - name: interface-id
25501 description: ID of interface
25506 description: MAC address for the interface
25509 - name: network-name
25511 description: Name of the network
25514 - name: vf-vlan-filter
25516 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
25519 - name: vf-mac-filter
25521 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
25524 - name: vf-vlan-strip
25526 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
25529 - name: neutron-network-id
25531 description: Neutron network id of the interface
25537 summary: create or update an existing sriov-vf
25539 Create or update an existing sriov-vf.
25541 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25542 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25551 description: Response codes found in [response codes](https://wiki.onap.org/).
25553 - name: equipment-name
25557 example: __EQUIPMENT-NAME__
25558 - name: interface-name
25560 description: Name that identifies the link aggregate interface
25563 example: __INTERFACE-NAME__
25564 - name: interface-name
25566 description: Name given to the interface
25569 example: __INTERFACE-NAME__
25572 description: PCI ID used to identify the sriov-vf
25575 example: __PCI-ID__
25578 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
25581 $ref: "#/definitions/sriov-vf"
25585 summary: update an existing sriov-vf
25587 Update an existing sriov-vf
25589 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25590 The PUT operation will entirely replace an existing object.
25591 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
25593 Other differences between PUT and PATCH are:
25595 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
25596 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25597 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25598 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25607 description: Response codes found in [response codes](https://wiki.onap.org/).
25609 - name: equipment-name
25613 example: __EQUIPMENT-NAME__
25614 - name: interface-name
25616 description: Name that identifies the link aggregate interface
25619 example: __INTERFACE-NAME__
25620 - name: interface-name
25622 description: Name given to the interface
25625 example: __INTERFACE-NAME__
25628 description: PCI ID used to identify the sriov-vf
25631 example: __PCI-ID__
25634 description: sriov-vf object that needs to be created or updated.
25637 $ref: "#/patchDefinitions/sriov-vf"
25641 summary: delete an existing sriov-vf
25642 description: delete an existing sriov-vf
25643 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25652 description: Response codes found in [response codes](https://wiki.onap.org/).
25654 - name: equipment-name
25658 example: __EQUIPMENT-NAME__
25659 - name: interface-name
25661 description: Name that identifies the link aggregate interface
25664 example: __INTERFACE-NAME__
25665 - name: interface-name
25667 description: Name given to the interface
25670 example: __INTERFACE-NAME__
25673 description: PCI ID used to identify the sriov-vf
25676 example: __PCI-ID__
25677 - name: resource-version
25679 description: resource-version for concurrency
25682 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
25686 summary: returns sriov-vfs
25687 description: returns sriov-vfs
25688 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
25694 description: successful operation
25696 $ref: "#/getDefinitions/sriov-vfs"
25698 description: Response codes found in [response codes](https://wiki.onap.org/).
25700 - name: equipment-name
25704 example: __EQUIPMENT-NAME__
25705 - name: interface-name
25707 description: Name that identifies the link aggregate interface
25710 example: __INTERFACE-NAME__
25711 - name: interface-name
25713 description: Name given to the interface
25716 example: __INTERFACE-NAME__
25717 - name: prov-status
25719 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25722 - name: interface-id
25724 description: ID of interface
25727 - name: interface-role
25729 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
25732 - name: interface-id
25734 description: ID of interface
25739 description: MAC address for the interface
25742 - name: network-name
25744 description: Name of the network
25747 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
25751 summary: see node definition for valid relationships
25752 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
25761 description: Response codes found in [response codes](https://wiki.onap.org/).
25763 - name: equipment-name
25767 example: __EQUIPMENT-NAME__
25768 - name: interface-name
25770 description: Name that identifies the link aggregate interface
25773 example: __INTERFACE-NAME__
25774 - name: interface-name
25776 description: Name given to the interface
25779 example: __INTERFACE-NAME__
25782 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
25785 $ref: "#/definitions/relationship"
25789 summary: delete an existing relationship
25790 description: delete an existing relationship
25791 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
25800 description: Response codes found in [response codes](https://wiki.onap.org/).
25802 - name: equipment-name
25806 example: __EQUIPMENT-NAME__
25807 - name: interface-name
25809 description: Name that identifies the link aggregate interface
25812 example: __INTERFACE-NAME__
25813 - name: interface-name
25815 description: Name given to the interface
25818 example: __INTERFACE-NAME__
25819 /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:
25823 summary: see node definition for valid relationships
25824 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
25833 description: Response codes found in [response codes](https://wiki.onap.org/).
25835 - name: equipment-name
25839 example: __EQUIPMENT-NAME__
25840 - name: interface-name
25842 description: Name that identifies the link aggregate interface
25845 example: __INTERFACE-NAME__
25846 - name: interface-name
25848 description: Name given to the interface
25851 example: __INTERFACE-NAME__
25852 - name: l3-interface-ipv4-address
25854 description: IP address
25857 example: __L3-INTERFACE-IPV4-ADDRESS__
25860 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
25863 $ref: "#/definitions/relationship"
25867 summary: delete an existing relationship
25868 description: delete an existing relationship
25869 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
25878 description: Response codes found in [response codes](https://wiki.onap.org/).
25880 - name: equipment-name
25884 example: __EQUIPMENT-NAME__
25885 - name: interface-name
25887 description: Name that identifies the link aggregate interface
25890 example: __INTERFACE-NAME__
25891 - name: interface-name
25893 description: Name given to the interface
25896 example: __INTERFACE-NAME__
25897 - name: l3-interface-ipv4-address
25899 description: IP address
25902 example: __L3-INTERFACE-IPV4-ADDRESS__
25903 /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}:
25907 summary: returns l3-interface-ipv4-address-list
25908 description: returns l3-interface-ipv4-address-list
25909 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
25915 description: successful operation
25917 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
25919 description: Response codes found in [response codes](https://wiki.onap.org/).
25921 - name: equipment-name
25925 example: __EQUIPMENT-NAME__
25926 - name: interface-name
25928 description: Name that identifies the link aggregate interface
25931 example: __INTERFACE-NAME__
25932 - name: interface-name
25934 description: Name given to the interface
25937 example: __INTERFACE-NAME__
25938 - name: l3-interface-ipv4-address
25940 description: IP address
25943 example: __L3-INTERFACE-IPV4-ADDRESS__
25944 - name: prov-status
25946 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25949 - name: interface-id
25951 description: ID of interface
25954 - name: interface-role
25956 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
25959 - name: interface-id
25961 description: ID of interface
25966 description: MAC address for the interface
25969 - name: network-name
25971 description: Name of the network
25974 - name: vlan-id-inner
25976 description: Inner VLAN tag
25980 - name: neutron-network-id
25982 description: Neutron network id of the interface that address belongs to
25985 - name: neutron-subnet-id
25987 description: Neutron id of subnet that address belongs to
25993 summary: create or update an existing l3-interface-ipv4-address-list
25995 Create or update an existing l3-interface-ipv4-address-list.
25997 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
25998 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26007 description: Response codes found in [response codes](https://wiki.onap.org/).
26009 - name: equipment-name
26013 example: __EQUIPMENT-NAME__
26014 - name: interface-name
26016 description: Name that identifies the link aggregate interface
26019 example: __INTERFACE-NAME__
26020 - name: interface-name
26022 description: Name given to the interface
26025 example: __INTERFACE-NAME__
26026 - name: l3-interface-ipv4-address
26028 description: IP address
26031 example: __L3-INTERFACE-IPV4-ADDRESS__
26034 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
26037 $ref: "#/definitions/l3-interface-ipv4-address-list"
26041 summary: update an existing l3-interface-ipv4-address-list
26043 Update an existing l3-interface-ipv4-address-list
26045 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26046 The PUT operation will entirely replace an existing object.
26047 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26049 Other differences between PUT and PATCH are:
26051 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26052 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26053 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26054 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26063 description: Response codes found in [response codes](https://wiki.onap.org/).
26065 - name: equipment-name
26069 example: __EQUIPMENT-NAME__
26070 - name: interface-name
26072 description: Name that identifies the link aggregate interface
26075 example: __INTERFACE-NAME__
26076 - name: interface-name
26078 description: Name given to the interface
26081 example: __INTERFACE-NAME__
26082 - name: l3-interface-ipv4-address
26084 description: IP address
26087 example: __L3-INTERFACE-IPV4-ADDRESS__
26090 description: l3-interface-ipv4-address-list object that needs to be created or updated.
26093 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
26097 summary: delete an existing l3-interface-ipv4-address-list
26098 description: delete an existing l3-interface-ipv4-address-list
26099 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26108 description: Response codes found in [response codes](https://wiki.onap.org/).
26110 - name: equipment-name
26114 example: __EQUIPMENT-NAME__
26115 - name: interface-name
26117 description: Name that identifies the link aggregate interface
26120 example: __INTERFACE-NAME__
26121 - name: interface-name
26123 description: Name given to the interface
26126 example: __INTERFACE-NAME__
26127 - name: l3-interface-ipv4-address
26129 description: IP address
26132 example: __L3-INTERFACE-IPV4-ADDRESS__
26133 - name: resource-version
26135 description: resource-version for concurrency
26138 /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:
26142 summary: see node definition for valid relationships
26143 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
26152 description: Response codes found in [response codes](https://wiki.onap.org/).
26154 - name: equipment-name
26158 example: __EQUIPMENT-NAME__
26159 - name: interface-name
26161 description: Name that identifies the link aggregate interface
26164 example: __INTERFACE-NAME__
26165 - name: interface-name
26167 description: Name given to the interface
26170 example: __INTERFACE-NAME__
26171 - name: l3-interface-ipv6-address
26173 description: IP address
26176 example: __L3-INTERFACE-IPV6-ADDRESS__
26179 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
26182 $ref: "#/definitions/relationship"
26186 summary: delete an existing relationship
26187 description: delete an existing relationship
26188 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
26197 description: Response codes found in [response codes](https://wiki.onap.org/).
26199 - name: equipment-name
26203 example: __EQUIPMENT-NAME__
26204 - name: interface-name
26206 description: Name that identifies the link aggregate interface
26209 example: __INTERFACE-NAME__
26210 - name: interface-name
26212 description: Name given to the interface
26215 example: __INTERFACE-NAME__
26216 - name: l3-interface-ipv6-address
26218 description: IP address
26221 example: __L3-INTERFACE-IPV6-ADDRESS__
26222 /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}:
26226 summary: returns l3-interface-ipv6-address-list
26227 description: returns l3-interface-ipv6-address-list
26228 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26234 description: successful operation
26236 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
26238 description: Response codes found in [response codes](https://wiki.onap.org/).
26240 - name: equipment-name
26244 example: __EQUIPMENT-NAME__
26245 - name: interface-name
26247 description: Name that identifies the link aggregate interface
26250 example: __INTERFACE-NAME__
26251 - name: interface-name
26253 description: Name given to the interface
26256 example: __INTERFACE-NAME__
26257 - name: l3-interface-ipv6-address
26259 description: IP address
26262 example: __L3-INTERFACE-IPV6-ADDRESS__
26263 - name: prov-status
26265 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26268 - name: interface-id
26270 description: ID of interface
26273 - name: interface-role
26275 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
26278 - name: interface-id
26280 description: ID of interface
26285 description: MAC address for the interface
26288 - name: network-name
26290 description: Name of the network
26293 - name: vlan-id-inner
26295 description: Inner VLAN tag
26299 - name: neutron-network-id
26301 description: Neutron network id of the interface that address belongs to
26304 - name: neutron-subnet-id
26306 description: Neutron id of subnet that address belongs to
26312 summary: create or update an existing l3-interface-ipv6-address-list
26314 Create or update an existing l3-interface-ipv6-address-list.
26316 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26317 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26326 description: Response codes found in [response codes](https://wiki.onap.org/).
26328 - name: equipment-name
26332 example: __EQUIPMENT-NAME__
26333 - name: interface-name
26335 description: Name that identifies the link aggregate interface
26338 example: __INTERFACE-NAME__
26339 - name: interface-name
26341 description: Name given to the interface
26344 example: __INTERFACE-NAME__
26345 - name: l3-interface-ipv6-address
26347 description: IP address
26350 example: __L3-INTERFACE-IPV6-ADDRESS__
26353 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
26356 $ref: "#/definitions/l3-interface-ipv6-address-list"
26360 summary: update an existing l3-interface-ipv6-address-list
26362 Update an existing l3-interface-ipv6-address-list
26364 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26365 The PUT operation will entirely replace an existing object.
26366 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26368 Other differences between PUT and PATCH are:
26370 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26371 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26372 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26373 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26382 description: Response codes found in [response codes](https://wiki.onap.org/).
26384 - name: equipment-name
26388 example: __EQUIPMENT-NAME__
26389 - name: interface-name
26391 description: Name that identifies the link aggregate interface
26394 example: __INTERFACE-NAME__
26395 - name: interface-name
26397 description: Name given to the interface
26400 example: __INTERFACE-NAME__
26401 - name: l3-interface-ipv6-address
26403 description: IP address
26406 example: __L3-INTERFACE-IPV6-ADDRESS__
26409 description: l3-interface-ipv6-address-list object that needs to be created or updated.
26412 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
26416 summary: delete an existing l3-interface-ipv6-address-list
26417 description: delete an existing l3-interface-ipv6-address-list
26418 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26427 description: Response codes found in [response codes](https://wiki.onap.org/).
26429 - name: equipment-name
26433 example: __EQUIPMENT-NAME__
26434 - name: interface-name
26436 description: Name that identifies the link aggregate interface
26439 example: __INTERFACE-NAME__
26440 - name: interface-name
26442 description: Name given to the interface
26445 example: __INTERFACE-NAME__
26446 - name: l3-interface-ipv6-address
26448 description: IP address
26451 example: __L3-INTERFACE-IPV6-ADDRESS__
26452 - name: resource-version
26454 description: resource-version for concurrency
26457 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
26461 summary: returns l-interface
26462 description: returns l-interface
26463 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
26469 description: successful operation
26471 $ref: "#/getDefinitions/l-interface"
26473 description: Response codes found in [response codes](https://wiki.onap.org/).
26475 - name: equipment-name
26479 example: __EQUIPMENT-NAME__
26480 - name: interface-name
26482 description: Name that identifies the link aggregate interface
26485 example: __INTERFACE-NAME__
26486 - name: interface-name
26488 description: Name given to the interface
26491 example: __INTERFACE-NAME__
26492 - name: prov-status
26494 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26497 - name: interface-id
26499 description: ID of interface
26502 - name: interface-role
26504 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
26507 - name: interface-id
26509 description: ID of interface
26514 description: MAC address for the interface
26517 - name: network-name
26519 description: Name of the network
26525 summary: create or update an existing l-interface
26527 Create or update an existing l-interface.
26529 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26530 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
26539 description: Response codes found in [response codes](https://wiki.onap.org/).
26541 - name: equipment-name
26545 example: __EQUIPMENT-NAME__
26546 - name: interface-name
26548 description: Name that identifies the link aggregate interface
26551 example: __INTERFACE-NAME__
26552 - name: interface-name
26554 description: Name given to the interface
26557 example: __INTERFACE-NAME__
26560 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
26563 $ref: "#/definitions/l-interface"
26567 summary: update an existing l-interface
26569 Update an existing l-interface
26571 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26572 The PUT operation will entirely replace an existing object.
26573 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26575 Other differences between PUT and PATCH are:
26577 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26578 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26579 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26580 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
26589 description: Response codes found in [response codes](https://wiki.onap.org/).
26591 - name: equipment-name
26595 example: __EQUIPMENT-NAME__
26596 - name: interface-name
26598 description: Name that identifies the link aggregate interface
26601 example: __INTERFACE-NAME__
26602 - name: interface-name
26604 description: Name given to the interface
26607 example: __INTERFACE-NAME__
26610 description: l-interface object that needs to be created or updated.
26613 $ref: "#/patchDefinitions/l-interface"
26617 summary: delete an existing l-interface
26618 description: delete an existing l-interface
26619 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
26628 description: Response codes found in [response codes](https://wiki.onap.org/).
26630 - name: equipment-name
26634 example: __EQUIPMENT-NAME__
26635 - name: interface-name
26637 description: Name that identifies the link aggregate interface
26640 example: __INTERFACE-NAME__
26641 - name: interface-name
26643 description: Name given to the interface
26646 example: __INTERFACE-NAME__
26647 - name: resource-version
26649 description: resource-version for concurrency
26652 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
26656 summary: returns l-interfaces
26657 description: returns l-interfaces
26658 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces
26664 description: successful operation
26666 $ref: "#/getDefinitions/l-interfaces"
26668 description: Response codes found in [response codes](https://wiki.onap.org/).
26670 - name: equipment-name
26674 example: __EQUIPMENT-NAME__
26675 - name: interface-name
26677 description: Name that identifies the link aggregate interface
26680 example: __INTERFACE-NAME__
26681 - name: prov-status
26683 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26686 - name: interface-id
26688 description: ID of interface
26691 - name: interface-role
26693 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
26696 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}:
26700 summary: returns lag-interface
26701 description: returns lag-interface
26702 operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface
26708 description: successful operation
26710 $ref: "#/getDefinitions/lag-interface"
26712 description: Response codes found in [response codes](https://wiki.onap.org/).
26714 - name: equipment-name
26718 example: __EQUIPMENT-NAME__
26719 - name: interface-name
26721 description: Name that identifies the link aggregate interface
26724 example: __INTERFACE-NAME__
26725 - name: prov-status
26727 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26730 - name: interface-id
26732 description: ID of interface
26735 - name: interface-role
26737 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
26743 summary: create or update an existing lag-interface
26745 Create or update an existing lag-interface.
26747 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26748 operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
26757 description: Response codes found in [response codes](https://wiki.onap.org/).
26759 - name: equipment-name
26763 example: __EQUIPMENT-NAME__
26764 - name: interface-name
26766 description: Name that identifies the link aggregate interface
26769 example: __INTERFACE-NAME__
26772 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
26775 $ref: "#/definitions/lag-interface"
26779 summary: update an existing lag-interface
26781 Update an existing lag-interface
26783 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26784 The PUT operation will entirely replace an existing object.
26785 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26787 Other differences between PUT and PATCH are:
26789 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26790 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26791 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26792 operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
26801 description: Response codes found in [response codes](https://wiki.onap.org/).
26803 - name: equipment-name
26807 example: __EQUIPMENT-NAME__
26808 - name: interface-name
26810 description: Name that identifies the link aggregate interface
26813 example: __INTERFACE-NAME__
26816 description: lag-interface object that needs to be created or updated.
26819 $ref: "#/patchDefinitions/lag-interface"
26823 summary: delete an existing lag-interface
26824 description: delete an existing lag-interface
26825 operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface
26834 description: Response codes found in [response codes](https://wiki.onap.org/).
26836 - name: equipment-name
26840 example: __EQUIPMENT-NAME__
26841 - name: interface-name
26843 description: Name that identifies the link aggregate interface
26846 example: __INTERFACE-NAME__
26847 - name: resource-version
26849 description: resource-version for concurrency
26852 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces:
26856 summary: returns lag-interfaces
26857 description: returns lag-interfaces
26858 operationId: getNetworkVplsPesVplsPeLagInterfaces
26864 description: successful operation
26866 $ref: "#/getDefinitions/lag-interfaces"
26868 description: Response codes found in [response codes](https://wiki.onap.org/).
26870 - name: equipment-name
26874 example: __EQUIPMENT-NAME__
26875 - name: prov-status
26877 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26880 /network/vpls-pes/vpls-pe/{equipment-name}:
26884 summary: returns vpls-pe
26885 description: returns vpls-pe
26886 operationId: getNetworkVplsPesVplsPe
26892 description: successful operation
26894 $ref: "#/getDefinitions/vpls-pe"
26896 description: Response codes found in [response codes](https://wiki.onap.org/).
26898 - name: equipment-name
26902 example: __EQUIPMENT-NAME__
26903 - name: prov-status
26905 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26911 summary: create or update an existing vpls-pe
26913 Create or update an existing vpls-pe.
26915 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
26916 operationId: createOrUpdateNetworkVplsPesVplsPe
26925 description: Response codes found in [response codes](https://wiki.onap.org/).
26927 - name: equipment-name
26931 example: __EQUIPMENT-NAME__
26934 description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVplsPesVplsPe.json)
26937 $ref: "#/definitions/vpls-pe"
26941 summary: update an existing vpls-pe
26943 Update an existing vpls-pe
26945 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26946 The PUT operation will entirely replace an existing object.
26947 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
26949 Other differences between PUT and PATCH are:
26951 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
26952 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26953 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26954 operationId: UpdateNetworkVplsPesVplsPe
26963 description: Response codes found in [response codes](https://wiki.onap.org/).
26965 - name: equipment-name
26969 example: __EQUIPMENT-NAME__
26972 description: vpls-pe object that needs to be created or updated.
26975 $ref: "#/patchDefinitions/vpls-pe"
26979 summary: delete an existing vpls-pe
26980 description: delete an existing vpls-pe
26981 operationId: deleteNetworkVplsPesVplsPe
26990 description: Response codes found in [response codes](https://wiki.onap.org/).
26992 - name: equipment-name
26996 example: __EQUIPMENT-NAME__
26997 - name: resource-version
26999 description: resource-version for concurrency
27006 summary: returns vpls-pes
27007 description: returns vpls-pes
27008 operationId: getNetworkVplsPes
27014 description: successful operation
27016 $ref: "#/getDefinitions/vpls-pes"
27018 description: Response codes found in [response codes](https://wiki.onap.org/).
27019 /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
27023 summary: see node definition for valid relationships
27024 operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
27033 description: Response codes found in [response codes](https://wiki.onap.org/).
27035 - name: multicast-configuration-id
27037 description: Unique id of multicast configuration.
27040 example: __MULTICAST-CONFIGURATION-ID__
27043 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkMulticastConfigurationsMulticastConfiguration.json)
27046 $ref: "#/definitions/relationship"
27050 summary: delete an existing relationship
27051 description: delete an existing relationship
27052 operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
27061 description: Response codes found in [response codes](https://wiki.onap.org/).
27063 - name: multicast-configuration-id
27065 description: Unique id of multicast configuration.
27068 example: __MULTICAST-CONFIGURATION-ID__
27069 /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}:
27073 summary: returns multicast-configuration
27074 description: returns multicast-configuration
27075 operationId: getNetworkMulticastConfigurationsMulticastConfiguration
27081 description: successful operation
27083 $ref: "#/getDefinitions/multicast-configuration"
27085 description: Response codes found in [response codes](https://wiki.onap.org/).
27087 - name: multicast-configuration-id
27089 description: Unique id of multicast configuration.
27092 example: __MULTICAST-CONFIGURATION-ID__
27096 summary: create or update an existing multicast-configuration
27098 Create or update an existing multicast-configuration.
27100 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27101 operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration
27110 description: Response codes found in [response codes](https://wiki.onap.org/).
27112 - name: multicast-configuration-id
27114 description: Unique id of multicast configuration.
27117 example: __MULTICAST-CONFIGURATION-ID__
27120 description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkMulticastConfigurationsMulticastConfiguration.json)
27123 $ref: "#/definitions/multicast-configuration"
27127 summary: update an existing multicast-configuration
27129 Update an existing multicast-configuration
27131 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27132 The PUT operation will entirely replace an existing object.
27133 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27135 Other differences between PUT and PATCH are:
27137 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27138 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27139 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27140 operationId: UpdateNetworkMulticastConfigurationsMulticastConfiguration
27149 description: Response codes found in [response codes](https://wiki.onap.org/).
27151 - name: multicast-configuration-id
27153 description: Unique id of multicast configuration.
27156 example: __MULTICAST-CONFIGURATION-ID__
27159 description: multicast-configuration object that needs to be created or updated.
27162 $ref: "#/patchDefinitions/multicast-configuration"
27166 summary: delete an existing multicast-configuration
27167 description: delete an existing multicast-configuration
27168 operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration
27177 description: Response codes found in [response codes](https://wiki.onap.org/).
27179 - name: multicast-configuration-id
27181 description: Unique id of multicast configuration.
27184 example: __MULTICAST-CONFIGURATION-ID__
27185 - name: resource-version
27187 description: resource-version for concurrency
27190 /network/multicast-configurations:
27194 summary: returns multicast-configurations
27195 description: returns multicast-configurations
27196 operationId: getNetworkMulticastConfigurations
27202 description: successful operation
27204 $ref: "#/getDefinitions/multicast-configurations"
27206 description: Response codes found in [response codes](https://wiki.onap.org/).
27207 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship:
27211 summary: see node definition for valid relationships
27212 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
27221 description: Response codes found in [response codes](https://wiki.onap.org/).
27225 description: Unique id of VNF. This is unique across the graph.
27228 example: __VNF-ID__
27229 - name: interface-id
27231 description: Unique ID of the interface
27234 example: __INTERFACE-ID__
27237 description: See mis-na-virtualization-platform.yang
27241 example: __CVLAN-TAG__
27244 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
27247 $ref: "#/definitions/relationship"
27251 summary: delete an existing relationship
27252 description: delete an existing relationship
27253 operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
27262 description: Response codes found in [response codes](https://wiki.onap.org/).
27266 description: Unique id of VNF. This is unique across the graph.
27269 example: __VNF-ID__
27270 - name: interface-id
27272 description: Unique ID of the interface
27275 example: __INTERFACE-ID__
27278 description: See mis-na-virtualization-platform.yang
27282 example: __CVLAN-TAG__
27283 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
27287 summary: returns cvlan-tag-entry
27288 description: returns cvlan-tag-entry
27289 operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
27295 description: successful operation
27297 $ref: "#/getDefinitions/cvlan-tag-entry"
27299 description: Response codes found in [response codes](https://wiki.onap.org/).
27303 description: Unique id of VNF. This is unique across the graph.
27306 example: __VNF-ID__
27307 - name: interface-id
27309 description: Unique ID of the interface
27312 example: __INTERFACE-ID__
27315 description: See mis-na-virtualization-platform.yang
27319 example: __CVLAN-TAG__
27322 description: Name of VNF.
27327 description: Alternate name of VNF.
27332 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
27337 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
27340 - name: regional-resource-zone
27342 description: Regional way of organizing pservers, source of truth should define values
27345 - name: prov-status
27347 description: Trigger for operational monitoring of this resource by Service Assurance systems.
27350 - name: heat-stack-id
27352 description: Heat stack id corresponding to this instance, managed by MSO
27357 description: Unique ID of VPE connected to this VCE.
27360 - name: port-group-id
27362 description: Unique ID for port group in vmware
27365 - name: switch-name
27367 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
27370 - name: heat-stack-id
27372 description: Heat stack id corresponding to this instance, managed by MSO
27378 summary: create or update an existing cvlan-tag-entry
27380 Create or update an existing cvlan-tag-entry.
27382 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27383 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
27392 description: Response codes found in [response codes](https://wiki.onap.org/).
27396 description: Unique id of VNF. This is unique across the graph.
27399 example: __VNF-ID__
27400 - name: interface-id
27402 description: Unique ID of the interface
27405 example: __INTERFACE-ID__
27408 description: See mis-na-virtualization-platform.yang
27412 example: __CVLAN-TAG__
27415 description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
27418 $ref: "#/definitions/cvlan-tag-entry"
27422 summary: update an existing cvlan-tag-entry
27424 Update an existing cvlan-tag-entry
27426 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27427 The PUT operation will entirely replace an existing object.
27428 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27430 Other differences between PUT and PATCH are:
27432 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27433 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27434 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27435 operationId: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
27444 description: Response codes found in [response codes](https://wiki.onap.org/).
27448 description: Unique id of VNF. This is unique across the graph.
27451 example: __VNF-ID__
27452 - name: interface-id
27454 description: Unique ID of the interface
27457 example: __INTERFACE-ID__
27460 description: See mis-na-virtualization-platform.yang
27464 example: __CVLAN-TAG__
27467 description: cvlan-tag-entry object that needs to be created or updated.
27470 $ref: "#/patchDefinitions/cvlan-tag-entry"
27474 summary: delete an existing cvlan-tag-entry
27475 description: delete an existing cvlan-tag-entry
27476 operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
27485 description: Response codes found in [response codes](https://wiki.onap.org/).
27489 description: Unique id of VNF. This is unique across the graph.
27492 example: __VNF-ID__
27493 - name: interface-id
27495 description: Unique ID of the interface
27498 example: __INTERFACE-ID__
27501 description: See mis-na-virtualization-platform.yang
27505 example: __CVLAN-TAG__
27506 - name: resource-version
27508 description: resource-version for concurrency
27511 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags:
27515 summary: returns cvlan-tags
27516 description: returns cvlan-tags
27517 operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags
27523 description: successful operation
27525 $ref: "#/getDefinitions/cvlan-tags"
27527 description: Response codes found in [response codes](https://wiki.onap.org/).
27531 description: Unique id of VNF. This is unique across the graph.
27534 example: __VNF-ID__
27535 - name: interface-id
27537 description: Unique ID of the interface
27540 example: __INTERFACE-ID__
27543 description: Name of VNF.
27548 description: Alternate name of VNF.
27553 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
27558 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
27561 - name: regional-resource-zone
27563 description: Regional way of organizing pservers, source of truth should define values
27566 - name: prov-status
27568 description: Trigger for operational monitoring of this resource by Service Assurance systems.
27571 - name: heat-stack-id
27573 description: Heat stack id corresponding to this instance, managed by MSO
27578 description: Unique ID of VPE connected to this VCE.
27581 - name: port-group-id
27583 description: Unique ID for port group in vmware
27586 - name: switch-name
27588 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
27591 - name: heat-stack-id
27593 description: Heat stack id corresponding to this instance, managed by MSO
27596 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
27600 summary: see node definition for valid relationships
27601 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
27610 description: Response codes found in [response codes](https://wiki.onap.org/).
27614 description: Unique id of VNF. This is unique across the graph.
27617 example: __VNF-ID__
27618 - name: interface-id
27620 description: Unique ID of the interface
27623 example: __INTERFACE-ID__
27626 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVcePortGroupsPortGroup.json)
27629 $ref: "#/definitions/relationship"
27633 summary: delete an existing relationship
27634 description: delete an existing relationship
27635 operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
27644 description: Response codes found in [response codes](https://wiki.onap.org/).
27648 description: Unique id of VNF. This is unique across the graph.
27651 example: __VNF-ID__
27652 - name: interface-id
27654 description: Unique ID of the interface
27657 example: __INTERFACE-ID__
27658 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
27662 summary: returns port-group
27663 description: returns port-group
27664 operationId: getNetworkVcesVcePortGroupsPortGroup
27670 description: successful operation
27672 $ref: "#/getDefinitions/port-group"
27674 description: Response codes found in [response codes](https://wiki.onap.org/).
27678 description: Unique id of VNF. This is unique across the graph.
27681 example: __VNF-ID__
27682 - name: interface-id
27684 description: Unique ID of the interface
27687 example: __INTERFACE-ID__
27690 description: Name of VNF.
27695 description: Alternate name of VNF.
27700 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
27705 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
27708 - name: regional-resource-zone
27710 description: Regional way of organizing pservers, source of truth should define values
27713 - name: prov-status
27715 description: Trigger for operational monitoring of this resource by Service Assurance systems.
27718 - name: heat-stack-id
27720 description: Heat stack id corresponding to this instance, managed by MSO
27725 description: Unique ID of VPE connected to this VCE.
27728 - name: port-group-id
27730 description: Unique ID for port group in vmware
27733 - name: switch-name
27735 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
27738 - name: heat-stack-id
27740 description: Heat stack id corresponding to this instance, managed by MSO
27746 summary: create or update an existing port-group
27748 Create or update an existing port-group.
27750 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
27751 operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
27760 description: Response codes found in [response codes](https://wiki.onap.org/).
27764 description: Unique id of VNF. This is unique across the graph.
27767 example: __VNF-ID__
27768 - name: interface-id
27770 description: Unique ID of the interface
27773 example: __INTERFACE-ID__
27776 description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVcePortGroupsPortGroup.json)
27779 $ref: "#/definitions/port-group"
27783 summary: update an existing port-group
27785 Update an existing port-group
27787 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27788 The PUT operation will entirely replace an existing object.
27789 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
27791 Other differences between PUT and PATCH are:
27793 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
27794 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27795 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27796 operationId: UpdateNetworkVcesVcePortGroupsPortGroup
27805 description: Response codes found in [response codes](https://wiki.onap.org/).
27809 description: Unique id of VNF. This is unique across the graph.
27812 example: __VNF-ID__
27813 - name: interface-id
27815 description: Unique ID of the interface
27818 example: __INTERFACE-ID__
27821 description: port-group object that needs to be created or updated.
27824 $ref: "#/patchDefinitions/port-group"
27828 summary: delete an existing port-group
27829 description: delete an existing port-group
27830 operationId: deleteNetworkVcesVcePortGroupsPortGroup
27839 description: Response codes found in [response codes](https://wiki.onap.org/).
27843 description: Unique id of VNF. This is unique across the graph.
27846 example: __VNF-ID__
27847 - name: interface-id
27849 description: Unique ID of the interface
27852 example: __INTERFACE-ID__
27853 - name: resource-version
27855 description: resource-version for concurrency
27858 /network/vces/vce/{vnf-id}/port-groups:
27862 summary: returns port-groups
27863 description: returns port-groups
27864 operationId: getNetworkVcesVcePortGroups
27870 description: successful operation
27872 $ref: "#/getDefinitions/port-groups"
27874 description: Response codes found in [response codes](https://wiki.onap.org/).
27878 description: Unique id of VNF. This is unique across the graph.
27881 example: __VNF-ID__
27884 description: Name of VNF.
27889 description: Alternate name of VNF.
27894 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
27899 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
27902 - name: regional-resource-zone
27904 description: Regional way of organizing pservers, source of truth should define values
27907 - name: prov-status
27909 description: Trigger for operational monitoring of this resource by Service Assurance systems.
27912 - name: heat-stack-id
27914 description: Heat stack id corresponding to this instance, managed by MSO
27919 description: Unique ID of VPE connected to this VCE.
27922 /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
27926 summary: see node definition for valid relationships
27927 operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship
27936 description: Response codes found in [response codes](https://wiki.onap.org/).
27940 description: Unique id of VNF. This is unique across the graph.
27943 example: __VNF-ID__
27946 description: Unique ID for the license group the resource belongs to, should be uuid.
27949 example: __GROUP-UUID__
27950 - name: resource-uuid
27952 description: Unique ID of a license resource.
27955 example: __RESOURCE-UUID__
27958 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVceLicensesLicense.json)
27961 $ref: "#/definitions/relationship"
27965 summary: delete an existing relationship
27966 description: delete an existing relationship
27967 operationId: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship
27976 description: Response codes found in [response codes](https://wiki.onap.org/).
27980 description: Unique id of VNF. This is unique across the graph.
27983 example: __VNF-ID__
27986 description: Unique ID for the license group the resource belongs to, should be uuid.
27989 example: __GROUP-UUID__
27990 - name: resource-uuid
27992 description: Unique ID of a license resource.
27995 example: __RESOURCE-UUID__
27996 /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
28000 summary: returns license
28001 description: returns license
28002 operationId: getNetworkVcesVceLicensesLicense
28008 description: successful operation
28010 $ref: "#/getDefinitions/license"
28012 description: Response codes found in [response codes](https://wiki.onap.org/).
28016 description: Unique id of VNF. This is unique across the graph.
28019 example: __VNF-ID__
28022 description: Unique ID for the license group the resource belongs to, should be uuid.
28025 example: __GROUP-UUID__
28026 - name: resource-uuid
28028 description: Unique ID of a license resource.
28031 example: __RESOURCE-UUID__
28034 description: Name of VNF.
28039 description: Alternate name of VNF.
28044 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
28049 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
28052 - name: regional-resource-zone
28054 description: Regional way of organizing pservers, source of truth should define values
28057 - name: prov-status
28059 description: Trigger for operational monitoring of this resource by Service Assurance systems.
28062 - name: heat-stack-id
28064 description: Heat stack id corresponding to this instance, managed by MSO
28069 description: Unique ID of VPE connected to this VCE.
28075 summary: create or update an existing license
28077 Create or update an existing license.
28079 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28080 operationId: createOrUpdateNetworkVcesVceLicensesLicense
28089 description: Response codes found in [response codes](https://wiki.onap.org/).
28093 description: Unique id of VNF. This is unique across the graph.
28096 example: __VNF-ID__
28099 description: Unique ID for the license group the resource belongs to, should be uuid.
28102 example: __GROUP-UUID__
28103 - name: resource-uuid
28105 description: Unique ID of a license resource.
28108 example: __RESOURCE-UUID__
28111 description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVceLicensesLicense.json)
28114 $ref: "#/definitions/license"
28118 summary: update an existing license
28120 Update an existing license
28122 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28123 The PUT operation will entirely replace an existing object.
28124 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28126 Other differences between PUT and PATCH are:
28128 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28129 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28130 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28131 operationId: UpdateNetworkVcesVceLicensesLicense
28140 description: Response codes found in [response codes](https://wiki.onap.org/).
28144 description: Unique id of VNF. This is unique across the graph.
28147 example: __VNF-ID__
28150 description: Unique ID for the license group the resource belongs to, should be uuid.
28153 example: __GROUP-UUID__
28154 - name: resource-uuid
28156 description: Unique ID of a license resource.
28159 example: __RESOURCE-UUID__
28162 description: license object that needs to be created or updated.
28165 $ref: "#/patchDefinitions/license"
28169 summary: delete an existing license
28170 description: delete an existing license
28171 operationId: deleteNetworkVcesVceLicensesLicense
28180 description: Response codes found in [response codes](https://wiki.onap.org/).
28184 description: Unique id of VNF. This is unique across the graph.
28187 example: __VNF-ID__
28190 description: Unique ID for the license group the resource belongs to, should be uuid.
28193 example: __GROUP-UUID__
28194 - name: resource-uuid
28196 description: Unique ID of a license resource.
28199 example: __RESOURCE-UUID__
28200 - name: resource-version
28202 description: resource-version for concurrency
28205 /network/vces/vce/{vnf-id}/licenses:
28209 summary: returns licenses
28210 description: returns licenses
28211 operationId: getNetworkVcesVceLicenses
28217 description: successful operation
28219 $ref: "#/getDefinitions/licenses"
28221 description: Response codes found in [response codes](https://wiki.onap.org/).
28225 description: Unique id of VNF. This is unique across the graph.
28228 example: __VNF-ID__
28231 description: Name of VNF.
28236 description: Alternate name of VNF.
28241 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
28246 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
28249 - name: regional-resource-zone
28251 description: Regional way of organizing pservers, source of truth should define values
28254 - name: prov-status
28256 description: Trigger for operational monitoring of this resource by Service Assurance systems.
28259 - name: heat-stack-id
28261 description: Heat stack id corresponding to this instance, managed by MSO
28266 description: Unique ID of VPE connected to this VCE.
28269 /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
28273 summary: see node definition for valid relationships
28274 operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
28283 description: Response codes found in [response codes](https://wiki.onap.org/).
28287 description: Unique id of VNF. This is unique across the graph.
28290 example: __VNF-ID__
28293 description: Unique ID for the entitlement group the resource comes from, should be uuid.
28296 example: __GROUP-UUID__
28297 - name: resource-uuid
28299 description: Unique ID of an entitlement resource.
28302 example: __RESOURCE-UUID__
28305 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVceEntitlementsEntitlement.json)
28308 $ref: "#/definitions/relationship"
28312 summary: delete an existing relationship
28313 description: delete an existing relationship
28314 operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
28323 description: Response codes found in [response codes](https://wiki.onap.org/).
28327 description: Unique id of VNF. This is unique across the graph.
28330 example: __VNF-ID__
28333 description: Unique ID for the entitlement group the resource comes from, should be uuid.
28336 example: __GROUP-UUID__
28337 - name: resource-uuid
28339 description: Unique ID of an entitlement resource.
28342 example: __RESOURCE-UUID__
28343 /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
28347 summary: returns entitlement
28348 description: returns entitlement
28349 operationId: getNetworkVcesVceEntitlementsEntitlement
28355 description: successful operation
28357 $ref: "#/getDefinitions/entitlement"
28359 description: Response codes found in [response codes](https://wiki.onap.org/).
28363 description: Unique id of VNF. This is unique across the graph.
28366 example: __VNF-ID__
28369 description: Unique ID for the entitlement group the resource comes from, should be uuid.
28372 example: __GROUP-UUID__
28373 - name: resource-uuid
28375 description: Unique ID of an entitlement resource.
28378 example: __RESOURCE-UUID__
28381 description: Name of VNF.
28386 description: Alternate name of VNF.
28391 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
28396 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
28399 - name: regional-resource-zone
28401 description: Regional way of organizing pservers, source of truth should define values
28404 - name: prov-status
28406 description: Trigger for operational monitoring of this resource by Service Assurance systems.
28409 - name: heat-stack-id
28411 description: Heat stack id corresponding to this instance, managed by MSO
28416 description: Unique ID of VPE connected to this VCE.
28422 summary: create or update an existing entitlement
28424 Create or update an existing entitlement.
28426 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28427 operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement
28436 description: Response codes found in [response codes](https://wiki.onap.org/).
28440 description: Unique id of VNF. This is unique across the graph.
28443 example: __VNF-ID__
28446 description: Unique ID for the entitlement group the resource comes from, should be uuid.
28449 example: __GROUP-UUID__
28450 - name: resource-uuid
28452 description: Unique ID of an entitlement resource.
28455 example: __RESOURCE-UUID__
28458 description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVceEntitlementsEntitlement.json)
28461 $ref: "#/definitions/entitlement"
28465 summary: update an existing entitlement
28467 Update an existing entitlement
28469 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28470 The PUT operation will entirely replace an existing object.
28471 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28473 Other differences between PUT and PATCH are:
28475 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28476 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28477 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28478 operationId: UpdateNetworkVcesVceEntitlementsEntitlement
28487 description: Response codes found in [response codes](https://wiki.onap.org/).
28491 description: Unique id of VNF. This is unique across the graph.
28494 example: __VNF-ID__
28497 description: Unique ID for the entitlement group the resource comes from, should be uuid.
28500 example: __GROUP-UUID__
28501 - name: resource-uuid
28503 description: Unique ID of an entitlement resource.
28506 example: __RESOURCE-UUID__
28509 description: entitlement object that needs to be created or updated.
28512 $ref: "#/patchDefinitions/entitlement"
28516 summary: delete an existing entitlement
28517 description: delete an existing entitlement
28518 operationId: deleteNetworkVcesVceEntitlementsEntitlement
28527 description: Response codes found in [response codes](https://wiki.onap.org/).
28531 description: Unique id of VNF. This is unique across the graph.
28534 example: __VNF-ID__
28537 description: Unique ID for the entitlement group the resource comes from, should be uuid.
28540 example: __GROUP-UUID__
28541 - name: resource-uuid
28543 description: Unique ID of an entitlement resource.
28546 example: __RESOURCE-UUID__
28547 - name: resource-version
28549 description: resource-version for concurrency
28552 /network/vces/vce/{vnf-id}/entitlements:
28556 summary: returns entitlements
28557 description: returns entitlements
28558 operationId: getNetworkVcesVceEntitlements
28564 description: successful operation
28566 $ref: "#/getDefinitions/entitlements"
28568 description: Response codes found in [response codes](https://wiki.onap.org/).
28572 description: Unique id of VNF. This is unique across the graph.
28575 example: __VNF-ID__
28578 description: Name of VNF.
28583 description: Alternate name of VNF.
28588 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
28593 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
28596 - name: regional-resource-zone
28598 description: Regional way of organizing pservers, source of truth should define values
28601 - name: prov-status
28603 description: Trigger for operational monitoring of this resource by Service Assurance systems.
28606 - name: heat-stack-id
28608 description: Heat stack id corresponding to this instance, managed by MSO
28613 description: Unique ID of VPE connected to this VCE.
28616 /network/vces/vce/{vnf-id}/relationship-list/relationship:
28620 summary: see node definition for valid relationships
28621 operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship
28630 description: Response codes found in [response codes](https://wiki.onap.org/).
28634 description: Unique id of VNF. This is unique across the graph.
28637 example: __VNF-ID__
28640 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVce.json)
28643 $ref: "#/definitions/relationship"
28647 summary: delete an existing relationship
28648 description: delete an existing relationship
28649 operationId: deleteNetworkVcesVceRelationshipListRelationship
28658 description: Response codes found in [response codes](https://wiki.onap.org/).
28662 description: Unique id of VNF. This is unique across the graph.
28665 example: __VNF-ID__
28666 /network/vces/vce/{vnf-id}:
28670 summary: returns vce
28671 description: returns vce
28672 operationId: getNetworkVcesVce
28678 description: successful operation
28680 $ref: "#/getDefinitions/vce"
28682 description: Response codes found in [response codes](https://wiki.onap.org/).
28686 description: Unique id of VNF. This is unique across the graph.
28689 example: __VNF-ID__
28692 description: Name of VNF.
28697 description: Alternate name of VNF.
28702 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
28707 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
28710 - name: regional-resource-zone
28712 description: Regional way of organizing pservers, source of truth should define values
28715 - name: prov-status
28717 description: Trigger for operational monitoring of this resource by Service Assurance systems.
28720 - name: heat-stack-id
28722 description: Heat stack id corresponding to this instance, managed by MSO
28727 description: Unique ID of VPE connected to this VCE.
28733 summary: create or update an existing vce
28735 Create or update an existing vce.
28737 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28738 operationId: createOrUpdateNetworkVcesVce
28747 description: Response codes found in [response codes](https://wiki.onap.org/).
28751 description: Unique id of VNF. This is unique across the graph.
28754 example: __VNF-ID__
28757 description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVcesVce.json)
28760 $ref: "#/definitions/vce"
28764 summary: update an existing vce
28766 Update an existing vce
28768 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28769 The PUT operation will entirely replace an existing object.
28770 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28772 Other differences between PUT and PATCH are:
28774 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28775 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28776 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28777 operationId: UpdateNetworkVcesVce
28786 description: Response codes found in [response codes](https://wiki.onap.org/).
28790 description: Unique id of VNF. This is unique across the graph.
28793 example: __VNF-ID__
28796 description: vce object that needs to be created or updated.
28799 $ref: "#/patchDefinitions/vce"
28803 summary: delete an existing vce
28804 description: delete an existing vce
28805 operationId: deleteNetworkVcesVce
28814 description: Response codes found in [response codes](https://wiki.onap.org/).
28818 description: Unique id of VNF. This is unique across the graph.
28821 example: __VNF-ID__
28822 - name: resource-version
28824 description: resource-version for concurrency
28831 summary: returns vces
28832 description: returns vces
28833 operationId: getNetworkVces
28839 description: successful operation
28841 $ref: "#/getDefinitions/vces"
28843 description: Response codes found in [response codes](https://wiki.onap.org/).
28844 /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
28848 summary: see node definition for valid relationships
28849 operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship
28858 description: Response codes found in [response codes](https://wiki.onap.org/).
28862 description: Unique ID of vnfc.
28865 example: __VNFC-NAME__
28868 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVnfcsVnfc.json)
28871 $ref: "#/definitions/relationship"
28875 summary: delete an existing relationship
28876 description: delete an existing relationship
28877 operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship
28886 description: Response codes found in [response codes](https://wiki.onap.org/).
28890 description: Unique ID of vnfc.
28893 example: __VNFC-NAME__
28894 /network/vnfcs/vnfc/{vnfc-name}:
28898 summary: returns vnfc
28899 description: returns vnfc
28900 operationId: getNetworkVnfcsVnfc
28906 description: successful operation
28908 $ref: "#/getDefinitions/vnfc"
28910 description: Response codes found in [response codes](https://wiki.onap.org/).
28914 description: Unique ID of vnfc.
28917 example: __VNFC-NAME__
28918 - name: vnfc-function-code
28920 description: function code
28928 - name: prov-status
28930 description: prov status of this vnfc
28933 - name: ipaddress-v4-oam-vip
28935 description: Oam V4 vip address of this vnfc
28942 - name: is-closed-loop-disabled
28946 - name: group-notation
28948 description: Group notation of VNFC
28954 summary: create or update an existing vnfc
28956 Create or update an existing vnfc.
28958 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
28959 operationId: createOrUpdateNetworkVnfcsVnfc
28968 description: Response codes found in [response codes](https://wiki.onap.org/).
28972 description: Unique ID of vnfc.
28975 example: __VNFC-NAME__
28978 description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkVnfcsVnfc.json)
28981 $ref: "#/definitions/vnfc"
28985 summary: update an existing vnfc
28987 Update an existing vnfc
28989 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28990 The PUT operation will entirely replace an existing object.
28991 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
28993 Other differences between PUT and PATCH are:
28995 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
28996 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28997 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28998 operationId: UpdateNetworkVnfcsVnfc
29007 description: Response codes found in [response codes](https://wiki.onap.org/).
29011 description: Unique ID of vnfc.
29014 example: __VNFC-NAME__
29017 description: vnfc object that needs to be created or updated.
29020 $ref: "#/patchDefinitions/vnfc"
29024 summary: delete an existing vnfc
29025 description: delete an existing vnfc
29026 operationId: deleteNetworkVnfcsVnfc
29035 description: Response codes found in [response codes](https://wiki.onap.org/).
29039 description: Unique ID of vnfc.
29042 example: __VNFC-NAME__
29043 - name: resource-version
29045 description: resource-version for concurrency
29052 summary: returns vnfcs
29053 description: returns vnfcs
29054 operationId: getNetworkVnfcs
29060 description: successful operation
29062 $ref: "#/getDefinitions/vnfcs"
29064 description: Response codes found in [response codes](https://wiki.onap.org/).
29065 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
29069 summary: see node definition for valid relationships
29070 operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
29079 description: Response codes found in [response codes](https://wiki.onap.org/).
29083 description: Network ID, should be uuid. Unique across A&AI.
29086 example: __NETWORK-ID__
29089 description: Subnet ID, should be UUID.
29092 example: __SUBNET-ID__
29095 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
29098 $ref: "#/definitions/relationship"
29102 summary: delete an existing relationship
29103 description: delete an existing relationship
29104 operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
29113 description: Response codes found in [response codes](https://wiki.onap.org/).
29117 description: Network ID, should be uuid. Unique across A&AI.
29120 example: __NETWORK-ID__
29123 description: Subnet ID, should be UUID.
29126 example: __SUBNET-ID__
29127 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}:
29131 summary: returns subnet
29132 description: returns subnet
29133 operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet
29139 description: successful operation
29141 $ref: "#/getDefinitions/subnet"
29143 description: Response codes found in [response codes](https://wiki.onap.org/).
29147 description: Network ID, should be uuid. Unique across A&AI.
29150 example: __NETWORK-ID__
29153 description: Subnet ID, should be UUID.
29156 example: __SUBNET-ID__
29157 - name: network-name
29159 description: Name of the network, governed by some naming convention..
29162 - name: network-role
29164 description: Role the network plans - who defines these values?
29169 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
29172 - name: heat-stack-id
29174 description: Heat stack id corresponding to this instance, managed by MSO
29177 - name: contrail-network-fqdn
29179 description: Contrail FQDN for the network
29182 - name: persona-model-id
29184 description: the ASDC model id for this resource or service model.
29187 - name: persona-model-version
29189 description: the ASDC model version for this resource or service model.
29192 - name: widget-model-id
29194 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
29197 - name: widget-model-version
29199 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
29202 - name: subnet-name
29204 description: Name associated with the subnet.
29210 summary: create or update an existing subnet
29212 Create or update an existing subnet.
29214 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29215 operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet
29224 description: Response codes found in [response codes](https://wiki.onap.org/).
29228 description: Network ID, should be uuid. Unique across A&AI.
29231 example: __NETWORK-ID__
29234 description: Subnet ID, should be UUID.
29237 example: __SUBNET-ID__
29240 description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
29243 $ref: "#/definitions/subnet"
29247 summary: update an existing subnet
29249 Update an existing subnet
29251 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29252 The PUT operation will entirely replace an existing object.
29253 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29255 Other differences between PUT and PATCH are:
29257 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29258 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29259 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29260 operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet
29269 description: Response codes found in [response codes](https://wiki.onap.org/).
29273 description: Network ID, should be uuid. Unique across A&AI.
29276 example: __NETWORK-ID__
29279 description: Subnet ID, should be UUID.
29282 example: __SUBNET-ID__
29285 description: subnet object that needs to be created or updated.
29288 $ref: "#/patchDefinitions/subnet"
29292 summary: delete an existing subnet
29293 description: delete an existing subnet
29294 operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet
29303 description: Response codes found in [response codes](https://wiki.onap.org/).
29307 description: Network ID, should be uuid. Unique across A&AI.
29310 example: __NETWORK-ID__
29313 description: Subnet ID, should be UUID.
29316 example: __SUBNET-ID__
29317 - name: resource-version
29319 description: resource-version for concurrency
29322 /network/l3-networks/l3-network/{network-id}/subnets:
29326 summary: returns subnets
29327 description: returns subnets
29328 operationId: getNetworkL3NetworksL3NetworkSubnets
29334 description: successful operation
29336 $ref: "#/getDefinitions/subnets"
29338 description: Response codes found in [response codes](https://wiki.onap.org/).
29342 description: Network ID, should be uuid. Unique across A&AI.
29345 example: __NETWORK-ID__
29346 - name: network-name
29348 description: Name of the network, governed by some naming convention..
29351 - name: network-role
29353 description: Role the network plans - who defines these values?
29358 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
29361 - name: heat-stack-id
29363 description: Heat stack id corresponding to this instance, managed by MSO
29366 - name: contrail-network-fqdn
29368 description: Contrail FQDN for the network
29371 - name: persona-model-id
29373 description: the ASDC model id for this resource or service model.
29376 - name: persona-model-version
29378 description: the ASDC model version for this resource or service model.
29381 - name: widget-model-id
29383 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
29386 - name: widget-model-version
29388 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
29391 /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship:
29395 summary: see node definition for valid relationships
29396 operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
29405 description: Response codes found in [response codes](https://wiki.onap.org/).
29409 description: Network ID, should be uuid. Unique across A&AI.
29412 example: __NETWORK-ID__
29413 - name: vlan-id-inner
29419 example: __VLAN-ID-INNER__
29422 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
29425 $ref: "#/definitions/relationship"
29429 summary: delete an existing relationship
29430 description: delete an existing relationship
29431 operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
29440 description: Response codes found in [response codes](https://wiki.onap.org/).
29444 description: Network ID, should be uuid. Unique across A&AI.
29447 example: __NETWORK-ID__
29448 - name: vlan-id-inner
29454 example: __VLAN-ID-INNER__
29455 /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}:
29459 summary: returns ctag-assignment
29460 description: returns ctag-assignment
29461 operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
29467 description: successful operation
29469 $ref: "#/getDefinitions/ctag-assignment"
29471 description: Response codes found in [response codes](https://wiki.onap.org/).
29475 description: Network ID, should be uuid. Unique across A&AI.
29478 example: __NETWORK-ID__
29479 - name: vlan-id-inner
29485 example: __VLAN-ID-INNER__
29486 - name: network-name
29488 description: Name of the network, governed by some naming convention..
29491 - name: network-role
29493 description: Role the network plans - who defines these values?
29498 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
29501 - name: heat-stack-id
29503 description: Heat stack id corresponding to this instance, managed by MSO
29506 - name: contrail-network-fqdn
29508 description: Contrail FQDN for the network
29511 - name: persona-model-id
29513 description: the ASDC model id for this resource or service model.
29516 - name: persona-model-version
29518 description: the ASDC model version for this resource or service model.
29521 - name: widget-model-id
29523 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
29526 - name: widget-model-version
29528 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
29534 summary: create or update an existing ctag-assignment
29536 Create or update an existing ctag-assignment.
29538 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29539 operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
29548 description: Response codes found in [response codes](https://wiki.onap.org/).
29552 description: Network ID, should be uuid. Unique across A&AI.
29555 example: __NETWORK-ID__
29556 - name: vlan-id-inner
29562 example: __VLAN-ID-INNER__
29565 description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
29568 $ref: "#/definitions/ctag-assignment"
29572 summary: update an existing ctag-assignment
29574 Update an existing ctag-assignment
29576 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29577 The PUT operation will entirely replace an existing object.
29578 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29580 Other differences between PUT and PATCH are:
29582 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29583 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29584 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29585 operationId: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
29594 description: Response codes found in [response codes](https://wiki.onap.org/).
29598 description: Network ID, should be uuid. Unique across A&AI.
29601 example: __NETWORK-ID__
29602 - name: vlan-id-inner
29608 example: __VLAN-ID-INNER__
29611 description: ctag-assignment object that needs to be created or updated.
29614 $ref: "#/patchDefinitions/ctag-assignment"
29618 summary: delete an existing ctag-assignment
29619 description: delete an existing ctag-assignment
29620 operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
29629 description: Response codes found in [response codes](https://wiki.onap.org/).
29633 description: Network ID, should be uuid. Unique across A&AI.
29636 example: __NETWORK-ID__
29637 - name: vlan-id-inner
29643 example: __VLAN-ID-INNER__
29644 - name: resource-version
29646 description: resource-version for concurrency
29649 /network/l3-networks/l3-network/{network-id}/ctag-assignments:
29653 summary: returns ctag-assignments
29654 description: returns ctag-assignments
29655 operationId: getNetworkL3NetworksL3NetworkCtagAssignments
29661 description: successful operation
29663 $ref: "#/getDefinitions/ctag-assignments"
29665 description: Response codes found in [response codes](https://wiki.onap.org/).
29669 description: Network ID, should be uuid. Unique across A&AI.
29672 example: __NETWORK-ID__
29673 - name: network-name
29675 description: Name of the network, governed by some naming convention..
29678 - name: network-role
29680 description: Role the network plans - who defines these values?
29685 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
29688 - name: heat-stack-id
29690 description: Heat stack id corresponding to this instance, managed by MSO
29693 - name: contrail-network-fqdn
29695 description: Contrail FQDN for the network
29698 - name: persona-model-id
29700 description: the ASDC model id for this resource or service model.
29703 - name: persona-model-version
29705 description: the ASDC model version for this resource or service model.
29708 - name: widget-model-id
29710 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
29713 - name: widget-model-version
29715 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
29718 /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship:
29722 summary: see node definition for valid relationships
29723 operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
29732 description: Response codes found in [response codes](https://wiki.onap.org/).
29736 description: Network ID, should be uuid. Unique across A&AI.
29739 example: __NETWORK-ID__
29740 - name: segmentation-id
29742 description: Route Table Reference id, UUID assigned to this instance.
29745 example: __SEGMENTATION-ID__
29748 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
29751 $ref: "#/definitions/relationship"
29755 summary: delete an existing relationship
29756 description: delete an existing relationship
29757 operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
29766 description: Response codes found in [response codes](https://wiki.onap.org/).
29770 description: Network ID, should be uuid. Unique across A&AI.
29773 example: __NETWORK-ID__
29774 - name: segmentation-id
29776 description: Route Table Reference id, UUID assigned to this instance.
29779 example: __SEGMENTATION-ID__
29780 /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}:
29784 summary: returns segmentation-assignment
29785 description: returns segmentation-assignment
29786 operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
29792 description: successful operation
29794 $ref: "#/getDefinitions/segmentation-assignment"
29796 description: Response codes found in [response codes](https://wiki.onap.org/).
29800 description: Network ID, should be uuid. Unique across A&AI.
29803 example: __NETWORK-ID__
29804 - name: segmentation-id
29806 description: Route Table Reference id, UUID assigned to this instance.
29809 example: __SEGMENTATION-ID__
29810 - name: network-name
29812 description: Name of the network, governed by some naming convention..
29815 - name: network-role
29817 description: Role the network plans - who defines these values?
29822 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
29825 - name: heat-stack-id
29827 description: Heat stack id corresponding to this instance, managed by MSO
29830 - name: contrail-network-fqdn
29832 description: Contrail FQDN for the network
29835 - name: persona-model-id
29837 description: the ASDC model id for this resource or service model.
29840 - name: persona-model-version
29842 description: the ASDC model version for this resource or service model.
29845 - name: widget-model-id
29847 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
29850 - name: widget-model-version
29852 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
29858 summary: create or update an existing segmentation-assignment
29860 Create or update an existing segmentation-assignment.
29862 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
29863 operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
29872 description: Response codes found in [response codes](https://wiki.onap.org/).
29876 description: Network ID, should be uuid. Unique across A&AI.
29879 example: __NETWORK-ID__
29880 - name: segmentation-id
29882 description: Route Table Reference id, UUID assigned to this instance.
29885 example: __SEGMENTATION-ID__
29888 description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
29891 $ref: "#/definitions/segmentation-assignment"
29895 summary: update an existing segmentation-assignment
29897 Update an existing segmentation-assignment
29899 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29900 The PUT operation will entirely replace an existing object.
29901 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
29903 Other differences between PUT and PATCH are:
29905 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
29906 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29907 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29908 operationId: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
29917 description: Response codes found in [response codes](https://wiki.onap.org/).
29921 description: Network ID, should be uuid. Unique across A&AI.
29924 example: __NETWORK-ID__
29925 - name: segmentation-id
29927 description: Route Table Reference id, UUID assigned to this instance.
29930 example: __SEGMENTATION-ID__
29933 description: segmentation-assignment object that needs to be created or updated.
29936 $ref: "#/patchDefinitions/segmentation-assignment"
29940 summary: delete an existing segmentation-assignment
29941 description: delete an existing segmentation-assignment
29942 operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
29951 description: Response codes found in [response codes](https://wiki.onap.org/).
29955 description: Network ID, should be uuid. Unique across A&AI.
29958 example: __NETWORK-ID__
29959 - name: segmentation-id
29961 description: Route Table Reference id, UUID assigned to this instance.
29964 example: __SEGMENTATION-ID__
29965 - name: resource-version
29967 description: resource-version for concurrency
29970 /network/l3-networks/l3-network/{network-id}/segmentation-assignments:
29974 summary: returns segmentation-assignments
29975 description: returns segmentation-assignments
29976 operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments
29982 description: successful operation
29984 $ref: "#/getDefinitions/segmentation-assignments"
29986 description: Response codes found in [response codes](https://wiki.onap.org/).
29990 description: Network ID, should be uuid. Unique across A&AI.
29993 example: __NETWORK-ID__
29994 - name: network-name
29996 description: Name of the network, governed by some naming convention..
29999 - name: network-role
30001 description: Role the network plans - who defines these values?
30006 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
30009 - name: heat-stack-id
30011 description: Heat stack id corresponding to this instance, managed by MSO
30014 - name: contrail-network-fqdn
30016 description: Contrail FQDN for the network
30019 - name: persona-model-id
30021 description: the ASDC model id for this resource or service model.
30024 - name: persona-model-version
30026 description: the ASDC model version for this resource or service model.
30029 - name: widget-model-id
30031 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
30034 - name: widget-model-version
30036 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
30039 /network/l3-networks/l3-network/{network-id}/relationship-list/relationship:
30043 summary: see node definition for valid relationships
30044 operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship
30053 description: Response codes found in [response codes](https://wiki.onap.org/).
30057 description: Network ID, should be uuid. Unique across A&AI.
30060 example: __NETWORK-ID__
30063 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3Network.json)
30066 $ref: "#/definitions/relationship"
30070 summary: delete an existing relationship
30071 description: delete an existing relationship
30072 operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship
30081 description: Response codes found in [response codes](https://wiki.onap.org/).
30085 description: Network ID, should be uuid. Unique across A&AI.
30088 example: __NETWORK-ID__
30089 /network/l3-networks/l3-network/{network-id}:
30093 summary: returns l3-network
30094 description: returns l3-network
30095 operationId: getNetworkL3NetworksL3Network
30101 description: successful operation
30103 $ref: "#/getDefinitions/l3-network"
30105 description: Response codes found in [response codes](https://wiki.onap.org/).
30109 description: Network ID, should be uuid. Unique across A&AI.
30112 example: __NETWORK-ID__
30113 - name: network-name
30115 description: Name of the network, governed by some naming convention..
30118 - name: network-role
30120 description: Role the network plans - who defines these values?
30125 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
30128 - name: heat-stack-id
30130 description: Heat stack id corresponding to this instance, managed by MSO
30133 - name: contrail-network-fqdn
30135 description: Contrail FQDN for the network
30138 - name: persona-model-id
30140 description: the ASDC model id for this resource or service model.
30143 - name: persona-model-version
30145 description: the ASDC model version for this resource or service model.
30148 - name: widget-model-id
30150 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
30153 - name: widget-model-version
30155 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
30161 summary: create or update an existing l3-network
30163 Create or update an existing l3-network.
30165 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30166 operationId: createOrUpdateNetworkL3NetworksL3Network
30175 description: Response codes found in [response codes](https://wiki.onap.org/).
30179 description: Network ID, should be uuid. Unique across A&AI.
30182 example: __NETWORK-ID__
30185 description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkL3NetworksL3Network.json)
30188 $ref: "#/definitions/l3-network"
30192 summary: update an existing l3-network
30194 Update an existing l3-network
30196 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30197 The PUT operation will entirely replace an existing object.
30198 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30200 Other differences between PUT and PATCH are:
30202 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30203 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30204 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30205 operationId: UpdateNetworkL3NetworksL3Network
30214 description: Response codes found in [response codes](https://wiki.onap.org/).
30218 description: Network ID, should be uuid. Unique across A&AI.
30221 example: __NETWORK-ID__
30224 description: l3-network object that needs to be created or updated.
30227 $ref: "#/patchDefinitions/l3-network"
30231 summary: delete an existing l3-network
30232 description: delete an existing l3-network
30233 operationId: deleteNetworkL3NetworksL3Network
30242 description: Response codes found in [response codes](https://wiki.onap.org/).
30246 description: Network ID, should be uuid. Unique across A&AI.
30249 example: __NETWORK-ID__
30250 - name: resource-version
30252 description: resource-version for concurrency
30255 /network/l3-networks:
30259 summary: returns l3-networks
30260 description: returns l3-networks
30261 operationId: getNetworkL3Networks
30267 description: successful operation
30269 $ref: "#/getDefinitions/l3-networks"
30271 description: Response codes found in [response codes](https://wiki.onap.org/).
30272 /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship:
30276 summary: see node definition for valid relationships
30277 operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
30286 description: Response codes found in [response codes](https://wiki.onap.org/).
30288 - name: network-policy-id
30290 description: UUID representing unique key to this instance
30293 example: __NETWORK-POLICY-ID__
30296 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNetworkPoliciesNetworkPolicy.json)
30299 $ref: "#/definitions/relationship"
30303 summary: delete an existing relationship
30304 description: delete an existing relationship
30305 operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
30314 description: Response codes found in [response codes](https://wiki.onap.org/).
30316 - name: network-policy-id
30318 description: UUID representing unique key to this instance
30321 example: __NETWORK-POLICY-ID__
30322 /network/network-policies/network-policy/{network-policy-id}:
30326 summary: returns network-policy
30327 description: returns network-policy
30328 operationId: getNetworkNetworkPoliciesNetworkPolicy
30334 description: successful operation
30336 $ref: "#/getDefinitions/network-policy"
30338 description: Response codes found in [response codes](https://wiki.onap.org/).
30340 - name: network-policy-id
30342 description: UUID representing unique key to this instance
30345 example: __NETWORK-POLICY-ID__
30346 - name: network-policy-fqdn
30348 description: Contrail FQDN for the policy
30354 summary: create or update an existing network-policy
30356 Create or update an existing network-policy.
30358 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30359 operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy
30368 description: Response codes found in [response codes](https://wiki.onap.org/).
30370 - name: network-policy-id
30372 description: UUID representing unique key to this instance
30375 example: __NETWORK-POLICY-ID__
30378 description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNetworkPoliciesNetworkPolicy.json)
30381 $ref: "#/definitions/network-policy"
30385 summary: update an existing network-policy
30387 Update an existing network-policy
30389 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30390 The PUT operation will entirely replace an existing object.
30391 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30393 Other differences between PUT and PATCH are:
30395 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30396 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30397 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30398 operationId: UpdateNetworkNetworkPoliciesNetworkPolicy
30407 description: Response codes found in [response codes](https://wiki.onap.org/).
30409 - name: network-policy-id
30411 description: UUID representing unique key to this instance
30414 example: __NETWORK-POLICY-ID__
30417 description: network-policy object that needs to be created or updated.
30420 $ref: "#/patchDefinitions/network-policy"
30424 summary: delete an existing network-policy
30425 description: delete an existing network-policy
30426 operationId: deleteNetworkNetworkPoliciesNetworkPolicy
30435 description: Response codes found in [response codes](https://wiki.onap.org/).
30437 - name: network-policy-id
30439 description: UUID representing unique key to this instance
30442 example: __NETWORK-POLICY-ID__
30443 - name: resource-version
30445 description: resource-version for concurrency
30448 /network/network-policies:
30452 summary: returns network-policies
30453 description: returns network-policies
30454 operationId: getNetworkNetworkPolicies
30460 description: successful operation
30462 $ref: "#/getDefinitions/network-policies"
30464 description: Response codes found in [response codes](https://wiki.onap.org/).
30465 /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship:
30469 summary: see node definition for valid relationships
30470 operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship
30479 description: Response codes found in [response codes](https://wiki.onap.org/).
30483 description: Unique id of VNF. This is unique across the graph.
30486 example: __VNF-ID__
30489 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnf.json)
30492 $ref: "#/definitions/relationship"
30496 summary: delete an existing relationship
30497 description: delete an existing relationship
30498 operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship
30507 description: Response codes found in [response codes](https://wiki.onap.org/).
30511 description: Unique id of VNF. This is unique across the graph.
30514 example: __VNF-ID__
30515 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
30519 summary: see node definition for valid relationships
30520 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
30529 description: Response codes found in [response codes](https://wiki.onap.org/).
30533 description: Unique id of VNF. This is unique across the graph.
30536 example: __VNF-ID__
30537 - name: interface-name
30539 description: Name given to the interface
30542 example: __INTERFACE-NAME__
30543 - name: vlan-interface
30545 description: String that identifies the interface
30548 example: __VLAN-INTERFACE__
30551 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
30554 $ref: "#/definitions/relationship"
30558 summary: delete an existing relationship
30559 description: delete an existing relationship
30560 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
30569 description: Response codes found in [response codes](https://wiki.onap.org/).
30573 description: Unique id of VNF. This is unique across the graph.
30576 example: __VNF-ID__
30577 - name: interface-name
30579 description: Name given to the interface
30582 example: __INTERFACE-NAME__
30583 - name: vlan-interface
30585 description: String that identifies the interface
30588 example: __VLAN-INTERFACE__
30589 /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:
30593 summary: see node definition for valid relationships
30594 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
30603 description: Response codes found in [response codes](https://wiki.onap.org/).
30607 description: Unique id of VNF. This is unique across the graph.
30610 example: __VNF-ID__
30611 - name: interface-name
30613 description: Name given to the interface
30616 example: __INTERFACE-NAME__
30617 - name: vlan-interface
30619 description: String that identifies the interface
30622 example: __VLAN-INTERFACE__
30623 - name: l3-interface-ipv4-address
30625 description: IP address
30628 example: __L3-INTERFACE-IPV4-ADDRESS__
30631 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
30634 $ref: "#/definitions/relationship"
30638 summary: delete an existing relationship
30639 description: delete an existing relationship
30640 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
30649 description: Response codes found in [response codes](https://wiki.onap.org/).
30653 description: Unique id of VNF. This is unique across the graph.
30656 example: __VNF-ID__
30657 - name: interface-name
30659 description: Name given to the interface
30662 example: __INTERFACE-NAME__
30663 - name: vlan-interface
30665 description: String that identifies the interface
30668 example: __VLAN-INTERFACE__
30669 - name: l3-interface-ipv4-address
30671 description: IP address
30674 example: __L3-INTERFACE-IPV4-ADDRESS__
30675 /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}:
30679 summary: returns l3-interface-ipv4-address-list
30680 description: returns l3-interface-ipv4-address-list
30681 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
30687 description: successful operation
30689 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
30691 description: Response codes found in [response codes](https://wiki.onap.org/).
30695 description: Unique id of VNF. This is unique across the graph.
30698 example: __VNF-ID__
30699 - name: interface-name
30701 description: Name given to the interface
30704 example: __INTERFACE-NAME__
30705 - name: vlan-interface
30707 description: String that identifies the interface
30710 example: __VLAN-INTERFACE__
30711 - name: l3-interface-ipv4-address
30713 description: IP address
30716 example: __L3-INTERFACE-IPV4-ADDRESS__
30719 description: Name of VNF.
30724 description: Alternate name of VNF.
30729 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
30734 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
30737 - name: regional-resource-zone
30739 description: Regional way of organizing pservers, source of truth should define values
30742 - name: prov-status
30744 description: Trigger for operational monitoring of this resource by Service Assurance systems.
30747 - name: heat-stack-id
30749 description: Heat stack id corresponding to this instance, managed by MSO
30756 - name: is-closed-loop-disabled
30760 - name: persona-model-id
30762 description: the ASDC model id for this resource or service model.
30765 - name: persona-model-version
30767 description: the ASDC model version for this resource or service model.
30770 - name: widget-model-id
30772 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
30775 - name: widget-model-version
30777 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
30780 - name: interface-id
30782 description: ID of interface
30787 description: MAC address for the interface
30790 - name: network-name
30792 description: Name of the network
30795 - name: vlan-id-inner
30797 description: Inner VLAN tag
30803 description: This indicates the customers VPN ID associated with this vlan
30806 - name: vlan-id-inner
30808 description: Inner VLAN tag
30812 - name: neutron-network-id
30814 description: Neutron network id of the interface that address belongs to
30817 - name: neutron-subnet-id
30819 description: Neutron id of subnet that address belongs to
30825 summary: create or update an existing l3-interface-ipv4-address-list
30827 Create or update an existing l3-interface-ipv4-address-list.
30829 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
30830 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
30839 description: Response codes found in [response codes](https://wiki.onap.org/).
30843 description: Unique id of VNF. This is unique across the graph.
30846 example: __VNF-ID__
30847 - name: interface-name
30849 description: Name given to the interface
30852 example: __INTERFACE-NAME__
30853 - name: vlan-interface
30855 description: String that identifies the interface
30858 example: __VLAN-INTERFACE__
30859 - name: l3-interface-ipv4-address
30861 description: IP address
30864 example: __L3-INTERFACE-IPV4-ADDRESS__
30867 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
30870 $ref: "#/definitions/l3-interface-ipv4-address-list"
30874 summary: update an existing l3-interface-ipv4-address-list
30876 Update an existing l3-interface-ipv4-address-list
30878 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30879 The PUT operation will entirely replace an existing object.
30880 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
30882 Other differences between PUT and PATCH are:
30884 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
30885 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30886 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30887 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
30896 description: Response codes found in [response codes](https://wiki.onap.org/).
30900 description: Unique id of VNF. This is unique across the graph.
30903 example: __VNF-ID__
30904 - name: interface-name
30906 description: Name given to the interface
30909 example: __INTERFACE-NAME__
30910 - name: vlan-interface
30912 description: String that identifies the interface
30915 example: __VLAN-INTERFACE__
30916 - name: l3-interface-ipv4-address
30918 description: IP address
30921 example: __L3-INTERFACE-IPV4-ADDRESS__
30924 description: l3-interface-ipv4-address-list object that needs to be created or updated.
30927 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
30931 summary: delete an existing l3-interface-ipv4-address-list
30932 description: delete an existing l3-interface-ipv4-address-list
30933 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
30942 description: Response codes found in [response codes](https://wiki.onap.org/).
30946 description: Unique id of VNF. This is unique across the graph.
30949 example: __VNF-ID__
30950 - name: interface-name
30952 description: Name given to the interface
30955 example: __INTERFACE-NAME__
30956 - name: vlan-interface
30958 description: String that identifies the interface
30961 example: __VLAN-INTERFACE__
30962 - name: l3-interface-ipv4-address
30964 description: IP address
30967 example: __L3-INTERFACE-IPV4-ADDRESS__
30968 - name: resource-version
30970 description: resource-version for concurrency
30973 /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:
30977 summary: see node definition for valid relationships
30978 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
30987 description: Response codes found in [response codes](https://wiki.onap.org/).
30991 description: Unique id of VNF. This is unique across the graph.
30994 example: __VNF-ID__
30995 - name: interface-name
30997 description: Name given to the interface
31000 example: __INTERFACE-NAME__
31001 - name: vlan-interface
31003 description: String that identifies the interface
31006 example: __VLAN-INTERFACE__
31007 - name: l3-interface-ipv6-address
31009 description: IP address
31012 example: __L3-INTERFACE-IPV6-ADDRESS__
31015 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
31018 $ref: "#/definitions/relationship"
31022 summary: delete an existing relationship
31023 description: delete an existing relationship
31024 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
31033 description: Response codes found in [response codes](https://wiki.onap.org/).
31037 description: Unique id of VNF. This is unique across the graph.
31040 example: __VNF-ID__
31041 - name: interface-name
31043 description: Name given to the interface
31046 example: __INTERFACE-NAME__
31047 - name: vlan-interface
31049 description: String that identifies the interface
31052 example: __VLAN-INTERFACE__
31053 - name: l3-interface-ipv6-address
31055 description: IP address
31058 example: __L3-INTERFACE-IPV6-ADDRESS__
31059 /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}:
31063 summary: returns l3-interface-ipv6-address-list
31064 description: returns l3-interface-ipv6-address-list
31065 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31071 description: successful operation
31073 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
31075 description: Response codes found in [response codes](https://wiki.onap.org/).
31079 description: Unique id of VNF. This is unique across the graph.
31082 example: __VNF-ID__
31083 - name: interface-name
31085 description: Name given to the interface
31088 example: __INTERFACE-NAME__
31089 - name: vlan-interface
31091 description: String that identifies the interface
31094 example: __VLAN-INTERFACE__
31095 - name: l3-interface-ipv6-address
31097 description: IP address
31100 example: __L3-INTERFACE-IPV6-ADDRESS__
31103 description: Name of VNF.
31108 description: Alternate name of VNF.
31113 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
31118 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
31121 - name: regional-resource-zone
31123 description: Regional way of organizing pservers, source of truth should define values
31126 - name: prov-status
31128 description: Trigger for operational monitoring of this resource by Service Assurance systems.
31131 - name: heat-stack-id
31133 description: Heat stack id corresponding to this instance, managed by MSO
31140 - name: is-closed-loop-disabled
31144 - name: persona-model-id
31146 description: the ASDC model id for this resource or service model.
31149 - name: persona-model-version
31151 description: the ASDC model version for this resource or service model.
31154 - name: widget-model-id
31156 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
31159 - name: widget-model-version
31161 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
31164 - name: interface-id
31166 description: ID of interface
31171 description: MAC address for the interface
31174 - name: network-name
31176 description: Name of the network
31179 - name: vlan-id-inner
31181 description: Inner VLAN tag
31187 description: This indicates the customers VPN ID associated with this vlan
31190 - name: vlan-id-inner
31192 description: Inner VLAN tag
31196 - name: neutron-network-id
31198 description: Neutron network id of the interface that address belongs to
31201 - name: neutron-subnet-id
31203 description: Neutron id of subnet that address belongs to
31209 summary: create or update an existing l3-interface-ipv6-address-list
31211 Create or update an existing l3-interface-ipv6-address-list.
31213 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31214 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31223 description: Response codes found in [response codes](https://wiki.onap.org/).
31227 description: Unique id of VNF. This is unique across the graph.
31230 example: __VNF-ID__
31231 - name: interface-name
31233 description: Name given to the interface
31236 example: __INTERFACE-NAME__
31237 - name: vlan-interface
31239 description: String that identifies the interface
31242 example: __VLAN-INTERFACE__
31243 - name: l3-interface-ipv6-address
31245 description: IP address
31248 example: __L3-INTERFACE-IPV6-ADDRESS__
31251 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
31254 $ref: "#/definitions/l3-interface-ipv6-address-list"
31258 summary: update an existing l3-interface-ipv6-address-list
31260 Update an existing l3-interface-ipv6-address-list
31262 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31263 The PUT operation will entirely replace an existing object.
31264 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31266 Other differences between PUT and PATCH are:
31268 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31269 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31270 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31271 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31280 description: Response codes found in [response codes](https://wiki.onap.org/).
31284 description: Unique id of VNF. This is unique across the graph.
31287 example: __VNF-ID__
31288 - name: interface-name
31290 description: Name given to the interface
31293 example: __INTERFACE-NAME__
31294 - name: vlan-interface
31296 description: String that identifies the interface
31299 example: __VLAN-INTERFACE__
31300 - name: l3-interface-ipv6-address
31302 description: IP address
31305 example: __L3-INTERFACE-IPV6-ADDRESS__
31308 description: l3-interface-ipv6-address-list object that needs to be created or updated.
31311 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
31315 summary: delete an existing l3-interface-ipv6-address-list
31316 description: delete an existing l3-interface-ipv6-address-list
31317 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31326 description: Response codes found in [response codes](https://wiki.onap.org/).
31330 description: Unique id of VNF. This is unique across the graph.
31333 example: __VNF-ID__
31334 - name: interface-name
31336 description: Name given to the interface
31339 example: __INTERFACE-NAME__
31340 - name: vlan-interface
31342 description: String that identifies the interface
31345 example: __VLAN-INTERFACE__
31346 - name: l3-interface-ipv6-address
31348 description: IP address
31351 example: __L3-INTERFACE-IPV6-ADDRESS__
31352 - name: resource-version
31354 description: resource-version for concurrency
31357 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
31361 summary: returns vlan
31362 description: returns vlan
31363 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
31369 description: successful operation
31371 $ref: "#/getDefinitions/vlan"
31373 description: Response codes found in [response codes](https://wiki.onap.org/).
31377 description: Unique id of VNF. This is unique across the graph.
31380 example: __VNF-ID__
31381 - name: interface-name
31383 description: Name given to the interface
31386 example: __INTERFACE-NAME__
31387 - name: vlan-interface
31389 description: String that identifies the interface
31392 example: __VLAN-INTERFACE__
31395 description: Name of VNF.
31400 description: Alternate name of VNF.
31405 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
31410 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
31413 - name: regional-resource-zone
31415 description: Regional way of organizing pservers, source of truth should define values
31418 - name: prov-status
31420 description: Trigger for operational monitoring of this resource by Service Assurance systems.
31423 - name: heat-stack-id
31425 description: Heat stack id corresponding to this instance, managed by MSO
31432 - name: is-closed-loop-disabled
31436 - name: persona-model-id
31438 description: the ASDC model id for this resource or service model.
31441 - name: persona-model-version
31443 description: the ASDC model version for this resource or service model.
31446 - name: widget-model-id
31448 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
31451 - name: widget-model-version
31453 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
31456 - name: interface-id
31458 description: ID of interface
31463 description: MAC address for the interface
31466 - name: network-name
31468 description: Name of the network
31471 - name: vlan-id-inner
31473 description: Inner VLAN tag
31479 description: This indicates the customers VPN ID associated with this vlan
31485 summary: create or update an existing vlan
31487 Create or update an existing vlan.
31489 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31490 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
31499 description: Response codes found in [response codes](https://wiki.onap.org/).
31503 description: Unique id of VNF. This is unique across the graph.
31506 example: __VNF-ID__
31507 - name: interface-name
31509 description: Name given to the interface
31512 example: __INTERFACE-NAME__
31513 - name: vlan-interface
31515 description: String that identifies the interface
31518 example: __VLAN-INTERFACE__
31521 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
31524 $ref: "#/definitions/vlan"
31528 summary: update an existing vlan
31530 Update an existing vlan
31532 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31533 The PUT operation will entirely replace an existing object.
31534 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31536 Other differences between PUT and PATCH are:
31538 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31539 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31540 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31541 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
31550 description: Response codes found in [response codes](https://wiki.onap.org/).
31554 description: Unique id of VNF. This is unique across the graph.
31557 example: __VNF-ID__
31558 - name: interface-name
31560 description: Name given to the interface
31563 example: __INTERFACE-NAME__
31564 - name: vlan-interface
31566 description: String that identifies the interface
31569 example: __VLAN-INTERFACE__
31572 description: vlan object that needs to be created or updated.
31575 $ref: "#/patchDefinitions/vlan"
31579 summary: delete an existing vlan
31580 description: delete an existing vlan
31581 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
31590 description: Response codes found in [response codes](https://wiki.onap.org/).
31594 description: Unique id of VNF. This is unique across the graph.
31597 example: __VNF-ID__
31598 - name: interface-name
31600 description: Name given to the interface
31603 example: __INTERFACE-NAME__
31604 - name: vlan-interface
31606 description: String that identifies the interface
31609 example: __VLAN-INTERFACE__
31610 - name: resource-version
31612 description: resource-version for concurrency
31615 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans:
31619 summary: returns vlans
31620 description: returns vlans
31621 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans
31627 description: successful operation
31629 $ref: "#/getDefinitions/vlans"
31631 description: Response codes found in [response codes](https://wiki.onap.org/).
31635 description: Unique id of VNF. This is unique across the graph.
31638 example: __VNF-ID__
31639 - name: interface-name
31641 description: Name given to the interface
31644 example: __INTERFACE-NAME__
31647 description: Name of VNF.
31652 description: Alternate name of VNF.
31657 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
31662 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
31665 - name: regional-resource-zone
31667 description: Regional way of organizing pservers, source of truth should define values
31670 - name: prov-status
31672 description: Trigger for operational monitoring of this resource by Service Assurance systems.
31675 - name: heat-stack-id
31677 description: Heat stack id corresponding to this instance, managed by MSO
31684 - name: is-closed-loop-disabled
31688 - name: persona-model-id
31690 description: the ASDC model id for this resource or service model.
31693 - name: persona-model-version
31695 description: the ASDC model version for this resource or service model.
31698 - name: widget-model-id
31700 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
31703 - name: widget-model-version
31705 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
31708 - name: interface-id
31710 description: ID of interface
31715 description: MAC address for the interface
31718 - name: network-name
31720 description: Name of the network
31723 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
31727 summary: see node definition for valid relationships
31728 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
31737 description: Response codes found in [response codes](https://wiki.onap.org/).
31741 description: Unique id of VNF. This is unique across the graph.
31744 example: __VNF-ID__
31745 - name: interface-name
31747 description: Name given to the interface
31750 example: __INTERFACE-NAME__
31753 description: PCI ID used to identify the sriov-vf
31756 example: __PCI-ID__
31759 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
31762 $ref: "#/definitions/relationship"
31766 summary: delete an existing relationship
31767 description: delete an existing relationship
31768 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
31777 description: Response codes found in [response codes](https://wiki.onap.org/).
31781 description: Unique id of VNF. This is unique across the graph.
31784 example: __VNF-ID__
31785 - name: interface-name
31787 description: Name given to the interface
31790 example: __INTERFACE-NAME__
31793 description: PCI ID used to identify the sriov-vf
31796 example: __PCI-ID__
31797 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
31801 summary: returns sriov-vf
31802 description: returns sriov-vf
31803 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
31809 description: successful operation
31811 $ref: "#/getDefinitions/sriov-vf"
31813 description: Response codes found in [response codes](https://wiki.onap.org/).
31817 description: Unique id of VNF. This is unique across the graph.
31820 example: __VNF-ID__
31821 - name: interface-name
31823 description: Name given to the interface
31826 example: __INTERFACE-NAME__
31829 description: PCI ID used to identify the sriov-vf
31832 example: __PCI-ID__
31835 description: Name of VNF.
31840 description: Alternate name of VNF.
31845 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
31850 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
31853 - name: regional-resource-zone
31855 description: Regional way of organizing pservers, source of truth should define values
31858 - name: prov-status
31860 description: Trigger for operational monitoring of this resource by Service Assurance systems.
31863 - name: heat-stack-id
31865 description: Heat stack id corresponding to this instance, managed by MSO
31872 - name: is-closed-loop-disabled
31876 - name: persona-model-id
31878 description: the ASDC model id for this resource or service model.
31881 - name: persona-model-version
31883 description: the ASDC model version for this resource or service model.
31886 - name: widget-model-id
31888 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
31891 - name: widget-model-version
31893 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
31896 - name: interface-id
31898 description: ID of interface
31903 description: MAC address for the interface
31906 - name: network-name
31908 description: Name of the network
31911 - name: vf-vlan-filter
31913 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
31916 - name: vf-mac-filter
31918 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
31921 - name: vf-vlan-strip
31923 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
31926 - name: neutron-network-id
31928 description: Neutron network id of the interface
31934 summary: create or update an existing sriov-vf
31936 Create or update an existing sriov-vf.
31938 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
31939 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
31948 description: Response codes found in [response codes](https://wiki.onap.org/).
31952 description: Unique id of VNF. This is unique across the graph.
31955 example: __VNF-ID__
31956 - name: interface-name
31958 description: Name given to the interface
31961 example: __INTERFACE-NAME__
31964 description: PCI ID used to identify the sriov-vf
31967 example: __PCI-ID__
31970 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
31973 $ref: "#/definitions/sriov-vf"
31977 summary: update an existing sriov-vf
31979 Update an existing sriov-vf
31981 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31982 The PUT operation will entirely replace an existing object.
31983 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
31985 Other differences between PUT and PATCH are:
31987 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
31988 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31989 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31990 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
31999 description: Response codes found in [response codes](https://wiki.onap.org/).
32003 description: Unique id of VNF. This is unique across the graph.
32006 example: __VNF-ID__
32007 - name: interface-name
32009 description: Name given to the interface
32012 example: __INTERFACE-NAME__
32015 description: PCI ID used to identify the sriov-vf
32018 example: __PCI-ID__
32021 description: sriov-vf object that needs to be created or updated.
32024 $ref: "#/patchDefinitions/sriov-vf"
32028 summary: delete an existing sriov-vf
32029 description: delete an existing sriov-vf
32030 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
32039 description: Response codes found in [response codes](https://wiki.onap.org/).
32043 description: Unique id of VNF. This is unique across the graph.
32046 example: __VNF-ID__
32047 - name: interface-name
32049 description: Name given to the interface
32052 example: __INTERFACE-NAME__
32055 description: PCI ID used to identify the sriov-vf
32058 example: __PCI-ID__
32059 - name: resource-version
32061 description: resource-version for concurrency
32064 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
32068 summary: returns sriov-vfs
32069 description: returns sriov-vfs
32070 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs
32076 description: successful operation
32078 $ref: "#/getDefinitions/sriov-vfs"
32080 description: Response codes found in [response codes](https://wiki.onap.org/).
32084 description: Unique id of VNF. This is unique across the graph.
32087 example: __VNF-ID__
32088 - name: interface-name
32090 description: Name given to the interface
32093 example: __INTERFACE-NAME__
32096 description: Name of VNF.
32101 description: Alternate name of VNF.
32106 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
32111 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
32114 - name: regional-resource-zone
32116 description: Regional way of organizing pservers, source of truth should define values
32119 - name: prov-status
32121 description: Trigger for operational monitoring of this resource by Service Assurance systems.
32124 - name: heat-stack-id
32126 description: Heat stack id corresponding to this instance, managed by MSO
32133 - name: is-closed-loop-disabled
32137 - name: persona-model-id
32139 description: the ASDC model id for this resource or service model.
32142 - name: persona-model-version
32144 description: the ASDC model version for this resource or service model.
32147 - name: widget-model-id
32149 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32152 - name: widget-model-version
32154 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32157 - name: interface-id
32159 description: ID of interface
32164 description: MAC address for the interface
32167 - name: network-name
32169 description: Name of the network
32172 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
32176 summary: see node definition for valid relationships
32177 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
32186 description: Response codes found in [response codes](https://wiki.onap.org/).
32190 description: Unique id of VNF. This is unique across the graph.
32193 example: __VNF-ID__
32194 - name: interface-name
32196 description: Name given to the interface
32199 example: __INTERFACE-NAME__
32202 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
32205 $ref: "#/definitions/relationship"
32209 summary: delete an existing relationship
32210 description: delete an existing relationship
32211 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
32220 description: Response codes found in [response codes](https://wiki.onap.org/).
32224 description: Unique id of VNF. This is unique across the graph.
32227 example: __VNF-ID__
32228 - name: interface-name
32230 description: Name given to the interface
32233 example: __INTERFACE-NAME__
32234 /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:
32238 summary: see node definition for valid relationships
32239 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
32248 description: Response codes found in [response codes](https://wiki.onap.org/).
32252 description: Unique id of VNF. This is unique across the graph.
32255 example: __VNF-ID__
32256 - name: interface-name
32258 description: Name given to the interface
32261 example: __INTERFACE-NAME__
32262 - name: l3-interface-ipv4-address
32264 description: IP address
32267 example: __L3-INTERFACE-IPV4-ADDRESS__
32270 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
32273 $ref: "#/definitions/relationship"
32277 summary: delete an existing relationship
32278 description: delete an existing relationship
32279 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
32288 description: Response codes found in [response codes](https://wiki.onap.org/).
32292 description: Unique id of VNF. This is unique across the graph.
32295 example: __VNF-ID__
32296 - name: interface-name
32298 description: Name given to the interface
32301 example: __INTERFACE-NAME__
32302 - name: l3-interface-ipv4-address
32304 description: IP address
32307 example: __L3-INTERFACE-IPV4-ADDRESS__
32308 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
32312 summary: returns l3-interface-ipv4-address-list
32313 description: returns l3-interface-ipv4-address-list
32314 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32320 description: successful operation
32322 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
32324 description: Response codes found in [response codes](https://wiki.onap.org/).
32328 description: Unique id of VNF. This is unique across the graph.
32331 example: __VNF-ID__
32332 - name: interface-name
32334 description: Name given to the interface
32337 example: __INTERFACE-NAME__
32338 - name: l3-interface-ipv4-address
32340 description: IP address
32343 example: __L3-INTERFACE-IPV4-ADDRESS__
32346 description: Name of VNF.
32351 description: Alternate name of VNF.
32356 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
32361 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
32364 - name: regional-resource-zone
32366 description: Regional way of organizing pservers, source of truth should define values
32369 - name: prov-status
32371 description: Trigger for operational monitoring of this resource by Service Assurance systems.
32374 - name: heat-stack-id
32376 description: Heat stack id corresponding to this instance, managed by MSO
32383 - name: is-closed-loop-disabled
32387 - name: persona-model-id
32389 description: the ASDC model id for this resource or service model.
32392 - name: persona-model-version
32394 description: the ASDC model version for this resource or service model.
32397 - name: widget-model-id
32399 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32402 - name: widget-model-version
32404 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32407 - name: interface-id
32409 description: ID of interface
32414 description: MAC address for the interface
32417 - name: network-name
32419 description: Name of the network
32422 - name: vlan-id-inner
32424 description: Inner VLAN tag
32428 - name: neutron-network-id
32430 description: Neutron network id of the interface that address belongs to
32433 - name: neutron-subnet-id
32435 description: Neutron id of subnet that address belongs to
32441 summary: create or update an existing l3-interface-ipv4-address-list
32443 Create or update an existing l3-interface-ipv4-address-list.
32445 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32446 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32455 description: Response codes found in [response codes](https://wiki.onap.org/).
32459 description: Unique id of VNF. This is unique across the graph.
32462 example: __VNF-ID__
32463 - name: interface-name
32465 description: Name given to the interface
32468 example: __INTERFACE-NAME__
32469 - name: l3-interface-ipv4-address
32471 description: IP address
32474 example: __L3-INTERFACE-IPV4-ADDRESS__
32477 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
32480 $ref: "#/definitions/l3-interface-ipv4-address-list"
32484 summary: update an existing l3-interface-ipv4-address-list
32486 Update an existing l3-interface-ipv4-address-list
32488 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32489 The PUT operation will entirely replace an existing object.
32490 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32492 Other differences between PUT and PATCH are:
32494 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32495 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32496 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32497 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32506 description: Response codes found in [response codes](https://wiki.onap.org/).
32510 description: Unique id of VNF. This is unique across the graph.
32513 example: __VNF-ID__
32514 - name: interface-name
32516 description: Name given to the interface
32519 example: __INTERFACE-NAME__
32520 - name: l3-interface-ipv4-address
32522 description: IP address
32525 example: __L3-INTERFACE-IPV4-ADDRESS__
32528 description: l3-interface-ipv4-address-list object that needs to be created or updated.
32531 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
32535 summary: delete an existing l3-interface-ipv4-address-list
32536 description: delete an existing l3-interface-ipv4-address-list
32537 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32546 description: Response codes found in [response codes](https://wiki.onap.org/).
32550 description: Unique id of VNF. This is unique across the graph.
32553 example: __VNF-ID__
32554 - name: interface-name
32556 description: Name given to the interface
32559 example: __INTERFACE-NAME__
32560 - name: l3-interface-ipv4-address
32562 description: IP address
32565 example: __L3-INTERFACE-IPV4-ADDRESS__
32566 - name: resource-version
32568 description: resource-version for concurrency
32571 /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:
32575 summary: see node definition for valid relationships
32576 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
32585 description: Response codes found in [response codes](https://wiki.onap.org/).
32589 description: Unique id of VNF. This is unique across the graph.
32592 example: __VNF-ID__
32593 - name: interface-name
32595 description: Name given to the interface
32598 example: __INTERFACE-NAME__
32599 - name: l3-interface-ipv6-address
32601 description: IP address
32604 example: __L3-INTERFACE-IPV6-ADDRESS__
32607 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
32610 $ref: "#/definitions/relationship"
32614 summary: delete an existing relationship
32615 description: delete an existing relationship
32616 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
32625 description: Response codes found in [response codes](https://wiki.onap.org/).
32629 description: Unique id of VNF. This is unique across the graph.
32632 example: __VNF-ID__
32633 - name: interface-name
32635 description: Name given to the interface
32638 example: __INTERFACE-NAME__
32639 - name: l3-interface-ipv6-address
32641 description: IP address
32644 example: __L3-INTERFACE-IPV6-ADDRESS__
32645 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
32649 summary: returns l3-interface-ipv6-address-list
32650 description: returns l3-interface-ipv6-address-list
32651 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
32657 description: successful operation
32659 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
32661 description: Response codes found in [response codes](https://wiki.onap.org/).
32665 description: Unique id of VNF. This is unique across the graph.
32668 example: __VNF-ID__
32669 - name: interface-name
32671 description: Name given to the interface
32674 example: __INTERFACE-NAME__
32675 - name: l3-interface-ipv6-address
32677 description: IP address
32680 example: __L3-INTERFACE-IPV6-ADDRESS__
32683 description: Name of VNF.
32688 description: Alternate name of VNF.
32693 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
32698 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
32701 - name: regional-resource-zone
32703 description: Regional way of organizing pservers, source of truth should define values
32706 - name: prov-status
32708 description: Trigger for operational monitoring of this resource by Service Assurance systems.
32711 - name: heat-stack-id
32713 description: Heat stack id corresponding to this instance, managed by MSO
32720 - name: is-closed-loop-disabled
32724 - name: persona-model-id
32726 description: the ASDC model id for this resource or service model.
32729 - name: persona-model-version
32731 description: the ASDC model version for this resource or service model.
32734 - name: widget-model-id
32736 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32739 - name: widget-model-version
32741 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32744 - name: interface-id
32746 description: ID of interface
32751 description: MAC address for the interface
32754 - name: network-name
32756 description: Name of the network
32759 - name: vlan-id-inner
32761 description: Inner VLAN tag
32765 - name: neutron-network-id
32767 description: Neutron network id of the interface that address belongs to
32770 - name: neutron-subnet-id
32772 description: Neutron id of subnet that address belongs to
32778 summary: create or update an existing l3-interface-ipv6-address-list
32780 Create or update an existing l3-interface-ipv6-address-list.
32782 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
32783 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
32792 description: Response codes found in [response codes](https://wiki.onap.org/).
32796 description: Unique id of VNF. This is unique across the graph.
32799 example: __VNF-ID__
32800 - name: interface-name
32802 description: Name given to the interface
32805 example: __INTERFACE-NAME__
32806 - name: l3-interface-ipv6-address
32808 description: IP address
32811 example: __L3-INTERFACE-IPV6-ADDRESS__
32814 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
32817 $ref: "#/definitions/l3-interface-ipv6-address-list"
32821 summary: update an existing l3-interface-ipv6-address-list
32823 Update an existing l3-interface-ipv6-address-list
32825 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32826 The PUT operation will entirely replace an existing object.
32827 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
32829 Other differences between PUT and PATCH are:
32831 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
32832 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32833 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32834 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
32843 description: Response codes found in [response codes](https://wiki.onap.org/).
32847 description: Unique id of VNF. This is unique across the graph.
32850 example: __VNF-ID__
32851 - name: interface-name
32853 description: Name given to the interface
32856 example: __INTERFACE-NAME__
32857 - name: l3-interface-ipv6-address
32859 description: IP address
32862 example: __L3-INTERFACE-IPV6-ADDRESS__
32865 description: l3-interface-ipv6-address-list object that needs to be created or updated.
32868 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
32872 summary: delete an existing l3-interface-ipv6-address-list
32873 description: delete an existing l3-interface-ipv6-address-list
32874 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
32883 description: Response codes found in [response codes](https://wiki.onap.org/).
32887 description: Unique id of VNF. This is unique across the graph.
32890 example: __VNF-ID__
32891 - name: interface-name
32893 description: Name given to the interface
32896 example: __INTERFACE-NAME__
32897 - name: l3-interface-ipv6-address
32899 description: IP address
32902 example: __L3-INTERFACE-IPV6-ADDRESS__
32903 - name: resource-version
32905 description: resource-version for concurrency
32908 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}:
32912 summary: returns l-interface
32913 description: returns l-interface
32914 operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface
32920 description: successful operation
32922 $ref: "#/getDefinitions/l-interface"
32924 description: Response codes found in [response codes](https://wiki.onap.org/).
32928 description: Unique id of VNF. This is unique across the graph.
32931 example: __VNF-ID__
32932 - name: interface-name
32934 description: Name given to the interface
32937 example: __INTERFACE-NAME__
32940 description: Name of VNF.
32945 description: Alternate name of VNF.
32950 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
32955 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
32958 - name: regional-resource-zone
32960 description: Regional way of organizing pservers, source of truth should define values
32963 - name: prov-status
32965 description: Trigger for operational monitoring of this resource by Service Assurance systems.
32968 - name: heat-stack-id
32970 description: Heat stack id corresponding to this instance, managed by MSO
32977 - name: is-closed-loop-disabled
32981 - name: persona-model-id
32983 description: the ASDC model id for this resource or service model.
32986 - name: persona-model-version
32988 description: the ASDC model version for this resource or service model.
32991 - name: widget-model-id
32993 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32996 - name: widget-model-version
32998 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33001 - name: interface-id
33003 description: ID of interface
33008 description: MAC address for the interface
33011 - name: network-name
33013 description: Name of the network
33019 summary: create or update an existing l-interface
33021 Create or update an existing l-interface.
33023 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33024 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
33033 description: Response codes found in [response codes](https://wiki.onap.org/).
33037 description: Unique id of VNF. This is unique across the graph.
33040 example: __VNF-ID__
33041 - name: interface-name
33043 description: Name given to the interface
33046 example: __INTERFACE-NAME__
33049 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
33052 $ref: "#/definitions/l-interface"
33056 summary: update an existing l-interface
33058 Update an existing l-interface
33060 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33061 The PUT operation will entirely replace an existing object.
33062 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33064 Other differences between PUT and PATCH are:
33066 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33067 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33068 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33069 operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
33078 description: Response codes found in [response codes](https://wiki.onap.org/).
33082 description: Unique id of VNF. This is unique across the graph.
33085 example: __VNF-ID__
33086 - name: interface-name
33088 description: Name given to the interface
33091 example: __INTERFACE-NAME__
33094 description: l-interface object that needs to be created or updated.
33097 $ref: "#/patchDefinitions/l-interface"
33101 summary: delete an existing l-interface
33102 description: delete an existing l-interface
33103 operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface
33112 description: Response codes found in [response codes](https://wiki.onap.org/).
33116 description: Unique id of VNF. This is unique across the graph.
33119 example: __VNF-ID__
33120 - name: interface-name
33122 description: Name given to the interface
33125 example: __INTERFACE-NAME__
33126 - name: resource-version
33128 description: resource-version for concurrency
33131 /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces:
33135 summary: returns l-interfaces
33136 description: returns l-interfaces
33137 operationId: getNetworkGenericVnfsGenericVnfLInterfaces
33143 description: successful operation
33145 $ref: "#/getDefinitions/l-interfaces"
33147 description: Response codes found in [response codes](https://wiki.onap.org/).
33151 description: Unique id of VNF. This is unique across the graph.
33154 example: __VNF-ID__
33157 description: Name of VNF.
33162 description: Alternate name of VNF.
33167 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
33172 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
33175 - name: regional-resource-zone
33177 description: Regional way of organizing pservers, source of truth should define values
33180 - name: prov-status
33182 description: Trigger for operational monitoring of this resource by Service Assurance systems.
33185 - name: heat-stack-id
33187 description: Heat stack id corresponding to this instance, managed by MSO
33194 - name: is-closed-loop-disabled
33198 - name: persona-model-id
33200 description: the ASDC model id for this resource or service model.
33203 - name: persona-model-version
33205 description: the ASDC model version for this resource or service model.
33208 - name: widget-model-id
33210 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33213 - name: widget-model-version
33215 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33218 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
33222 summary: see node definition for valid relationships
33223 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
33232 description: Response codes found in [response codes](https://wiki.onap.org/).
33236 description: Unique id of VNF. This is unique across the graph.
33239 example: __VNF-ID__
33240 - name: interface-name
33242 description: Name that identifies the link aggregate interface
33245 example: __INTERFACE-NAME__
33248 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
33251 $ref: "#/definitions/relationship"
33255 summary: delete an existing relationship
33256 description: delete an existing relationship
33257 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
33266 description: Response codes found in [response codes](https://wiki.onap.org/).
33270 description: Unique id of VNF. This is unique across the graph.
33273 example: __VNF-ID__
33274 - name: interface-name
33276 description: Name that identifies the link aggregate interface
33279 example: __INTERFACE-NAME__
33280 /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:
33284 summary: see node definition for valid relationships
33285 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
33294 description: Response codes found in [response codes](https://wiki.onap.org/).
33298 description: Unique id of VNF. This is unique across the graph.
33301 example: __VNF-ID__
33302 - name: interface-name
33304 description: Name that identifies the link aggregate interface
33307 example: __INTERFACE-NAME__
33308 - name: interface-name
33310 description: Name given to the interface
33313 example: __INTERFACE-NAME__
33314 - name: vlan-interface
33316 description: String that identifies the interface
33319 example: __VLAN-INTERFACE__
33322 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
33325 $ref: "#/definitions/relationship"
33329 summary: delete an existing relationship
33330 description: delete an existing relationship
33331 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
33340 description: Response codes found in [response codes](https://wiki.onap.org/).
33344 description: Unique id of VNF. This is unique across the graph.
33347 example: __VNF-ID__
33348 - name: interface-name
33350 description: Name that identifies the link aggregate interface
33353 example: __INTERFACE-NAME__
33354 - name: interface-name
33356 description: Name given to the interface
33359 example: __INTERFACE-NAME__
33360 - name: vlan-interface
33362 description: String that identifies the interface
33365 example: __VLAN-INTERFACE__
33366 /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:
33370 summary: see node definition for valid relationships
33371 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
33380 description: Response codes found in [response codes](https://wiki.onap.org/).
33384 description: Unique id of VNF. This is unique across the graph.
33387 example: __VNF-ID__
33388 - name: interface-name
33390 description: Name that identifies the link aggregate interface
33393 example: __INTERFACE-NAME__
33394 - name: interface-name
33396 description: Name given to the interface
33399 example: __INTERFACE-NAME__
33400 - name: vlan-interface
33402 description: String that identifies the interface
33405 example: __VLAN-INTERFACE__
33406 - name: l3-interface-ipv4-address
33408 description: IP address
33411 example: __L3-INTERFACE-IPV4-ADDRESS__
33414 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
33417 $ref: "#/definitions/relationship"
33421 summary: delete an existing relationship
33422 description: delete an existing relationship
33423 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
33432 description: Response codes found in [response codes](https://wiki.onap.org/).
33436 description: Unique id of VNF. This is unique across the graph.
33439 example: __VNF-ID__
33440 - name: interface-name
33442 description: Name that identifies the link aggregate interface
33445 example: __INTERFACE-NAME__
33446 - name: interface-name
33448 description: Name given to the interface
33451 example: __INTERFACE-NAME__
33452 - name: vlan-interface
33454 description: String that identifies the interface
33457 example: __VLAN-INTERFACE__
33458 - name: l3-interface-ipv4-address
33460 description: IP address
33463 example: __L3-INTERFACE-IPV4-ADDRESS__
33464 /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}:
33468 summary: returns l3-interface-ipv4-address-list
33469 description: returns l3-interface-ipv4-address-list
33470 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33476 description: successful operation
33478 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
33480 description: Response codes found in [response codes](https://wiki.onap.org/).
33484 description: Unique id of VNF. This is unique across the graph.
33487 example: __VNF-ID__
33488 - name: interface-name
33490 description: Name that identifies the link aggregate interface
33493 example: __INTERFACE-NAME__
33494 - name: interface-name
33496 description: Name given to the interface
33499 example: __INTERFACE-NAME__
33500 - name: vlan-interface
33502 description: String that identifies the interface
33505 example: __VLAN-INTERFACE__
33506 - name: l3-interface-ipv4-address
33508 description: IP address
33511 example: __L3-INTERFACE-IPV4-ADDRESS__
33514 description: Name of VNF.
33519 description: Alternate name of VNF.
33524 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
33529 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
33532 - name: regional-resource-zone
33534 description: Regional way of organizing pservers, source of truth should define values
33537 - name: prov-status
33539 description: Trigger for operational monitoring of this resource by Service Assurance systems.
33542 - name: heat-stack-id
33544 description: Heat stack id corresponding to this instance, managed by MSO
33551 - name: is-closed-loop-disabled
33555 - name: persona-model-id
33557 description: the ASDC model id for this resource or service model.
33560 - name: persona-model-version
33562 description: the ASDC model version for this resource or service model.
33565 - name: widget-model-id
33567 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33570 - name: widget-model-version
33572 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33575 - name: interface-id
33577 description: ID of interface
33580 - name: interface-role
33582 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
33585 - name: interface-id
33587 description: ID of interface
33592 description: MAC address for the interface
33595 - name: network-name
33597 description: Name of the network
33600 - name: vlan-id-inner
33602 description: Inner VLAN tag
33608 description: This indicates the customers VPN ID associated with this vlan
33611 - name: vlan-id-inner
33613 description: Inner VLAN tag
33617 - name: neutron-network-id
33619 description: Neutron network id of the interface that address belongs to
33622 - name: neutron-subnet-id
33624 description: Neutron id of subnet that address belongs to
33630 summary: create or update an existing l3-interface-ipv4-address-list
33632 Create or update an existing l3-interface-ipv4-address-list.
33634 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
33635 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33644 description: Response codes found in [response codes](https://wiki.onap.org/).
33648 description: Unique id of VNF. This is unique across the graph.
33651 example: __VNF-ID__
33652 - name: interface-name
33654 description: Name that identifies the link aggregate interface
33657 example: __INTERFACE-NAME__
33658 - name: interface-name
33660 description: Name given to the interface
33663 example: __INTERFACE-NAME__
33664 - name: vlan-interface
33666 description: String that identifies the interface
33669 example: __VLAN-INTERFACE__
33670 - name: l3-interface-ipv4-address
33672 description: IP address
33675 example: __L3-INTERFACE-IPV4-ADDRESS__
33678 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
33681 $ref: "#/definitions/l3-interface-ipv4-address-list"
33685 summary: update an existing l3-interface-ipv4-address-list
33687 Update an existing l3-interface-ipv4-address-list
33689 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33690 The PUT operation will entirely replace an existing object.
33691 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
33693 Other differences between PUT and PATCH are:
33695 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
33696 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33697 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33698 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33707 description: Response codes found in [response codes](https://wiki.onap.org/).
33711 description: Unique id of VNF. This is unique across the graph.
33714 example: __VNF-ID__
33715 - name: interface-name
33717 description: Name that identifies the link aggregate interface
33720 example: __INTERFACE-NAME__
33721 - name: interface-name
33723 description: Name given to the interface
33726 example: __INTERFACE-NAME__
33727 - name: vlan-interface
33729 description: String that identifies the interface
33732 example: __VLAN-INTERFACE__
33733 - name: l3-interface-ipv4-address
33735 description: IP address
33738 example: __L3-INTERFACE-IPV4-ADDRESS__
33741 description: l3-interface-ipv4-address-list object that needs to be created or updated.
33744 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
33748 summary: delete an existing l3-interface-ipv4-address-list
33749 description: delete an existing l3-interface-ipv4-address-list
33750 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33759 description: Response codes found in [response codes](https://wiki.onap.org/).
33763 description: Unique id of VNF. This is unique across the graph.
33766 example: __VNF-ID__
33767 - name: interface-name
33769 description: Name that identifies the link aggregate interface
33772 example: __INTERFACE-NAME__
33773 - name: interface-name
33775 description: Name given to the interface
33778 example: __INTERFACE-NAME__
33779 - name: vlan-interface
33781 description: String that identifies the interface
33784 example: __VLAN-INTERFACE__
33785 - name: l3-interface-ipv4-address
33787 description: IP address
33790 example: __L3-INTERFACE-IPV4-ADDRESS__
33791 - name: resource-version
33793 description: resource-version for concurrency
33796 /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:
33800 summary: see node definition for valid relationships
33801 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
33810 description: Response codes found in [response codes](https://wiki.onap.org/).
33814 description: Unique id of VNF. This is unique across the graph.
33817 example: __VNF-ID__
33818 - name: interface-name
33820 description: Name that identifies the link aggregate interface
33823 example: __INTERFACE-NAME__
33824 - name: interface-name
33826 description: Name given to the interface
33829 example: __INTERFACE-NAME__
33830 - name: vlan-interface
33832 description: String that identifies the interface
33835 example: __VLAN-INTERFACE__
33836 - name: l3-interface-ipv6-address
33838 description: IP address
33841 example: __L3-INTERFACE-IPV6-ADDRESS__
33844 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
33847 $ref: "#/definitions/relationship"
33851 summary: delete an existing relationship
33852 description: delete an existing relationship
33853 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
33862 description: Response codes found in [response codes](https://wiki.onap.org/).
33866 description: Unique id of VNF. This is unique across the graph.
33869 example: __VNF-ID__
33870 - name: interface-name
33872 description: Name that identifies the link aggregate interface
33875 example: __INTERFACE-NAME__
33876 - name: interface-name
33878 description: Name given to the interface
33881 example: __INTERFACE-NAME__
33882 - name: vlan-interface
33884 description: String that identifies the interface
33887 example: __VLAN-INTERFACE__
33888 - name: l3-interface-ipv6-address
33890 description: IP address
33893 example: __L3-INTERFACE-IPV6-ADDRESS__
33894 /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}:
33898 summary: returns l3-interface-ipv6-address-list
33899 description: returns l3-interface-ipv6-address-list
33900 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
33906 description: successful operation
33908 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
33910 description: Response codes found in [response codes](https://wiki.onap.org/).
33914 description: Unique id of VNF. This is unique across the graph.
33917 example: __VNF-ID__
33918 - name: interface-name
33920 description: Name that identifies the link aggregate interface
33923 example: __INTERFACE-NAME__
33924 - name: interface-name
33926 description: Name given to the interface
33929 example: __INTERFACE-NAME__
33930 - name: vlan-interface
33932 description: String that identifies the interface
33935 example: __VLAN-INTERFACE__
33936 - name: l3-interface-ipv6-address
33938 description: IP address
33941 example: __L3-INTERFACE-IPV6-ADDRESS__
33944 description: Name of VNF.
33949 description: Alternate name of VNF.
33954 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
33959 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
33962 - name: regional-resource-zone
33964 description: Regional way of organizing pservers, source of truth should define values
33967 - name: prov-status
33969 description: Trigger for operational monitoring of this resource by Service Assurance systems.
33972 - name: heat-stack-id
33974 description: Heat stack id corresponding to this instance, managed by MSO
33981 - name: is-closed-loop-disabled
33985 - name: persona-model-id
33987 description: the ASDC model id for this resource or service model.
33990 - name: persona-model-version
33992 description: the ASDC model version for this resource or service model.
33995 - name: widget-model-id
33997 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34000 - name: widget-model-version
34002 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34005 - name: interface-id
34007 description: ID of interface
34010 - name: interface-role
34012 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
34015 - name: interface-id
34017 description: ID of interface
34022 description: MAC address for the interface
34025 - name: network-name
34027 description: Name of the network
34030 - name: vlan-id-inner
34032 description: Inner VLAN tag
34038 description: This indicates the customers VPN ID associated with this vlan
34041 - name: vlan-id-inner
34043 description: Inner VLAN tag
34047 - name: neutron-network-id
34049 description: Neutron network id of the interface that address belongs to
34052 - name: neutron-subnet-id
34054 description: Neutron id of subnet that address belongs to
34060 summary: create or update an existing l3-interface-ipv6-address-list
34062 Create or update an existing l3-interface-ipv6-address-list.
34064 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34065 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34074 description: Response codes found in [response codes](https://wiki.onap.org/).
34078 description: Unique id of VNF. This is unique across the graph.
34081 example: __VNF-ID__
34082 - name: interface-name
34084 description: Name that identifies the link aggregate interface
34087 example: __INTERFACE-NAME__
34088 - name: interface-name
34090 description: Name given to the interface
34093 example: __INTERFACE-NAME__
34094 - name: vlan-interface
34096 description: String that identifies the interface
34099 example: __VLAN-INTERFACE__
34100 - name: l3-interface-ipv6-address
34102 description: IP address
34105 example: __L3-INTERFACE-IPV6-ADDRESS__
34108 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
34111 $ref: "#/definitions/l3-interface-ipv6-address-list"
34115 summary: update an existing l3-interface-ipv6-address-list
34117 Update an existing l3-interface-ipv6-address-list
34119 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34120 The PUT operation will entirely replace an existing object.
34121 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34123 Other differences between PUT and PATCH are:
34125 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34126 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34127 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34128 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34137 description: Response codes found in [response codes](https://wiki.onap.org/).
34141 description: Unique id of VNF. This is unique across the graph.
34144 example: __VNF-ID__
34145 - name: interface-name
34147 description: Name that identifies the link aggregate interface
34150 example: __INTERFACE-NAME__
34151 - name: interface-name
34153 description: Name given to the interface
34156 example: __INTERFACE-NAME__
34157 - name: vlan-interface
34159 description: String that identifies the interface
34162 example: __VLAN-INTERFACE__
34163 - name: l3-interface-ipv6-address
34165 description: IP address
34168 example: __L3-INTERFACE-IPV6-ADDRESS__
34171 description: l3-interface-ipv6-address-list object that needs to be created or updated.
34174 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
34178 summary: delete an existing l3-interface-ipv6-address-list
34179 description: delete an existing l3-interface-ipv6-address-list
34180 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34189 description: Response codes found in [response codes](https://wiki.onap.org/).
34193 description: Unique id of VNF. This is unique across the graph.
34196 example: __VNF-ID__
34197 - name: interface-name
34199 description: Name that identifies the link aggregate interface
34202 example: __INTERFACE-NAME__
34203 - name: interface-name
34205 description: Name given to the interface
34208 example: __INTERFACE-NAME__
34209 - name: vlan-interface
34211 description: String that identifies the interface
34214 example: __VLAN-INTERFACE__
34215 - name: l3-interface-ipv6-address
34217 description: IP address
34220 example: __L3-INTERFACE-IPV6-ADDRESS__
34221 - name: resource-version
34223 description: resource-version for concurrency
34226 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
34230 summary: returns vlan
34231 description: returns vlan
34232 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
34238 description: successful operation
34240 $ref: "#/getDefinitions/vlan"
34242 description: Response codes found in [response codes](https://wiki.onap.org/).
34246 description: Unique id of VNF. This is unique across the graph.
34249 example: __VNF-ID__
34250 - name: interface-name
34252 description: Name that identifies the link aggregate interface
34255 example: __INTERFACE-NAME__
34256 - name: interface-name
34258 description: Name given to the interface
34261 example: __INTERFACE-NAME__
34262 - name: vlan-interface
34264 description: String that identifies the interface
34267 example: __VLAN-INTERFACE__
34270 description: Name of VNF.
34275 description: Alternate name of VNF.
34280 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
34285 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
34288 - name: regional-resource-zone
34290 description: Regional way of organizing pservers, source of truth should define values
34293 - name: prov-status
34295 description: Trigger for operational monitoring of this resource by Service Assurance systems.
34298 - name: heat-stack-id
34300 description: Heat stack id corresponding to this instance, managed by MSO
34307 - name: is-closed-loop-disabled
34311 - name: persona-model-id
34313 description: the ASDC model id for this resource or service model.
34316 - name: persona-model-version
34318 description: the ASDC model version for this resource or service model.
34321 - name: widget-model-id
34323 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34326 - name: widget-model-version
34328 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34331 - name: interface-id
34333 description: ID of interface
34336 - name: interface-role
34338 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
34341 - name: interface-id
34343 description: ID of interface
34348 description: MAC address for the interface
34351 - name: network-name
34353 description: Name of the network
34356 - name: vlan-id-inner
34358 description: Inner VLAN tag
34364 description: This indicates the customers VPN ID associated with this vlan
34370 summary: create or update an existing vlan
34372 Create or update an existing vlan.
34374 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34375 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
34384 description: Response codes found in [response codes](https://wiki.onap.org/).
34388 description: Unique id of VNF. This is unique across the graph.
34391 example: __VNF-ID__
34392 - name: interface-name
34394 description: Name that identifies the link aggregate interface
34397 example: __INTERFACE-NAME__
34398 - name: interface-name
34400 description: Name given to the interface
34403 example: __INTERFACE-NAME__
34404 - name: vlan-interface
34406 description: String that identifies the interface
34409 example: __VLAN-INTERFACE__
34412 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
34415 $ref: "#/definitions/vlan"
34419 summary: update an existing vlan
34421 Update an existing vlan
34423 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34424 The PUT operation will entirely replace an existing object.
34425 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34427 Other differences between PUT and PATCH are:
34429 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34430 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34431 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34432 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
34441 description: Response codes found in [response codes](https://wiki.onap.org/).
34445 description: Unique id of VNF. This is unique across the graph.
34448 example: __VNF-ID__
34449 - name: interface-name
34451 description: Name that identifies the link aggregate interface
34454 example: __INTERFACE-NAME__
34455 - name: interface-name
34457 description: Name given to the interface
34460 example: __INTERFACE-NAME__
34461 - name: vlan-interface
34463 description: String that identifies the interface
34466 example: __VLAN-INTERFACE__
34469 description: vlan object that needs to be created or updated.
34472 $ref: "#/patchDefinitions/vlan"
34476 summary: delete an existing vlan
34477 description: delete an existing vlan
34478 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
34487 description: Response codes found in [response codes](https://wiki.onap.org/).
34491 description: Unique id of VNF. This is unique across the graph.
34494 example: __VNF-ID__
34495 - name: interface-name
34497 description: Name that identifies the link aggregate interface
34500 example: __INTERFACE-NAME__
34501 - name: interface-name
34503 description: Name given to the interface
34506 example: __INTERFACE-NAME__
34507 - name: vlan-interface
34509 description: String that identifies the interface
34512 example: __VLAN-INTERFACE__
34513 - name: resource-version
34515 description: resource-version for concurrency
34518 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
34522 summary: returns vlans
34523 description: returns vlans
34524 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
34530 description: successful operation
34532 $ref: "#/getDefinitions/vlans"
34534 description: Response codes found in [response codes](https://wiki.onap.org/).
34538 description: Unique id of VNF. This is unique across the graph.
34541 example: __VNF-ID__
34542 - name: interface-name
34544 description: Name that identifies the link aggregate interface
34547 example: __INTERFACE-NAME__
34548 - name: interface-name
34550 description: Name given to the interface
34553 example: __INTERFACE-NAME__
34556 description: Name of VNF.
34561 description: Alternate name of VNF.
34566 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
34571 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
34574 - name: regional-resource-zone
34576 description: Regional way of organizing pservers, source of truth should define values
34579 - name: prov-status
34581 description: Trigger for operational monitoring of this resource by Service Assurance systems.
34584 - name: heat-stack-id
34586 description: Heat stack id corresponding to this instance, managed by MSO
34593 - name: is-closed-loop-disabled
34597 - name: persona-model-id
34599 description: the ASDC model id for this resource or service model.
34602 - name: persona-model-version
34604 description: the ASDC model version for this resource or service model.
34607 - name: widget-model-id
34609 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34612 - name: widget-model-version
34614 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34617 - name: interface-id
34619 description: ID of interface
34622 - name: interface-role
34624 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
34627 - name: interface-id
34629 description: ID of interface
34634 description: MAC address for the interface
34637 - name: network-name
34639 description: Name of the network
34642 /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:
34646 summary: see node definition for valid relationships
34647 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
34656 description: Response codes found in [response codes](https://wiki.onap.org/).
34660 description: Unique id of VNF. This is unique across the graph.
34663 example: __VNF-ID__
34664 - name: interface-name
34666 description: Name that identifies the link aggregate interface
34669 example: __INTERFACE-NAME__
34670 - name: interface-name
34672 description: Name given to the interface
34675 example: __INTERFACE-NAME__
34678 description: PCI ID used to identify the sriov-vf
34681 example: __PCI-ID__
34684 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
34687 $ref: "#/definitions/relationship"
34691 summary: delete an existing relationship
34692 description: delete an existing relationship
34693 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
34702 description: Response codes found in [response codes](https://wiki.onap.org/).
34706 description: Unique id of VNF. This is unique across the graph.
34709 example: __VNF-ID__
34710 - name: interface-name
34712 description: Name that identifies the link aggregate interface
34715 example: __INTERFACE-NAME__
34716 - name: interface-name
34718 description: Name given to the interface
34721 example: __INTERFACE-NAME__
34724 description: PCI ID used to identify the sriov-vf
34727 example: __PCI-ID__
34728 /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}:
34732 summary: returns sriov-vf
34733 description: returns sriov-vf
34734 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
34740 description: successful operation
34742 $ref: "#/getDefinitions/sriov-vf"
34744 description: Response codes found in [response codes](https://wiki.onap.org/).
34748 description: Unique id of VNF. This is unique across the graph.
34751 example: __VNF-ID__
34752 - name: interface-name
34754 description: Name that identifies the link aggregate interface
34757 example: __INTERFACE-NAME__
34758 - name: interface-name
34760 description: Name given to the interface
34763 example: __INTERFACE-NAME__
34766 description: PCI ID used to identify the sriov-vf
34769 example: __PCI-ID__
34772 description: Name of VNF.
34777 description: Alternate name of VNF.
34782 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
34787 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
34790 - name: regional-resource-zone
34792 description: Regional way of organizing pservers, source of truth should define values
34795 - name: prov-status
34797 description: Trigger for operational monitoring of this resource by Service Assurance systems.
34800 - name: heat-stack-id
34802 description: Heat stack id corresponding to this instance, managed by MSO
34809 - name: is-closed-loop-disabled
34813 - name: persona-model-id
34815 description: the ASDC model id for this resource or service model.
34818 - name: persona-model-version
34820 description: the ASDC model version for this resource or service model.
34823 - name: widget-model-id
34825 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34828 - name: widget-model-version
34830 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34833 - name: interface-id
34835 description: ID of interface
34838 - name: interface-role
34840 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
34843 - name: interface-id
34845 description: ID of interface
34850 description: MAC address for the interface
34853 - name: network-name
34855 description: Name of the network
34858 - name: vf-vlan-filter
34860 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
34863 - name: vf-mac-filter
34865 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
34868 - name: vf-vlan-strip
34870 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
34873 - name: neutron-network-id
34875 description: Neutron network id of the interface
34881 summary: create or update an existing sriov-vf
34883 Create or update an existing sriov-vf.
34885 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
34886 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
34895 description: Response codes found in [response codes](https://wiki.onap.org/).
34899 description: Unique id of VNF. This is unique across the graph.
34902 example: __VNF-ID__
34903 - name: interface-name
34905 description: Name that identifies the link aggregate interface
34908 example: __INTERFACE-NAME__
34909 - name: interface-name
34911 description: Name given to the interface
34914 example: __INTERFACE-NAME__
34917 description: PCI ID used to identify the sriov-vf
34920 example: __PCI-ID__
34923 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
34926 $ref: "#/definitions/sriov-vf"
34930 summary: update an existing sriov-vf
34932 Update an existing sriov-vf
34934 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34935 The PUT operation will entirely replace an existing object.
34936 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
34938 Other differences between PUT and PATCH are:
34940 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
34941 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34942 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34943 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
34952 description: Response codes found in [response codes](https://wiki.onap.org/).
34956 description: Unique id of VNF. This is unique across the graph.
34959 example: __VNF-ID__
34960 - name: interface-name
34962 description: Name that identifies the link aggregate interface
34965 example: __INTERFACE-NAME__
34966 - name: interface-name
34968 description: Name given to the interface
34971 example: __INTERFACE-NAME__
34974 description: PCI ID used to identify the sriov-vf
34977 example: __PCI-ID__
34980 description: sriov-vf object that needs to be created or updated.
34983 $ref: "#/patchDefinitions/sriov-vf"
34987 summary: delete an existing sriov-vf
34988 description: delete an existing sriov-vf
34989 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
34998 description: Response codes found in [response codes](https://wiki.onap.org/).
35002 description: Unique id of VNF. This is unique across the graph.
35005 example: __VNF-ID__
35006 - name: interface-name
35008 description: Name that identifies the link aggregate interface
35011 example: __INTERFACE-NAME__
35012 - name: interface-name
35014 description: Name given to the interface
35017 example: __INTERFACE-NAME__
35020 description: PCI ID used to identify the sriov-vf
35023 example: __PCI-ID__
35024 - name: resource-version
35026 description: resource-version for concurrency
35029 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
35033 summary: returns sriov-vfs
35034 description: returns sriov-vfs
35035 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
35041 description: successful operation
35043 $ref: "#/getDefinitions/sriov-vfs"
35045 description: Response codes found in [response codes](https://wiki.onap.org/).
35049 description: Unique id of VNF. This is unique across the graph.
35052 example: __VNF-ID__
35053 - name: interface-name
35055 description: Name that identifies the link aggregate interface
35058 example: __INTERFACE-NAME__
35059 - name: interface-name
35061 description: Name given to the interface
35064 example: __INTERFACE-NAME__
35067 description: Name of VNF.
35072 description: Alternate name of VNF.
35077 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
35082 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
35085 - name: regional-resource-zone
35087 description: Regional way of organizing pservers, source of truth should define values
35090 - name: prov-status
35092 description: Trigger for operational monitoring of this resource by Service Assurance systems.
35095 - name: heat-stack-id
35097 description: Heat stack id corresponding to this instance, managed by MSO
35104 - name: is-closed-loop-disabled
35108 - name: persona-model-id
35110 description: the ASDC model id for this resource or service model.
35113 - name: persona-model-version
35115 description: the ASDC model version for this resource or service model.
35118 - name: widget-model-id
35120 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35123 - name: widget-model-version
35125 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35128 - name: interface-id
35130 description: ID of interface
35133 - name: interface-role
35135 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
35138 - name: interface-id
35140 description: ID of interface
35145 description: MAC address for the interface
35148 - name: network-name
35150 description: Name of the network
35153 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
35157 summary: see node definition for valid relationships
35158 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
35167 description: Response codes found in [response codes](https://wiki.onap.org/).
35171 description: Unique id of VNF. This is unique across the graph.
35174 example: __VNF-ID__
35175 - name: interface-name
35177 description: Name that identifies the link aggregate interface
35180 example: __INTERFACE-NAME__
35181 - name: interface-name
35183 description: Name given to the interface
35186 example: __INTERFACE-NAME__
35189 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
35192 $ref: "#/definitions/relationship"
35196 summary: delete an existing relationship
35197 description: delete an existing relationship
35198 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
35207 description: Response codes found in [response codes](https://wiki.onap.org/).
35211 description: Unique id of VNF. This is unique across the graph.
35214 example: __VNF-ID__
35215 - name: interface-name
35217 description: Name that identifies the link aggregate interface
35220 example: __INTERFACE-NAME__
35221 - name: interface-name
35223 description: Name given to the interface
35226 example: __INTERFACE-NAME__
35227 /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:
35231 summary: see node definition for valid relationships
35232 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
35241 description: Response codes found in [response codes](https://wiki.onap.org/).
35245 description: Unique id of VNF. This is unique across the graph.
35248 example: __VNF-ID__
35249 - name: interface-name
35251 description: Name that identifies the link aggregate interface
35254 example: __INTERFACE-NAME__
35255 - name: interface-name
35257 description: Name given to the interface
35260 example: __INTERFACE-NAME__
35261 - name: l3-interface-ipv4-address
35263 description: IP address
35266 example: __L3-INTERFACE-IPV4-ADDRESS__
35269 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
35272 $ref: "#/definitions/relationship"
35276 summary: delete an existing relationship
35277 description: delete an existing relationship
35278 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
35287 description: Response codes found in [response codes](https://wiki.onap.org/).
35291 description: Unique id of VNF. This is unique across the graph.
35294 example: __VNF-ID__
35295 - name: interface-name
35297 description: Name that identifies the link aggregate interface
35300 example: __INTERFACE-NAME__
35301 - name: interface-name
35303 description: Name given to the interface
35306 example: __INTERFACE-NAME__
35307 - name: l3-interface-ipv4-address
35309 description: IP address
35312 example: __L3-INTERFACE-IPV4-ADDRESS__
35313 /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}:
35317 summary: returns l3-interface-ipv4-address-list
35318 description: returns l3-interface-ipv4-address-list
35319 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
35325 description: successful operation
35327 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
35329 description: Response codes found in [response codes](https://wiki.onap.org/).
35333 description: Unique id of VNF. This is unique across the graph.
35336 example: __VNF-ID__
35337 - name: interface-name
35339 description: Name that identifies the link aggregate interface
35342 example: __INTERFACE-NAME__
35343 - name: interface-name
35345 description: Name given to the interface
35348 example: __INTERFACE-NAME__
35349 - name: l3-interface-ipv4-address
35351 description: IP address
35354 example: __L3-INTERFACE-IPV4-ADDRESS__
35357 description: Name of VNF.
35362 description: Alternate name of VNF.
35367 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
35372 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
35375 - name: regional-resource-zone
35377 description: Regional way of organizing pservers, source of truth should define values
35380 - name: prov-status
35382 description: Trigger for operational monitoring of this resource by Service Assurance systems.
35385 - name: heat-stack-id
35387 description: Heat stack id corresponding to this instance, managed by MSO
35394 - name: is-closed-loop-disabled
35398 - name: persona-model-id
35400 description: the ASDC model id for this resource or service model.
35403 - name: persona-model-version
35405 description: the ASDC model version for this resource or service model.
35408 - name: widget-model-id
35410 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35413 - name: widget-model-version
35415 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35418 - name: interface-id
35420 description: ID of interface
35423 - name: interface-role
35425 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
35428 - name: interface-id
35430 description: ID of interface
35435 description: MAC address for the interface
35438 - name: network-name
35440 description: Name of the network
35443 - name: vlan-id-inner
35445 description: Inner VLAN tag
35449 - name: neutron-network-id
35451 description: Neutron network id of the interface that address belongs to
35454 - name: neutron-subnet-id
35456 description: Neutron id of subnet that address belongs to
35462 summary: create or update an existing l3-interface-ipv4-address-list
35464 Create or update an existing l3-interface-ipv4-address-list.
35466 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35467 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
35476 description: Response codes found in [response codes](https://wiki.onap.org/).
35480 description: Unique id of VNF. This is unique across the graph.
35483 example: __VNF-ID__
35484 - name: interface-name
35486 description: Name that identifies the link aggregate interface
35489 example: __INTERFACE-NAME__
35490 - name: interface-name
35492 description: Name given to the interface
35495 example: __INTERFACE-NAME__
35496 - name: l3-interface-ipv4-address
35498 description: IP address
35501 example: __L3-INTERFACE-IPV4-ADDRESS__
35504 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
35507 $ref: "#/definitions/l3-interface-ipv4-address-list"
35511 summary: update an existing l3-interface-ipv4-address-list
35513 Update an existing l3-interface-ipv4-address-list
35515 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35516 The PUT operation will entirely replace an existing object.
35517 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35519 Other differences between PUT and PATCH are:
35521 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35522 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35523 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35524 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
35533 description: Response codes found in [response codes](https://wiki.onap.org/).
35537 description: Unique id of VNF. This is unique across the graph.
35540 example: __VNF-ID__
35541 - name: interface-name
35543 description: Name that identifies the link aggregate interface
35546 example: __INTERFACE-NAME__
35547 - name: interface-name
35549 description: Name given to the interface
35552 example: __INTERFACE-NAME__
35553 - name: l3-interface-ipv4-address
35555 description: IP address
35558 example: __L3-INTERFACE-IPV4-ADDRESS__
35561 description: l3-interface-ipv4-address-list object that needs to be created or updated.
35564 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
35568 summary: delete an existing l3-interface-ipv4-address-list
35569 description: delete an existing l3-interface-ipv4-address-list
35570 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
35579 description: Response codes found in [response codes](https://wiki.onap.org/).
35583 description: Unique id of VNF. This is unique across the graph.
35586 example: __VNF-ID__
35587 - name: interface-name
35589 description: Name that identifies the link aggregate interface
35592 example: __INTERFACE-NAME__
35593 - name: interface-name
35595 description: Name given to the interface
35598 example: __INTERFACE-NAME__
35599 - name: l3-interface-ipv4-address
35601 description: IP address
35604 example: __L3-INTERFACE-IPV4-ADDRESS__
35605 - name: resource-version
35607 description: resource-version for concurrency
35610 /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:
35614 summary: see node definition for valid relationships
35615 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
35624 description: Response codes found in [response codes](https://wiki.onap.org/).
35628 description: Unique id of VNF. This is unique across the graph.
35631 example: __VNF-ID__
35632 - name: interface-name
35634 description: Name that identifies the link aggregate interface
35637 example: __INTERFACE-NAME__
35638 - name: interface-name
35640 description: Name given to the interface
35643 example: __INTERFACE-NAME__
35644 - name: l3-interface-ipv6-address
35646 description: IP address
35649 example: __L3-INTERFACE-IPV6-ADDRESS__
35652 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
35655 $ref: "#/definitions/relationship"
35659 summary: delete an existing relationship
35660 description: delete an existing relationship
35661 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
35670 description: Response codes found in [response codes](https://wiki.onap.org/).
35674 description: Unique id of VNF. This is unique across the graph.
35677 example: __VNF-ID__
35678 - name: interface-name
35680 description: Name that identifies the link aggregate interface
35683 example: __INTERFACE-NAME__
35684 - name: interface-name
35686 description: Name given to the interface
35689 example: __INTERFACE-NAME__
35690 - name: l3-interface-ipv6-address
35692 description: IP address
35695 example: __L3-INTERFACE-IPV6-ADDRESS__
35696 /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}:
35700 summary: returns l3-interface-ipv6-address-list
35701 description: returns l3-interface-ipv6-address-list
35702 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
35708 description: successful operation
35710 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
35712 description: Response codes found in [response codes](https://wiki.onap.org/).
35716 description: Unique id of VNF. This is unique across the graph.
35719 example: __VNF-ID__
35720 - name: interface-name
35722 description: Name that identifies the link aggregate interface
35725 example: __INTERFACE-NAME__
35726 - name: interface-name
35728 description: Name given to the interface
35731 example: __INTERFACE-NAME__
35732 - name: l3-interface-ipv6-address
35734 description: IP address
35737 example: __L3-INTERFACE-IPV6-ADDRESS__
35740 description: Name of VNF.
35745 description: Alternate name of VNF.
35750 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
35755 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
35758 - name: regional-resource-zone
35760 description: Regional way of organizing pservers, source of truth should define values
35763 - name: prov-status
35765 description: Trigger for operational monitoring of this resource by Service Assurance systems.
35768 - name: heat-stack-id
35770 description: Heat stack id corresponding to this instance, managed by MSO
35777 - name: is-closed-loop-disabled
35781 - name: persona-model-id
35783 description: the ASDC model id for this resource or service model.
35786 - name: persona-model-version
35788 description: the ASDC model version for this resource or service model.
35791 - name: widget-model-id
35793 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35796 - name: widget-model-version
35798 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35801 - name: interface-id
35803 description: ID of interface
35806 - name: interface-role
35808 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
35811 - name: interface-id
35813 description: ID of interface
35818 description: MAC address for the interface
35821 - name: network-name
35823 description: Name of the network
35826 - name: vlan-id-inner
35828 description: Inner VLAN tag
35832 - name: neutron-network-id
35834 description: Neutron network id of the interface that address belongs to
35837 - name: neutron-subnet-id
35839 description: Neutron id of subnet that address belongs to
35845 summary: create or update an existing l3-interface-ipv6-address-list
35847 Create or update an existing l3-interface-ipv6-address-list.
35849 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
35850 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
35859 description: Response codes found in [response codes](https://wiki.onap.org/).
35863 description: Unique id of VNF. This is unique across the graph.
35866 example: __VNF-ID__
35867 - name: interface-name
35869 description: Name that identifies the link aggregate interface
35872 example: __INTERFACE-NAME__
35873 - name: interface-name
35875 description: Name given to the interface
35878 example: __INTERFACE-NAME__
35879 - name: l3-interface-ipv6-address
35881 description: IP address
35884 example: __L3-INTERFACE-IPV6-ADDRESS__
35887 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
35890 $ref: "#/definitions/l3-interface-ipv6-address-list"
35894 summary: update an existing l3-interface-ipv6-address-list
35896 Update an existing l3-interface-ipv6-address-list
35898 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35899 The PUT operation will entirely replace an existing object.
35900 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
35902 Other differences between PUT and PATCH are:
35904 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
35905 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35906 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35907 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
35916 description: Response codes found in [response codes](https://wiki.onap.org/).
35920 description: Unique id of VNF. This is unique across the graph.
35923 example: __VNF-ID__
35924 - name: interface-name
35926 description: Name that identifies the link aggregate interface
35929 example: __INTERFACE-NAME__
35930 - name: interface-name
35932 description: Name given to the interface
35935 example: __INTERFACE-NAME__
35936 - name: l3-interface-ipv6-address
35938 description: IP address
35941 example: __L3-INTERFACE-IPV6-ADDRESS__
35944 description: l3-interface-ipv6-address-list object that needs to be created or updated.
35947 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
35951 summary: delete an existing l3-interface-ipv6-address-list
35952 description: delete an existing l3-interface-ipv6-address-list
35953 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
35962 description: Response codes found in [response codes](https://wiki.onap.org/).
35966 description: Unique id of VNF. This is unique across the graph.
35969 example: __VNF-ID__
35970 - name: interface-name
35972 description: Name that identifies the link aggregate interface
35975 example: __INTERFACE-NAME__
35976 - name: interface-name
35978 description: Name given to the interface
35981 example: __INTERFACE-NAME__
35982 - name: l3-interface-ipv6-address
35984 description: IP address
35987 example: __L3-INTERFACE-IPV6-ADDRESS__
35988 - name: resource-version
35990 description: resource-version for concurrency
35993 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
35997 summary: returns l-interface
35998 description: returns l-interface
35999 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
36005 description: successful operation
36007 $ref: "#/getDefinitions/l-interface"
36009 description: Response codes found in [response codes](https://wiki.onap.org/).
36013 description: Unique id of VNF. This is unique across the graph.
36016 example: __VNF-ID__
36017 - name: interface-name
36019 description: Name that identifies the link aggregate interface
36022 example: __INTERFACE-NAME__
36023 - name: interface-name
36025 description: Name given to the interface
36028 example: __INTERFACE-NAME__
36031 description: Name of VNF.
36036 description: Alternate name of VNF.
36041 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
36046 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
36049 - name: regional-resource-zone
36051 description: Regional way of organizing pservers, source of truth should define values
36054 - name: prov-status
36056 description: Trigger for operational monitoring of this resource by Service Assurance systems.
36059 - name: heat-stack-id
36061 description: Heat stack id corresponding to this instance, managed by MSO
36068 - name: is-closed-loop-disabled
36072 - name: persona-model-id
36074 description: the ASDC model id for this resource or service model.
36077 - name: persona-model-version
36079 description: the ASDC model version for this resource or service model.
36082 - name: widget-model-id
36084 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36087 - name: widget-model-version
36089 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36092 - name: interface-id
36094 description: ID of interface
36097 - name: interface-role
36099 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
36102 - name: interface-id
36104 description: ID of interface
36109 description: MAC address for the interface
36112 - name: network-name
36114 description: Name of the network
36120 summary: create or update an existing l-interface
36122 Create or update an existing l-interface.
36124 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36125 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
36134 description: Response codes found in [response codes](https://wiki.onap.org/).
36138 description: Unique id of VNF. This is unique across the graph.
36141 example: __VNF-ID__
36142 - name: interface-name
36144 description: Name that identifies the link aggregate interface
36147 example: __INTERFACE-NAME__
36148 - name: interface-name
36150 description: Name given to the interface
36153 example: __INTERFACE-NAME__
36156 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
36159 $ref: "#/definitions/l-interface"
36163 summary: update an existing l-interface
36165 Update an existing l-interface
36167 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36168 The PUT operation will entirely replace an existing object.
36169 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36171 Other differences between PUT and PATCH are:
36173 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36174 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36175 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36176 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
36185 description: Response codes found in [response codes](https://wiki.onap.org/).
36189 description: Unique id of VNF. This is unique across the graph.
36192 example: __VNF-ID__
36193 - name: interface-name
36195 description: Name that identifies the link aggregate interface
36198 example: __INTERFACE-NAME__
36199 - name: interface-name
36201 description: Name given to the interface
36204 example: __INTERFACE-NAME__
36207 description: l-interface object that needs to be created or updated.
36210 $ref: "#/patchDefinitions/l-interface"
36214 summary: delete an existing l-interface
36215 description: delete an existing l-interface
36216 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
36225 description: Response codes found in [response codes](https://wiki.onap.org/).
36229 description: Unique id of VNF. This is unique across the graph.
36232 example: __VNF-ID__
36233 - name: interface-name
36235 description: Name that identifies the link aggregate interface
36238 example: __INTERFACE-NAME__
36239 - name: interface-name
36241 description: Name given to the interface
36244 example: __INTERFACE-NAME__
36245 - name: resource-version
36247 description: resource-version for concurrency
36250 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
36254 summary: returns l-interfaces
36255 description: returns l-interfaces
36256 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces
36262 description: successful operation
36264 $ref: "#/getDefinitions/l-interfaces"
36266 description: Response codes found in [response codes](https://wiki.onap.org/).
36270 description: Unique id of VNF. This is unique across the graph.
36273 example: __VNF-ID__
36274 - name: interface-name
36276 description: Name that identifies the link aggregate interface
36279 example: __INTERFACE-NAME__
36282 description: Name of VNF.
36287 description: Alternate name of VNF.
36292 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
36297 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
36300 - name: regional-resource-zone
36302 description: Regional way of organizing pservers, source of truth should define values
36305 - name: prov-status
36307 description: Trigger for operational monitoring of this resource by Service Assurance systems.
36310 - name: heat-stack-id
36312 description: Heat stack id corresponding to this instance, managed by MSO
36319 - name: is-closed-loop-disabled
36323 - name: persona-model-id
36325 description: the ASDC model id for this resource or service model.
36328 - name: persona-model-version
36330 description: the ASDC model version for this resource or service model.
36333 - name: widget-model-id
36335 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36338 - name: widget-model-version
36340 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36343 - name: interface-id
36345 description: ID of interface
36348 - name: interface-role
36350 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
36353 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}:
36357 summary: returns lag-interface
36358 description: returns lag-interface
36359 operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
36365 description: successful operation
36367 $ref: "#/getDefinitions/lag-interface"
36369 description: Response codes found in [response codes](https://wiki.onap.org/).
36373 description: Unique id of VNF. This is unique across the graph.
36376 example: __VNF-ID__
36377 - name: interface-name
36379 description: Name that identifies the link aggregate interface
36382 example: __INTERFACE-NAME__
36385 description: Name of VNF.
36390 description: Alternate name of VNF.
36395 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
36400 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
36403 - name: regional-resource-zone
36405 description: Regional way of organizing pservers, source of truth should define values
36408 - name: prov-status
36410 description: Trigger for operational monitoring of this resource by Service Assurance systems.
36413 - name: heat-stack-id
36415 description: Heat stack id corresponding to this instance, managed by MSO
36422 - name: is-closed-loop-disabled
36426 - name: persona-model-id
36428 description: the ASDC model id for this resource or service model.
36431 - name: persona-model-version
36433 description: the ASDC model version for this resource or service model.
36436 - name: widget-model-id
36438 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36441 - name: widget-model-version
36443 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36446 - name: interface-id
36448 description: ID of interface
36451 - name: interface-role
36453 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
36459 summary: create or update an existing lag-interface
36461 Create or update an existing lag-interface.
36463 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36464 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
36473 description: Response codes found in [response codes](https://wiki.onap.org/).
36477 description: Unique id of VNF. This is unique across the graph.
36480 example: __VNF-ID__
36481 - name: interface-name
36483 description: Name that identifies the link aggregate interface
36486 example: __INTERFACE-NAME__
36489 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
36492 $ref: "#/definitions/lag-interface"
36496 summary: update an existing lag-interface
36498 Update an existing lag-interface
36500 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36501 The PUT operation will entirely replace an existing object.
36502 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36504 Other differences between PUT and PATCH are:
36506 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36507 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36508 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36509 operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
36518 description: Response codes found in [response codes](https://wiki.onap.org/).
36522 description: Unique id of VNF. This is unique across the graph.
36525 example: __VNF-ID__
36526 - name: interface-name
36528 description: Name that identifies the link aggregate interface
36531 example: __INTERFACE-NAME__
36534 description: lag-interface object that needs to be created or updated.
36537 $ref: "#/patchDefinitions/lag-interface"
36541 summary: delete an existing lag-interface
36542 description: delete an existing lag-interface
36543 operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
36552 description: Response codes found in [response codes](https://wiki.onap.org/).
36556 description: Unique id of VNF. This is unique across the graph.
36559 example: __VNF-ID__
36560 - name: interface-name
36562 description: Name that identifies the link aggregate interface
36565 example: __INTERFACE-NAME__
36566 - name: resource-version
36568 description: resource-version for concurrency
36571 /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces:
36575 summary: returns lag-interfaces
36576 description: returns lag-interfaces
36577 operationId: getNetworkGenericVnfsGenericVnfLagInterfaces
36583 description: successful operation
36585 $ref: "#/getDefinitions/lag-interfaces"
36587 description: Response codes found in [response codes](https://wiki.onap.org/).
36591 description: Unique id of VNF. This is unique across the graph.
36594 example: __VNF-ID__
36597 description: Name of VNF.
36602 description: Alternate name of VNF.
36607 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
36612 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
36615 - name: regional-resource-zone
36617 description: Regional way of organizing pservers, source of truth should define values
36620 - name: prov-status
36622 description: Trigger for operational monitoring of this resource by Service Assurance systems.
36625 - name: heat-stack-id
36627 description: Heat stack id corresponding to this instance, managed by MSO
36634 - name: is-closed-loop-disabled
36638 - name: persona-model-id
36640 description: the ASDC model id for this resource or service model.
36643 - name: persona-model-version
36645 description: the ASDC model version for this resource or service model.
36648 - name: widget-model-id
36650 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36653 - name: widget-model-version
36655 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36658 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship:
36662 summary: see node definition for valid relationships
36663 operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
36672 description: Response codes found in [response codes](https://wiki.onap.org/).
36676 description: Unique id of VNF. This is unique across the graph.
36679 example: __VNF-ID__
36680 - name: vf-module-id
36682 description: Unique ID of vf-module.
36685 example: __VF-MODULE-ID__
36688 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
36691 $ref: "#/definitions/relationship"
36695 summary: delete an existing relationship
36696 description: delete an existing relationship
36697 operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
36706 description: Response codes found in [response codes](https://wiki.onap.org/).
36710 description: Unique id of VNF. This is unique across the graph.
36713 example: __VNF-ID__
36714 - name: vf-module-id
36716 description: Unique ID of vf-module.
36719 example: __VF-MODULE-ID__
36720 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}:
36724 summary: returns vf-module
36725 description: returns vf-module
36726 operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule
36732 description: successful operation
36734 $ref: "#/getDefinitions/vf-module"
36736 description: Response codes found in [response codes](https://wiki.onap.org/).
36740 description: Unique id of VNF. This is unique across the graph.
36743 example: __VNF-ID__
36744 - name: vf-module-id
36746 description: Unique ID of vf-module.
36749 example: __VF-MODULE-ID__
36752 description: Name of VNF.
36757 description: Alternate name of VNF.
36762 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
36767 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
36770 - name: regional-resource-zone
36772 description: Regional way of organizing pservers, source of truth should define values
36775 - name: prov-status
36777 description: Trigger for operational monitoring of this resource by Service Assurance systems.
36780 - name: heat-stack-id
36782 description: Heat stack id corresponding to this instance, managed by MSO
36789 - name: is-closed-loop-disabled
36793 - name: persona-model-id
36795 description: the ASDC model id for this resource or service model.
36798 - name: persona-model-version
36800 description: the ASDC model version for this resource or service model.
36803 - name: widget-model-id
36805 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36808 - name: widget-model-version
36810 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36813 - name: vf-module-name
36815 description: Name of vf-module
36818 - name: heat-stack-id
36820 description: Heat stack id corresponding to this instance.
36823 - name: persona-model-id
36825 description: the ASDC model id for this resource or service model.
36828 - name: persona-model-version
36830 description: the ASDC model version for this resource or service model.
36833 - name: widget-model-id
36835 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36838 - name: widget-model-version
36840 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36843 - name: contrail-service-instance-fqdn
36845 description: the Contrail unique ID for a service-instance
36851 summary: create or update an existing vf-module
36853 Create or update an existing vf-module.
36855 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
36856 operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
36865 description: Response codes found in [response codes](https://wiki.onap.org/).
36869 description: Unique id of VNF. This is unique across the graph.
36872 example: __VNF-ID__
36873 - name: vf-module-id
36875 description: Unique ID of vf-module.
36878 example: __VF-MODULE-ID__
36881 description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
36884 $ref: "#/definitions/vf-module"
36888 summary: update an existing vf-module
36890 Update an existing vf-module
36892 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36893 The PUT operation will entirely replace an existing object.
36894 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
36896 Other differences between PUT and PATCH are:
36898 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
36899 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36900 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36901 operationId: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
36910 description: Response codes found in [response codes](https://wiki.onap.org/).
36914 description: Unique id of VNF. This is unique across the graph.
36917 example: __VNF-ID__
36918 - name: vf-module-id
36920 description: Unique ID of vf-module.
36923 example: __VF-MODULE-ID__
36926 description: vf-module object that needs to be created or updated.
36929 $ref: "#/patchDefinitions/vf-module"
36933 summary: delete an existing vf-module
36934 description: delete an existing vf-module
36935 operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule
36944 description: Response codes found in [response codes](https://wiki.onap.org/).
36948 description: Unique id of VNF. This is unique across the graph.
36951 example: __VNF-ID__
36952 - name: vf-module-id
36954 description: Unique ID of vf-module.
36957 example: __VF-MODULE-ID__
36958 - name: resource-version
36960 description: resource-version for concurrency
36963 /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules:
36967 summary: returns vf-modules
36968 description: returns vf-modules
36969 operationId: getNetworkGenericVnfsGenericVnfVfModules
36975 description: successful operation
36977 $ref: "#/getDefinitions/vf-modules"
36979 description: Response codes found in [response codes](https://wiki.onap.org/).
36983 description: Unique id of VNF. This is unique across the graph.
36986 example: __VNF-ID__
36989 description: Name of VNF.
36994 description: Alternate name of VNF.
36999 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
37004 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
37007 - name: regional-resource-zone
37009 description: Regional way of organizing pservers, source of truth should define values
37012 - name: prov-status
37014 description: Trigger for operational monitoring of this resource by Service Assurance systems.
37017 - name: heat-stack-id
37019 description: Heat stack id corresponding to this instance, managed by MSO
37026 - name: is-closed-loop-disabled
37030 - name: persona-model-id
37032 description: the ASDC model id for this resource or service model.
37035 - name: persona-model-version
37037 description: the ASDC model version for this resource or service model.
37040 - name: widget-model-id
37042 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37045 - name: widget-model-version
37047 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37050 /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
37054 summary: see node definition for valid relationships
37055 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
37064 description: Response codes found in [response codes](https://wiki.onap.org/).
37068 description: Unique id of VNF. This is unique across the graph.
37071 example: __VNF-ID__
37074 description: Unique ID for the license group the resource belongs to, should be uuid.
37077 example: __GROUP-UUID__
37078 - name: resource-uuid
37080 description: Unique ID of a license resource.
37083 example: __RESOURCE-UUID__
37086 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLicensesLicense.json)
37089 $ref: "#/definitions/relationship"
37093 summary: delete an existing relationship
37094 description: delete an existing relationship
37095 operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
37104 description: Response codes found in [response codes](https://wiki.onap.org/).
37108 description: Unique id of VNF. This is unique across the graph.
37111 example: __VNF-ID__
37114 description: Unique ID for the license group the resource belongs to, should be uuid.
37117 example: __GROUP-UUID__
37118 - name: resource-uuid
37120 description: Unique ID of a license resource.
37123 example: __RESOURCE-UUID__
37124 /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
37128 summary: returns license
37129 description: returns license
37130 operationId: getNetworkGenericVnfsGenericVnfLicensesLicense
37136 description: successful operation
37138 $ref: "#/getDefinitions/license"
37140 description: Response codes found in [response codes](https://wiki.onap.org/).
37144 description: Unique id of VNF. This is unique across the graph.
37147 example: __VNF-ID__
37150 description: Unique ID for the license group the resource belongs to, should be uuid.
37153 example: __GROUP-UUID__
37154 - name: resource-uuid
37156 description: Unique ID of a license resource.
37159 example: __RESOURCE-UUID__
37162 description: Name of VNF.
37167 description: Alternate name of VNF.
37172 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
37177 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
37180 - name: regional-resource-zone
37182 description: Regional way of organizing pservers, source of truth should define values
37185 - name: prov-status
37187 description: Trigger for operational monitoring of this resource by Service Assurance systems.
37190 - name: heat-stack-id
37192 description: Heat stack id corresponding to this instance, managed by MSO
37199 - name: is-closed-loop-disabled
37203 - name: persona-model-id
37205 description: the ASDC model id for this resource or service model.
37208 - name: persona-model-version
37210 description: the ASDC model version for this resource or service model.
37213 - name: widget-model-id
37215 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37218 - name: widget-model-version
37220 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37226 summary: create or update an existing license
37228 Create or update an existing license.
37230 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37231 operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense
37240 description: Response codes found in [response codes](https://wiki.onap.org/).
37244 description: Unique id of VNF. This is unique across the graph.
37247 example: __VNF-ID__
37250 description: Unique ID for the license group the resource belongs to, should be uuid.
37253 example: __GROUP-UUID__
37254 - name: resource-uuid
37256 description: Unique ID of a license resource.
37259 example: __RESOURCE-UUID__
37262 description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfLicensesLicense.json)
37265 $ref: "#/definitions/license"
37269 summary: update an existing license
37271 Update an existing license
37273 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37274 The PUT operation will entirely replace an existing object.
37275 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37277 Other differences between PUT and PATCH are:
37279 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37280 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37281 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37282 operationId: UpdateNetworkGenericVnfsGenericVnfLicensesLicense
37291 description: Response codes found in [response codes](https://wiki.onap.org/).
37295 description: Unique id of VNF. This is unique across the graph.
37298 example: __VNF-ID__
37301 description: Unique ID for the license group the resource belongs to, should be uuid.
37304 example: __GROUP-UUID__
37305 - name: resource-uuid
37307 description: Unique ID of a license resource.
37310 example: __RESOURCE-UUID__
37313 description: license object that needs to be created or updated.
37316 $ref: "#/patchDefinitions/license"
37320 summary: delete an existing license
37321 description: delete an existing license
37322 operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicense
37331 description: Response codes found in [response codes](https://wiki.onap.org/).
37335 description: Unique id of VNF. This is unique across the graph.
37338 example: __VNF-ID__
37341 description: Unique ID for the license group the resource belongs to, should be uuid.
37344 example: __GROUP-UUID__
37345 - name: resource-uuid
37347 description: Unique ID of a license resource.
37350 example: __RESOURCE-UUID__
37351 - name: resource-version
37353 description: resource-version for concurrency
37356 /network/generic-vnfs/generic-vnf/{vnf-id}/licenses:
37360 summary: returns licenses
37361 description: returns licenses
37362 operationId: getNetworkGenericVnfsGenericVnfLicenses
37368 description: successful operation
37370 $ref: "#/getDefinitions/licenses"
37372 description: Response codes found in [response codes](https://wiki.onap.org/).
37376 description: Unique id of VNF. This is unique across the graph.
37379 example: __VNF-ID__
37382 description: Name of VNF.
37387 description: Alternate name of VNF.
37392 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
37397 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
37400 - name: regional-resource-zone
37402 description: Regional way of organizing pservers, source of truth should define values
37405 - name: prov-status
37407 description: Trigger for operational monitoring of this resource by Service Assurance systems.
37410 - name: heat-stack-id
37412 description: Heat stack id corresponding to this instance, managed by MSO
37419 - name: is-closed-loop-disabled
37423 - name: persona-model-id
37425 description: the ASDC model id for this resource or service model.
37428 - name: persona-model-version
37430 description: the ASDC model version for this resource or service model.
37433 - name: widget-model-id
37435 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37438 - name: widget-model-version
37440 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37443 /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
37447 summary: see node definition for valid relationships
37448 operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
37457 description: Response codes found in [response codes](https://wiki.onap.org/).
37461 description: Unique id of VNF. This is unique across the graph.
37464 example: __VNF-ID__
37467 description: Unique ID for the entitlement group the resource comes from, should be uuid.
37470 example: __GROUP-UUID__
37471 - name: resource-uuid
37473 description: Unique ID of an entitlement resource.
37476 example: __RESOURCE-UUID__
37479 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
37482 $ref: "#/definitions/relationship"
37486 summary: delete an existing relationship
37487 description: delete an existing relationship
37488 operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
37497 description: Response codes found in [response codes](https://wiki.onap.org/).
37501 description: Unique id of VNF. This is unique across the graph.
37504 example: __VNF-ID__
37507 description: Unique ID for the entitlement group the resource comes from, should be uuid.
37510 example: __GROUP-UUID__
37511 - name: resource-uuid
37513 description: Unique ID of an entitlement resource.
37516 example: __RESOURCE-UUID__
37517 /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
37521 summary: returns entitlement
37522 description: returns entitlement
37523 operationId: getNetworkGenericVnfsGenericVnfEntitlementsEntitlement
37529 description: successful operation
37531 $ref: "#/getDefinitions/entitlement"
37533 description: Response codes found in [response codes](https://wiki.onap.org/).
37537 description: Unique id of VNF. This is unique across the graph.
37540 example: __VNF-ID__
37543 description: Unique ID for the entitlement group the resource comes from, should be uuid.
37546 example: __GROUP-UUID__
37547 - name: resource-uuid
37549 description: Unique ID of an entitlement resource.
37552 example: __RESOURCE-UUID__
37555 description: Name of VNF.
37560 description: Alternate name of VNF.
37565 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
37570 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
37573 - name: regional-resource-zone
37575 description: Regional way of organizing pservers, source of truth should define values
37578 - name: prov-status
37580 description: Trigger for operational monitoring of this resource by Service Assurance systems.
37583 - name: heat-stack-id
37585 description: Heat stack id corresponding to this instance, managed by MSO
37592 - name: is-closed-loop-disabled
37596 - name: persona-model-id
37598 description: the ASDC model id for this resource or service model.
37601 - name: persona-model-version
37603 description: the ASDC model version for this resource or service model.
37606 - name: widget-model-id
37608 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37611 - name: widget-model-version
37613 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37619 summary: create or update an existing entitlement
37621 Create or update an existing entitlement.
37623 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37624 operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
37633 description: Response codes found in [response codes](https://wiki.onap.org/).
37637 description: Unique id of VNF. This is unique across the graph.
37640 example: __VNF-ID__
37643 description: Unique ID for the entitlement group the resource comes from, should be uuid.
37646 example: __GROUP-UUID__
37647 - name: resource-uuid
37649 description: Unique ID of an entitlement resource.
37652 example: __RESOURCE-UUID__
37655 description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
37658 $ref: "#/definitions/entitlement"
37662 summary: update an existing entitlement
37664 Update an existing entitlement
37666 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37667 The PUT operation will entirely replace an existing object.
37668 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37670 Other differences between PUT and PATCH are:
37672 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37673 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37674 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37675 operationId: UpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
37684 description: Response codes found in [response codes](https://wiki.onap.org/).
37688 description: Unique id of VNF. This is unique across the graph.
37691 example: __VNF-ID__
37694 description: Unique ID for the entitlement group the resource comes from, should be uuid.
37697 example: __GROUP-UUID__
37698 - name: resource-uuid
37700 description: Unique ID of an entitlement resource.
37703 example: __RESOURCE-UUID__
37706 description: entitlement object that needs to be created or updated.
37709 $ref: "#/patchDefinitions/entitlement"
37713 summary: delete an existing entitlement
37714 description: delete an existing entitlement
37715 operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlement
37724 description: Response codes found in [response codes](https://wiki.onap.org/).
37728 description: Unique id of VNF. This is unique across the graph.
37731 example: __VNF-ID__
37734 description: Unique ID for the entitlement group the resource comes from, should be uuid.
37737 example: __GROUP-UUID__
37738 - name: resource-uuid
37740 description: Unique ID of an entitlement resource.
37743 example: __RESOURCE-UUID__
37744 - name: resource-version
37746 description: resource-version for concurrency
37749 /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements:
37753 summary: returns entitlements
37754 description: returns entitlements
37755 operationId: getNetworkGenericVnfsGenericVnfEntitlements
37761 description: successful operation
37763 $ref: "#/getDefinitions/entitlements"
37765 description: Response codes found in [response codes](https://wiki.onap.org/).
37769 description: Unique id of VNF. This is unique across the graph.
37772 example: __VNF-ID__
37775 description: Name of VNF.
37780 description: Alternate name of VNF.
37785 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
37790 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
37793 - name: regional-resource-zone
37795 description: Regional way of organizing pservers, source of truth should define values
37798 - name: prov-status
37800 description: Trigger for operational monitoring of this resource by Service Assurance systems.
37803 - name: heat-stack-id
37805 description: Heat stack id corresponding to this instance, managed by MSO
37812 - name: is-closed-loop-disabled
37816 - name: persona-model-id
37818 description: the ASDC model id for this resource or service model.
37821 - name: persona-model-version
37823 description: the ASDC model version for this resource or service model.
37826 - name: widget-model-id
37828 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37831 - name: widget-model-version
37833 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37836 /network/generic-vnfs/generic-vnf/{vnf-id}:
37840 summary: returns generic-vnf
37841 description: returns generic-vnf
37842 operationId: getNetworkGenericVnfsGenericVnf
37848 description: successful operation
37850 $ref: "#/getDefinitions/generic-vnf"
37852 description: Response codes found in [response codes](https://wiki.onap.org/).
37856 description: Unique id of VNF. This is unique across the graph.
37859 example: __VNF-ID__
37862 description: Name of VNF.
37867 description: Alternate name of VNF.
37872 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
37877 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
37880 - name: regional-resource-zone
37882 description: Regional way of organizing pservers, source of truth should define values
37885 - name: prov-status
37887 description: Trigger for operational monitoring of this resource by Service Assurance systems.
37890 - name: heat-stack-id
37892 description: Heat stack id corresponding to this instance, managed by MSO
37899 - name: is-closed-loop-disabled
37903 - name: persona-model-id
37905 description: the ASDC model id for this resource or service model.
37908 - name: persona-model-version
37910 description: the ASDC model version for this resource or service model.
37913 - name: widget-model-id
37915 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37918 - name: widget-model-version
37920 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37926 summary: create or update an existing generic-vnf
37928 Create or update an existing generic-vnf.
37930 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
37931 operationId: createOrUpdateNetworkGenericVnfsGenericVnf
37940 description: Response codes found in [response codes](https://wiki.onap.org/).
37944 description: Unique id of VNF. This is unique across the graph.
37947 example: __VNF-ID__
37950 description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkGenericVnfsGenericVnf.json)
37953 $ref: "#/definitions/generic-vnf"
37957 summary: update an existing generic-vnf
37959 Update an existing generic-vnf
37961 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37962 The PUT operation will entirely replace an existing object.
37963 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
37965 Other differences between PUT and PATCH are:
37967 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
37968 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37969 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37970 operationId: UpdateNetworkGenericVnfsGenericVnf
37979 description: Response codes found in [response codes](https://wiki.onap.org/).
37983 description: Unique id of VNF. This is unique across the graph.
37986 example: __VNF-ID__
37989 description: generic-vnf object that needs to be created or updated.
37992 $ref: "#/patchDefinitions/generic-vnf"
37996 summary: delete an existing generic-vnf
37997 description: delete an existing generic-vnf
37998 operationId: deleteNetworkGenericVnfsGenericVnf
38007 description: Response codes found in [response codes](https://wiki.onap.org/).
38011 description: Unique id of VNF. This is unique across the graph.
38014 example: __VNF-ID__
38015 - name: resource-version
38017 description: resource-version for concurrency
38020 /network/generic-vnfs:
38024 summary: returns generic-vnfs
38025 description: returns generic-vnfs
38026 operationId: getNetworkGenericVnfs
38032 description: successful operation
38034 $ref: "#/getDefinitions/generic-vnfs"
38036 description: Response codes found in [response codes](https://wiki.onap.org/).
38037 /network/lag-links/lag-link/{link-name}/relationship-list/relationship:
38041 summary: see node definition for valid relationships
38042 operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship
38051 description: Response codes found in [response codes](https://wiki.onap.org/).
38055 description: Alphabetical concatenation of lag-interface names
38058 example: __LINK-NAME__
38061 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkLagLinksLagLink.json)
38064 $ref: "#/definitions/relationship"
38068 summary: delete an existing relationship
38069 description: delete an existing relationship
38070 operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship
38079 description: Response codes found in [response codes](https://wiki.onap.org/).
38083 description: Alphabetical concatenation of lag-interface names
38086 example: __LINK-NAME__
38087 /network/lag-links/lag-link/{link-name}:
38091 summary: returns lag-link
38092 description: returns lag-link
38093 operationId: getNetworkLagLinksLagLink
38099 description: successful operation
38101 $ref: "#/getDefinitions/lag-link"
38103 description: Response codes found in [response codes](https://wiki.onap.org/).
38107 description: Alphabetical concatenation of lag-interface names
38110 example: __LINK-NAME__
38114 summary: create or update an existing lag-link
38116 Create or update an existing lag-link.
38118 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38119 operationId: createOrUpdateNetworkLagLinksLagLink
38128 description: Response codes found in [response codes](https://wiki.onap.org/).
38132 description: Alphabetical concatenation of lag-interface names
38135 example: __LINK-NAME__
38138 description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkLagLinksLagLink.json)
38141 $ref: "#/definitions/lag-link"
38145 summary: update an existing lag-link
38147 Update an existing lag-link
38149 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38150 The PUT operation will entirely replace an existing object.
38151 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38153 Other differences between PUT and PATCH are:
38155 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38156 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38157 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38158 operationId: UpdateNetworkLagLinksLagLink
38167 description: Response codes found in [response codes](https://wiki.onap.org/).
38171 description: Alphabetical concatenation of lag-interface names
38174 example: __LINK-NAME__
38177 description: lag-link object that needs to be created or updated.
38180 $ref: "#/patchDefinitions/lag-link"
38184 summary: delete an existing lag-link
38185 description: delete an existing lag-link
38186 operationId: deleteNetworkLagLinksLagLink
38195 description: Response codes found in [response codes](https://wiki.onap.org/).
38199 description: Alphabetical concatenation of lag-interface names
38202 example: __LINK-NAME__
38203 - name: resource-version
38205 description: resource-version for concurrency
38208 /network/lag-links:
38212 summary: returns lag-links
38213 description: returns lag-links
38214 operationId: getNetworkLagLinks
38220 description: successful operation
38222 $ref: "#/getDefinitions/lag-links"
38224 description: Response codes found in [response codes](https://wiki.onap.org/).
38225 /network/newvces/newvce/{vnf-id2}/relationship-list/relationship:
38229 summary: see node definition for valid relationships
38230 operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship
38239 description: Response codes found in [response codes](https://wiki.onap.org/).
38243 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38246 example: __VNF-ID2__
38249 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvce.json)
38252 $ref: "#/definitions/relationship"
38256 summary: delete an existing relationship
38257 description: delete an existing relationship
38258 operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship
38267 description: Response codes found in [response codes](https://wiki.onap.org/).
38271 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38274 example: __VNF-ID2__
38275 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
38279 summary: see node definition for valid relationships
38280 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
38289 description: Response codes found in [response codes](https://wiki.onap.org/).
38293 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38296 example: __VNF-ID2__
38297 - name: interface-name
38299 description: Name given to the interface
38302 example: __INTERFACE-NAME__
38303 - name: vlan-interface
38305 description: String that identifies the interface
38308 example: __VLAN-INTERFACE__
38311 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
38314 $ref: "#/definitions/relationship"
38318 summary: delete an existing relationship
38319 description: delete an existing relationship
38320 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
38329 description: Response codes found in [response codes](https://wiki.onap.org/).
38333 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38336 example: __VNF-ID2__
38337 - name: interface-name
38339 description: Name given to the interface
38342 example: __INTERFACE-NAME__
38343 - name: vlan-interface
38345 description: String that identifies the interface
38348 example: __VLAN-INTERFACE__
38349 /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:
38353 summary: see node definition for valid relationships
38354 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
38363 description: Response codes found in [response codes](https://wiki.onap.org/).
38367 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38370 example: __VNF-ID2__
38371 - name: interface-name
38373 description: Name given to the interface
38376 example: __INTERFACE-NAME__
38377 - name: vlan-interface
38379 description: String that identifies the interface
38382 example: __VLAN-INTERFACE__
38383 - name: l3-interface-ipv4-address
38385 description: IP address
38388 example: __L3-INTERFACE-IPV4-ADDRESS__
38391 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
38394 $ref: "#/definitions/relationship"
38398 summary: delete an existing relationship
38399 description: delete an existing relationship
38400 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
38409 description: Response codes found in [response codes](https://wiki.onap.org/).
38413 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38416 example: __VNF-ID2__
38417 - name: interface-name
38419 description: Name given to the interface
38422 example: __INTERFACE-NAME__
38423 - name: vlan-interface
38425 description: String that identifies the interface
38428 example: __VLAN-INTERFACE__
38429 - name: l3-interface-ipv4-address
38431 description: IP address
38434 example: __L3-INTERFACE-IPV4-ADDRESS__
38435 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
38439 summary: returns l3-interface-ipv4-address-list
38440 description: returns l3-interface-ipv4-address-list
38441 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
38447 description: successful operation
38449 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
38451 description: Response codes found in [response codes](https://wiki.onap.org/).
38455 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38458 example: __VNF-ID2__
38459 - name: interface-name
38461 description: Name given to the interface
38464 example: __INTERFACE-NAME__
38465 - name: vlan-interface
38467 description: String that identifies the interface
38470 example: __VLAN-INTERFACE__
38471 - name: l3-interface-ipv4-address
38473 description: IP address
38476 example: __L3-INTERFACE-IPV4-ADDRESS__
38479 description: Name of VNF.
38484 description: Alternate name of VNF.
38489 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
38492 - name: prov-status
38494 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
38497 - name: heat-stack-id
38499 description: Heat stack id corresponding to this instance, managed by MSO
38502 - name: interface-id
38504 description: ID of interface
38509 description: MAC address for the interface
38512 - name: network-name
38514 description: Name of the network
38517 - name: vlan-id-inner
38519 description: Inner VLAN tag
38525 description: This indicates the customers VPN ID associated with this vlan
38528 - name: vlan-id-inner
38530 description: Inner VLAN tag
38534 - name: neutron-network-id
38536 description: Neutron network id of the interface that address belongs to
38539 - name: neutron-subnet-id
38541 description: Neutron id of subnet that address belongs to
38547 summary: create or update an existing l3-interface-ipv4-address-list
38549 Create or update an existing l3-interface-ipv4-address-list.
38551 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38552 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
38561 description: Response codes found in [response codes](https://wiki.onap.org/).
38565 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38568 example: __VNF-ID2__
38569 - name: interface-name
38571 description: Name given to the interface
38574 example: __INTERFACE-NAME__
38575 - name: vlan-interface
38577 description: String that identifies the interface
38580 example: __VLAN-INTERFACE__
38581 - name: l3-interface-ipv4-address
38583 description: IP address
38586 example: __L3-INTERFACE-IPV4-ADDRESS__
38589 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
38592 $ref: "#/definitions/l3-interface-ipv4-address-list"
38596 summary: update an existing l3-interface-ipv4-address-list
38598 Update an existing l3-interface-ipv4-address-list
38600 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38601 The PUT operation will entirely replace an existing object.
38602 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38604 Other differences between PUT and PATCH are:
38606 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38607 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38608 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38609 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
38618 description: Response codes found in [response codes](https://wiki.onap.org/).
38622 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38625 example: __VNF-ID2__
38626 - name: interface-name
38628 description: Name given to the interface
38631 example: __INTERFACE-NAME__
38632 - name: vlan-interface
38634 description: String that identifies the interface
38637 example: __VLAN-INTERFACE__
38638 - name: l3-interface-ipv4-address
38640 description: IP address
38643 example: __L3-INTERFACE-IPV4-ADDRESS__
38646 description: l3-interface-ipv4-address-list object that needs to be created or updated.
38649 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
38653 summary: delete an existing l3-interface-ipv4-address-list
38654 description: delete an existing l3-interface-ipv4-address-list
38655 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
38664 description: Response codes found in [response codes](https://wiki.onap.org/).
38668 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38671 example: __VNF-ID2__
38672 - name: interface-name
38674 description: Name given to the interface
38677 example: __INTERFACE-NAME__
38678 - name: vlan-interface
38680 description: String that identifies the interface
38683 example: __VLAN-INTERFACE__
38684 - name: l3-interface-ipv4-address
38686 description: IP address
38689 example: __L3-INTERFACE-IPV4-ADDRESS__
38690 - name: resource-version
38692 description: resource-version for concurrency
38695 /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:
38699 summary: see node definition for valid relationships
38700 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
38709 description: Response codes found in [response codes](https://wiki.onap.org/).
38713 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38716 example: __VNF-ID2__
38717 - name: interface-name
38719 description: Name given to the interface
38722 example: __INTERFACE-NAME__
38723 - name: vlan-interface
38725 description: String that identifies the interface
38728 example: __VLAN-INTERFACE__
38729 - name: l3-interface-ipv6-address
38731 description: IP address
38734 example: __L3-INTERFACE-IPV6-ADDRESS__
38737 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
38740 $ref: "#/definitions/relationship"
38744 summary: delete an existing relationship
38745 description: delete an existing relationship
38746 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
38755 description: Response codes found in [response codes](https://wiki.onap.org/).
38759 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38762 example: __VNF-ID2__
38763 - name: interface-name
38765 description: Name given to the interface
38768 example: __INTERFACE-NAME__
38769 - name: vlan-interface
38771 description: String that identifies the interface
38774 example: __VLAN-INTERFACE__
38775 - name: l3-interface-ipv6-address
38777 description: IP address
38780 example: __L3-INTERFACE-IPV6-ADDRESS__
38781 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
38785 summary: returns l3-interface-ipv6-address-list
38786 description: returns l3-interface-ipv6-address-list
38787 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38793 description: successful operation
38795 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
38797 description: Response codes found in [response codes](https://wiki.onap.org/).
38801 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38804 example: __VNF-ID2__
38805 - name: interface-name
38807 description: Name given to the interface
38810 example: __INTERFACE-NAME__
38811 - name: vlan-interface
38813 description: String that identifies the interface
38816 example: __VLAN-INTERFACE__
38817 - name: l3-interface-ipv6-address
38819 description: IP address
38822 example: __L3-INTERFACE-IPV6-ADDRESS__
38825 description: Name of VNF.
38830 description: Alternate name of VNF.
38835 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
38838 - name: prov-status
38840 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
38843 - name: heat-stack-id
38845 description: Heat stack id corresponding to this instance, managed by MSO
38848 - name: interface-id
38850 description: ID of interface
38855 description: MAC address for the interface
38858 - name: network-name
38860 description: Name of the network
38863 - name: vlan-id-inner
38865 description: Inner VLAN tag
38871 description: This indicates the customers VPN ID associated with this vlan
38874 - name: vlan-id-inner
38876 description: Inner VLAN tag
38880 - name: neutron-network-id
38882 description: Neutron network id of the interface that address belongs to
38885 - name: neutron-subnet-id
38887 description: Neutron id of subnet that address belongs to
38893 summary: create or update an existing l3-interface-ipv6-address-list
38895 Create or update an existing l3-interface-ipv6-address-list.
38897 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
38898 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38907 description: Response codes found in [response codes](https://wiki.onap.org/).
38911 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38914 example: __VNF-ID2__
38915 - name: interface-name
38917 description: Name given to the interface
38920 example: __INTERFACE-NAME__
38921 - name: vlan-interface
38923 description: String that identifies the interface
38926 example: __VLAN-INTERFACE__
38927 - name: l3-interface-ipv6-address
38929 description: IP address
38932 example: __L3-INTERFACE-IPV6-ADDRESS__
38935 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
38938 $ref: "#/definitions/l3-interface-ipv6-address-list"
38942 summary: update an existing l3-interface-ipv6-address-list
38944 Update an existing l3-interface-ipv6-address-list
38946 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38947 The PUT operation will entirely replace an existing object.
38948 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
38950 Other differences between PUT and PATCH are:
38952 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
38953 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38954 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38955 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38964 description: Response codes found in [response codes](https://wiki.onap.org/).
38968 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38971 example: __VNF-ID2__
38972 - name: interface-name
38974 description: Name given to the interface
38977 example: __INTERFACE-NAME__
38978 - name: vlan-interface
38980 description: String that identifies the interface
38983 example: __VLAN-INTERFACE__
38984 - name: l3-interface-ipv6-address
38986 description: IP address
38989 example: __L3-INTERFACE-IPV6-ADDRESS__
38992 description: l3-interface-ipv6-address-list object that needs to be created or updated.
38995 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
38999 summary: delete an existing l3-interface-ipv6-address-list
39000 description: delete an existing l3-interface-ipv6-address-list
39001 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
39010 description: Response codes found in [response codes](https://wiki.onap.org/).
39014 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39017 example: __VNF-ID2__
39018 - name: interface-name
39020 description: Name given to the interface
39023 example: __INTERFACE-NAME__
39024 - name: vlan-interface
39026 description: String that identifies the interface
39029 example: __VLAN-INTERFACE__
39030 - name: l3-interface-ipv6-address
39032 description: IP address
39035 example: __L3-INTERFACE-IPV6-ADDRESS__
39036 - name: resource-version
39038 description: resource-version for concurrency
39041 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
39045 summary: returns vlan
39046 description: returns vlan
39047 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
39053 description: successful operation
39055 $ref: "#/getDefinitions/vlan"
39057 description: Response codes found in [response codes](https://wiki.onap.org/).
39061 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39064 example: __VNF-ID2__
39065 - name: interface-name
39067 description: Name given to the interface
39070 example: __INTERFACE-NAME__
39071 - name: vlan-interface
39073 description: String that identifies the interface
39076 example: __VLAN-INTERFACE__
39079 description: Name of VNF.
39084 description: Alternate name of VNF.
39089 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
39092 - name: prov-status
39094 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
39097 - name: heat-stack-id
39099 description: Heat stack id corresponding to this instance, managed by MSO
39102 - name: interface-id
39104 description: ID of interface
39109 description: MAC address for the interface
39112 - name: network-name
39114 description: Name of the network
39117 - name: vlan-id-inner
39119 description: Inner VLAN tag
39125 description: This indicates the customers VPN ID associated with this vlan
39131 summary: create or update an existing vlan
39133 Create or update an existing vlan.
39135 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39136 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
39145 description: Response codes found in [response codes](https://wiki.onap.org/).
39149 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39152 example: __VNF-ID2__
39153 - name: interface-name
39155 description: Name given to the interface
39158 example: __INTERFACE-NAME__
39159 - name: vlan-interface
39161 description: String that identifies the interface
39164 example: __VLAN-INTERFACE__
39167 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
39170 $ref: "#/definitions/vlan"
39174 summary: update an existing vlan
39176 Update an existing vlan
39178 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39179 The PUT operation will entirely replace an existing object.
39180 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39182 Other differences between PUT and PATCH are:
39184 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39185 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39186 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39187 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
39196 description: Response codes found in [response codes](https://wiki.onap.org/).
39200 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39203 example: __VNF-ID2__
39204 - name: interface-name
39206 description: Name given to the interface
39209 example: __INTERFACE-NAME__
39210 - name: vlan-interface
39212 description: String that identifies the interface
39215 example: __VLAN-INTERFACE__
39218 description: vlan object that needs to be created or updated.
39221 $ref: "#/patchDefinitions/vlan"
39225 summary: delete an existing vlan
39226 description: delete an existing vlan
39227 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
39236 description: Response codes found in [response codes](https://wiki.onap.org/).
39240 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39243 example: __VNF-ID2__
39244 - name: interface-name
39246 description: Name given to the interface
39249 example: __INTERFACE-NAME__
39250 - name: vlan-interface
39252 description: String that identifies the interface
39255 example: __VLAN-INTERFACE__
39256 - name: resource-version
39258 description: resource-version for concurrency
39261 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans:
39265 summary: returns vlans
39266 description: returns vlans
39267 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans
39273 description: successful operation
39275 $ref: "#/getDefinitions/vlans"
39277 description: Response codes found in [response codes](https://wiki.onap.org/).
39281 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39284 example: __VNF-ID2__
39285 - name: interface-name
39287 description: Name given to the interface
39290 example: __INTERFACE-NAME__
39293 description: Name of VNF.
39298 description: Alternate name of VNF.
39303 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
39306 - name: prov-status
39308 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
39311 - name: heat-stack-id
39313 description: Heat stack id corresponding to this instance, managed by MSO
39316 - name: interface-id
39318 description: ID of interface
39323 description: MAC address for the interface
39326 - name: network-name
39328 description: Name of the network
39331 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
39335 summary: see node definition for valid relationships
39336 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
39345 description: Response codes found in [response codes](https://wiki.onap.org/).
39349 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39352 example: __VNF-ID2__
39353 - name: interface-name
39355 description: Name given to the interface
39358 example: __INTERFACE-NAME__
39361 description: PCI ID used to identify the sriov-vf
39364 example: __PCI-ID__
39367 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
39370 $ref: "#/definitions/relationship"
39374 summary: delete an existing relationship
39375 description: delete an existing relationship
39376 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
39385 description: Response codes found in [response codes](https://wiki.onap.org/).
39389 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39392 example: __VNF-ID2__
39393 - name: interface-name
39395 description: Name given to the interface
39398 example: __INTERFACE-NAME__
39401 description: PCI ID used to identify the sriov-vf
39404 example: __PCI-ID__
39405 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
39409 summary: returns sriov-vf
39410 description: returns sriov-vf
39411 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
39417 description: successful operation
39419 $ref: "#/getDefinitions/sriov-vf"
39421 description: Response codes found in [response codes](https://wiki.onap.org/).
39425 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39428 example: __VNF-ID2__
39429 - name: interface-name
39431 description: Name given to the interface
39434 example: __INTERFACE-NAME__
39437 description: PCI ID used to identify the sriov-vf
39440 example: __PCI-ID__
39443 description: Name of VNF.
39448 description: Alternate name of VNF.
39453 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
39456 - name: prov-status
39458 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
39461 - name: heat-stack-id
39463 description: Heat stack id corresponding to this instance, managed by MSO
39466 - name: interface-id
39468 description: ID of interface
39473 description: MAC address for the interface
39476 - name: network-name
39478 description: Name of the network
39481 - name: vf-vlan-filter
39483 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
39486 - name: vf-mac-filter
39488 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
39491 - name: vf-vlan-strip
39493 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
39496 - name: neutron-network-id
39498 description: Neutron network id of the interface
39504 summary: create or update an existing sriov-vf
39506 Create or update an existing sriov-vf.
39508 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
39509 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
39518 description: Response codes found in [response codes](https://wiki.onap.org/).
39522 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39525 example: __VNF-ID2__
39526 - name: interface-name
39528 description: Name given to the interface
39531 example: __INTERFACE-NAME__
39534 description: PCI ID used to identify the sriov-vf
39537 example: __PCI-ID__
39540 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
39543 $ref: "#/definitions/sriov-vf"
39547 summary: update an existing sriov-vf
39549 Update an existing sriov-vf
39551 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39552 The PUT operation will entirely replace an existing object.
39553 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39555 Other differences between PUT and PATCH are:
39557 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39558 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39559 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39560 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
39569 description: Response codes found in [response codes](https://wiki.onap.org/).
39573 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39576 example: __VNF-ID2__
39577 - name: interface-name
39579 description: Name given to the interface
39582 example: __INTERFACE-NAME__
39585 description: PCI ID used to identify the sriov-vf
39588 example: __PCI-ID__
39591 description: sriov-vf object that needs to be created or updated.
39594 $ref: "#/patchDefinitions/sriov-vf"
39598 summary: delete an existing sriov-vf
39599 description: delete an existing sriov-vf
39600 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
39609 description: Response codes found in [response codes](https://wiki.onap.org/).
39613 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39616 example: __VNF-ID2__
39617 - name: interface-name
39619 description: Name given to the interface
39622 example: __INTERFACE-NAME__
39625 description: PCI ID used to identify the sriov-vf
39628 example: __PCI-ID__
39629 - name: resource-version
39631 description: resource-version for concurrency
39634 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
39638 summary: returns sriov-vfs
39639 description: returns sriov-vfs
39640 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs
39646 description: successful operation
39648 $ref: "#/getDefinitions/sriov-vfs"
39650 description: Response codes found in [response codes](https://wiki.onap.org/).
39654 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39657 example: __VNF-ID2__
39658 - name: interface-name
39660 description: Name given to the interface
39663 example: __INTERFACE-NAME__
39666 description: Name of VNF.
39671 description: Alternate name of VNF.
39676 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
39679 - name: prov-status
39681 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
39684 - name: heat-stack-id
39686 description: Heat stack id corresponding to this instance, managed by MSO
39689 - name: interface-id
39691 description: ID of interface
39696 description: MAC address for the interface
39699 - name: network-name
39701 description: Name of the network
39704 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
39708 summary: see node definition for valid relationships
39709 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
39718 description: Response codes found in [response codes](https://wiki.onap.org/).
39722 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39725 example: __VNF-ID2__
39726 - name: interface-name
39728 description: Name given to the interface
39731 example: __INTERFACE-NAME__
39734 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterface.json)
39737 $ref: "#/definitions/relationship"
39741 summary: delete an existing relationship
39742 description: delete an existing relationship
39743 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
39752 description: Response codes found in [response codes](https://wiki.onap.org/).
39756 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39759 example: __VNF-ID2__
39760 - name: interface-name
39762 description: Name given to the interface
39765 example: __INTERFACE-NAME__
39766 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
39770 summary: see node definition for valid relationships
39771 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
39780 description: Response codes found in [response codes](https://wiki.onap.org/).
39784 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39787 example: __VNF-ID2__
39788 - name: interface-name
39790 description: Name given to the interface
39793 example: __INTERFACE-NAME__
39794 - name: l3-interface-ipv4-address
39796 description: IP address
39799 example: __L3-INTERFACE-IPV4-ADDRESS__
39802 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
39805 $ref: "#/definitions/relationship"
39809 summary: delete an existing relationship
39810 description: delete an existing relationship
39811 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
39820 description: Response codes found in [response codes](https://wiki.onap.org/).
39824 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39827 example: __VNF-ID2__
39828 - name: interface-name
39830 description: Name given to the interface
39833 example: __INTERFACE-NAME__
39834 - name: l3-interface-ipv4-address
39836 description: IP address
39839 example: __L3-INTERFACE-IPV4-ADDRESS__
39840 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
39844 summary: returns l3-interface-ipv4-address-list
39845 description: returns l3-interface-ipv4-address-list
39846 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39852 description: successful operation
39854 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
39856 description: Response codes found in [response codes](https://wiki.onap.org/).
39860 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39863 example: __VNF-ID2__
39864 - name: interface-name
39866 description: Name given to the interface
39869 example: __INTERFACE-NAME__
39870 - name: l3-interface-ipv4-address
39872 description: IP address
39875 example: __L3-INTERFACE-IPV4-ADDRESS__
39878 description: Name of VNF.
39883 description: Alternate name of VNF.
39888 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
39891 - name: prov-status
39893 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
39896 - name: heat-stack-id
39898 description: Heat stack id corresponding to this instance, managed by MSO
39901 - name: interface-id
39903 description: ID of interface
39908 description: MAC address for the interface
39911 - name: network-name
39913 description: Name of the network
39916 - name: vlan-id-inner
39918 description: Inner VLAN tag
39922 - name: neutron-network-id
39924 description: Neutron network id of the interface that address belongs to
39927 - name: neutron-subnet-id
39929 description: Neutron id of subnet that address belongs to
39935 summary: create or update an existing l3-interface-ipv4-address-list
39937 Create or update an existing l3-interface-ipv4-address-list.
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: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39949 description: Response codes found in [response codes](https://wiki.onap.org/).
39953 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39956 example: __VNF-ID2__
39957 - name: interface-name
39959 description: Name given to the interface
39962 example: __INTERFACE-NAME__
39963 - name: l3-interface-ipv4-address
39965 description: IP address
39968 example: __L3-INTERFACE-IPV4-ADDRESS__
39971 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
39974 $ref: "#/definitions/l3-interface-ipv4-address-list"
39978 summary: update an existing l3-interface-ipv4-address-list
39980 Update an existing l3-interface-ipv4-address-list
39982 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39983 The PUT operation will entirely replace an existing object.
39984 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
39986 Other differences between PUT and PATCH are:
39988 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
39989 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39990 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39991 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
40000 description: Response codes found in [response codes](https://wiki.onap.org/).
40004 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40007 example: __VNF-ID2__
40008 - name: interface-name
40010 description: Name given to the interface
40013 example: __INTERFACE-NAME__
40014 - name: l3-interface-ipv4-address
40016 description: IP address
40019 example: __L3-INTERFACE-IPV4-ADDRESS__
40022 description: l3-interface-ipv4-address-list object that needs to be created or updated.
40025 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
40029 summary: delete an existing l3-interface-ipv4-address-list
40030 description: delete an existing l3-interface-ipv4-address-list
40031 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
40040 description: Response codes found in [response codes](https://wiki.onap.org/).
40044 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40047 example: __VNF-ID2__
40048 - name: interface-name
40050 description: Name given to the interface
40053 example: __INTERFACE-NAME__
40054 - name: l3-interface-ipv4-address
40056 description: IP address
40059 example: __L3-INTERFACE-IPV4-ADDRESS__
40060 - name: resource-version
40062 description: resource-version for concurrency
40065 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
40069 summary: see node definition for valid relationships
40070 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
40079 description: Response codes found in [response codes](https://wiki.onap.org/).
40083 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40086 example: __VNF-ID2__
40087 - name: interface-name
40089 description: Name given to the interface
40092 example: __INTERFACE-NAME__
40093 - name: l3-interface-ipv6-address
40095 description: IP address
40098 example: __L3-INTERFACE-IPV6-ADDRESS__
40101 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
40104 $ref: "#/definitions/relationship"
40108 summary: delete an existing relationship
40109 description: delete an existing relationship
40110 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
40119 description: Response codes found in [response codes](https://wiki.onap.org/).
40123 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40126 example: __VNF-ID2__
40127 - name: interface-name
40129 description: Name given to the interface
40132 example: __INTERFACE-NAME__
40133 - name: l3-interface-ipv6-address
40135 description: IP address
40138 example: __L3-INTERFACE-IPV6-ADDRESS__
40139 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
40143 summary: returns l3-interface-ipv6-address-list
40144 description: returns l3-interface-ipv6-address-list
40145 operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
40151 description: successful operation
40153 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
40155 description: Response codes found in [response codes](https://wiki.onap.org/).
40159 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40162 example: __VNF-ID2__
40163 - name: interface-name
40165 description: Name given to the interface
40168 example: __INTERFACE-NAME__
40169 - name: l3-interface-ipv6-address
40171 description: IP address
40174 example: __L3-INTERFACE-IPV6-ADDRESS__
40177 description: Name of VNF.
40182 description: Alternate name of VNF.
40187 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
40190 - name: prov-status
40192 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
40195 - name: heat-stack-id
40197 description: Heat stack id corresponding to this instance, managed by MSO
40200 - name: interface-id
40202 description: ID of interface
40207 description: MAC address for the interface
40210 - name: network-name
40212 description: Name of the network
40215 - name: vlan-id-inner
40217 description: Inner VLAN tag
40221 - name: neutron-network-id
40223 description: Neutron network id of the interface that address belongs to
40226 - name: neutron-subnet-id
40228 description: Neutron id of subnet that address belongs to
40234 summary: create or update an existing l3-interface-ipv6-address-list
40236 Create or update an existing l3-interface-ipv6-address-list.
40238 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40239 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
40248 description: Response codes found in [response codes](https://wiki.onap.org/).
40252 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40255 example: __VNF-ID2__
40256 - name: interface-name
40258 description: Name given to the interface
40261 example: __INTERFACE-NAME__
40262 - name: l3-interface-ipv6-address
40264 description: IP address
40267 example: __L3-INTERFACE-IPV6-ADDRESS__
40270 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
40273 $ref: "#/definitions/l3-interface-ipv6-address-list"
40277 summary: update an existing l3-interface-ipv6-address-list
40279 Update an existing l3-interface-ipv6-address-list
40281 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40282 The PUT operation will entirely replace an existing object.
40283 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40285 Other differences between PUT and PATCH are:
40287 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40288 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40289 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40290 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
40299 description: Response codes found in [response codes](https://wiki.onap.org/).
40303 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40306 example: __VNF-ID2__
40307 - name: interface-name
40309 description: Name given to the interface
40312 example: __INTERFACE-NAME__
40313 - name: l3-interface-ipv6-address
40315 description: IP address
40318 example: __L3-INTERFACE-IPV6-ADDRESS__
40321 description: l3-interface-ipv6-address-list object that needs to be created or updated.
40324 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
40328 summary: delete an existing l3-interface-ipv6-address-list
40329 description: delete an existing l3-interface-ipv6-address-list
40330 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
40339 description: Response codes found in [response codes](https://wiki.onap.org/).
40343 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40346 example: __VNF-ID2__
40347 - name: interface-name
40349 description: Name given to the interface
40352 example: __INTERFACE-NAME__
40353 - name: l3-interface-ipv6-address
40355 description: IP address
40358 example: __L3-INTERFACE-IPV6-ADDRESS__
40359 - name: resource-version
40361 description: resource-version for concurrency
40364 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}:
40368 summary: returns l-interface
40369 description: returns l-interface
40370 operationId: getNetworkNewvcesNewvceLInterfacesLInterface
40376 description: successful operation
40378 $ref: "#/getDefinitions/l-interface"
40380 description: Response codes found in [response codes](https://wiki.onap.org/).
40384 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40387 example: __VNF-ID2__
40388 - name: interface-name
40390 description: Name given to the interface
40393 example: __INTERFACE-NAME__
40396 description: Name of VNF.
40401 description: Alternate name of VNF.
40406 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
40409 - name: prov-status
40411 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
40414 - name: heat-stack-id
40416 description: Heat stack id corresponding to this instance, managed by MSO
40419 - name: interface-id
40421 description: ID of interface
40426 description: MAC address for the interface
40429 - name: network-name
40431 description: Name of the network
40437 summary: create or update an existing l-interface
40439 Create or update an existing l-interface.
40441 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40442 operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface
40451 description: Response codes found in [response codes](https://wiki.onap.org/).
40455 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40458 example: __VNF-ID2__
40459 - name: interface-name
40461 description: Name given to the interface
40464 example: __INTERFACE-NAME__
40467 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvceLInterfacesLInterface.json)
40470 $ref: "#/definitions/l-interface"
40474 summary: update an existing l-interface
40476 Update an existing l-interface
40478 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40479 The PUT operation will entirely replace an existing object.
40480 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40482 Other differences between PUT and PATCH are:
40484 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40485 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40486 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40487 operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterface
40496 description: Response codes found in [response codes](https://wiki.onap.org/).
40500 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40503 example: __VNF-ID2__
40504 - name: interface-name
40506 description: Name given to the interface
40509 example: __INTERFACE-NAME__
40512 description: l-interface object that needs to be created or updated.
40515 $ref: "#/patchDefinitions/l-interface"
40519 summary: delete an existing l-interface
40520 description: delete an existing l-interface
40521 operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface
40530 description: Response codes found in [response codes](https://wiki.onap.org/).
40534 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40537 example: __VNF-ID2__
40538 - name: interface-name
40540 description: Name given to the interface
40543 example: __INTERFACE-NAME__
40544 - name: resource-version
40546 description: resource-version for concurrency
40549 /network/newvces/newvce/{vnf-id2}/l-interfaces:
40553 summary: returns l-interfaces
40554 description: returns l-interfaces
40555 operationId: getNetworkNewvcesNewvceLInterfaces
40561 description: successful operation
40563 $ref: "#/getDefinitions/l-interfaces"
40565 description: Response codes found in [response codes](https://wiki.onap.org/).
40569 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40572 example: __VNF-ID2__
40575 description: Name of VNF.
40580 description: Alternate name of VNF.
40585 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
40588 - name: prov-status
40590 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
40593 - name: heat-stack-id
40595 description: Heat stack id corresponding to this instance, managed by MSO
40598 /network/newvces/newvce/{vnf-id2}:
40602 summary: returns newvce
40603 description: returns newvce
40604 operationId: getNetworkNewvcesNewvce
40610 description: successful operation
40612 $ref: "#/getDefinitions/newvce"
40614 description: Response codes found in [response codes](https://wiki.onap.org/).
40618 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40621 example: __VNF-ID2__
40624 description: Name of VNF.
40629 description: Alternate name of VNF.
40634 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
40637 - name: prov-status
40639 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
40642 - name: heat-stack-id
40644 description: Heat stack id corresponding to this instance, managed by MSO
40650 summary: create or update an existing newvce
40652 Create or update an existing newvce.
40654 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
40655 operationId: createOrUpdateNetworkNewvcesNewvce
40664 description: Response codes found in [response codes](https://wiki.onap.org/).
40668 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40671 example: __VNF-ID2__
40674 description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkNewvcesNewvce.json)
40677 $ref: "#/definitions/newvce"
40681 summary: update an existing newvce
40683 Update an existing newvce
40685 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40686 The PUT operation will entirely replace an existing object.
40687 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
40689 Other differences between PUT and PATCH are:
40691 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
40692 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40693 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40694 operationId: UpdateNetworkNewvcesNewvce
40703 description: Response codes found in [response codes](https://wiki.onap.org/).
40707 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40710 example: __VNF-ID2__
40713 description: newvce object that needs to be created or updated.
40716 $ref: "#/patchDefinitions/newvce"
40720 summary: delete an existing newvce
40721 description: delete an existing newvce
40722 operationId: deleteNetworkNewvcesNewvce
40731 description: Response codes found in [response codes](https://wiki.onap.org/).
40735 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40738 example: __VNF-ID2__
40739 - name: resource-version
40741 description: resource-version for concurrency
40748 summary: returns newvces
40749 description: returns newvces
40750 operationId: getNetworkNewvces
40756 description: successful operation
40758 $ref: "#/getDefinitions/newvces"
40760 description: Response codes found in [response codes](https://wiki.onap.org/).
40761 /network/pnfs/pnf/{pnf-name}/relationship-list/relationship:
40765 summary: see node definition for valid relationships
40766 operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship
40775 description: Response codes found in [response codes](https://wiki.onap.org/).
40779 description: unique name of Physical Network Function.
40782 example: __PNF-NAME__
40785 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnf.json)
40788 $ref: "#/definitions/relationship"
40792 summary: delete an existing relationship
40793 description: delete an existing relationship
40794 operationId: deleteNetworkPnfsPnfRelationshipListRelationship
40803 description: Response codes found in [response codes](https://wiki.onap.org/).
40807 description: unique name of Physical Network Function.
40810 example: __PNF-NAME__
40811 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
40815 summary: see node definition for valid relationships
40816 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
40825 description: Response codes found in [response codes](https://wiki.onap.org/).
40829 description: unique name of Physical Network Function.
40832 example: __PNF-NAME__
40833 - name: interface-name
40835 description: Name that identifies the physical interface
40838 example: __INTERFACE-NAME__
40841 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterface.json)
40844 $ref: "#/definitions/relationship"
40848 summary: delete an existing relationship
40849 description: delete an existing relationship
40850 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
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 physical interface
40872 example: __INTERFACE-NAME__
40873 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
40877 summary: see node definition for valid relationships
40878 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
40887 description: Response codes found in [response codes](https://wiki.onap.org/).
40891 description: unique name of Physical Network Function.
40894 example: __PNF-NAME__
40895 - name: interface-name
40897 description: Name that identifies the physical interface
40900 example: __INTERFACE-NAME__
40901 - name: interface-name
40903 description: Name given to the interface
40906 example: __INTERFACE-NAME__
40907 - name: vlan-interface
40909 description: String that identifies the interface
40912 example: __VLAN-INTERFACE__
40915 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
40918 $ref: "#/definitions/relationship"
40922 summary: delete an existing relationship
40923 description: delete an existing relationship
40924 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
40933 description: Response codes found in [response codes](https://wiki.onap.org/).
40937 description: unique name of Physical Network Function.
40940 example: __PNF-NAME__
40941 - name: interface-name
40943 description: Name that identifies the physical interface
40946 example: __INTERFACE-NAME__
40947 - name: interface-name
40949 description: Name given to the interface
40952 example: __INTERFACE-NAME__
40953 - name: vlan-interface
40955 description: String that identifies the interface
40958 example: __VLAN-INTERFACE__
40959 /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:
40963 summary: see node definition for valid relationships
40964 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
40973 description: Response codes found in [response codes](https://wiki.onap.org/).
40977 description: unique name of Physical Network Function.
40980 example: __PNF-NAME__
40981 - name: interface-name
40983 description: Name that identifies the physical interface
40986 example: __INTERFACE-NAME__
40987 - name: interface-name
40989 description: Name given to the interface
40992 example: __INTERFACE-NAME__
40993 - name: vlan-interface
40995 description: String that identifies the interface
40998 example: __VLAN-INTERFACE__
40999 - name: l3-interface-ipv4-address
41001 description: IP address
41004 example: __L3-INTERFACE-IPV4-ADDRESS__
41007 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
41010 $ref: "#/definitions/relationship"
41014 summary: delete an existing relationship
41015 description: delete an existing relationship
41016 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
41025 description: Response codes found in [response codes](https://wiki.onap.org/).
41029 description: unique name of Physical Network Function.
41032 example: __PNF-NAME__
41033 - name: interface-name
41035 description: Name that identifies the physical interface
41038 example: __INTERFACE-NAME__
41039 - name: interface-name
41041 description: Name given to the interface
41044 example: __INTERFACE-NAME__
41045 - name: vlan-interface
41047 description: String that identifies the interface
41050 example: __VLAN-INTERFACE__
41051 - name: l3-interface-ipv4-address
41053 description: IP address
41056 example: __L3-INTERFACE-IPV4-ADDRESS__
41057 /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}:
41061 summary: returns l3-interface-ipv4-address-list
41062 description: returns l3-interface-ipv4-address-list
41063 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
41069 description: successful operation
41071 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
41073 description: Response codes found in [response codes](https://wiki.onap.org/).
41077 description: unique name of Physical Network Function.
41080 example: __PNF-NAME__
41081 - name: interface-name
41083 description: Name that identifies the physical interface
41086 example: __INTERFACE-NAME__
41087 - name: interface-name
41089 description: Name given to the interface
41092 example: __INTERFACE-NAME__
41093 - name: vlan-interface
41095 description: String that identifies the interface
41098 example: __VLAN-INTERFACE__
41099 - name: l3-interface-ipv4-address
41101 description: IP address
41104 example: __L3-INTERFACE-IPV4-ADDRESS__
41107 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
41110 - name: prov-status
41112 description: Trigger for operational monitoring of this resource by Service Assurance systems.
41115 - name: interface-id
41117 description: ID of interface
41122 description: MAC address for the interface
41125 - name: network-name
41127 description: Name of the network
41130 - name: vlan-id-inner
41132 description: Inner VLAN tag
41138 description: This indicates the customers VPN ID associated with this vlan
41141 - name: vlan-id-inner
41143 description: Inner VLAN tag
41147 - name: neutron-network-id
41149 description: Neutron network id of the interface that address belongs to
41152 - name: neutron-subnet-id
41154 description: Neutron id of subnet that address belongs to
41160 summary: create or update an existing l3-interface-ipv4-address-list
41162 Create or update an existing l3-interface-ipv4-address-list.
41164 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
41165 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
41174 description: Response codes found in [response codes](https://wiki.onap.org/).
41178 description: unique name of Physical Network Function.
41181 example: __PNF-NAME__
41182 - name: interface-name
41184 description: Name that identifies the physical interface
41187 example: __INTERFACE-NAME__
41188 - name: interface-name
41190 description: Name given to the interface
41193 example: __INTERFACE-NAME__
41194 - name: vlan-interface
41196 description: String that identifies the interface
41199 example: __VLAN-INTERFACE__
41200 - name: l3-interface-ipv4-address
41202 description: IP address
41205 example: __L3-INTERFACE-IPV4-ADDRESS__
41208 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
41211 $ref: "#/definitions/l3-interface-ipv4-address-list"
41215 summary: update an existing l3-interface-ipv4-address-list
41217 Update an existing l3-interface-ipv4-address-list
41219 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41220 The PUT operation will entirely replace an existing object.
41221 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
41223 Other differences between PUT and PATCH are:
41225 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
41226 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41227 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41228 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
41237 description: Response codes found in [response codes](https://wiki.onap.org/).
41241 description: unique name of Physical Network Function.
41244 example: __PNF-NAME__
41245 - name: interface-name
41247 description: Name that identifies the physical interface
41250 example: __INTERFACE-NAME__
41251 - name: interface-name
41253 description: Name given to the interface
41256 example: __INTERFACE-NAME__
41257 - name: vlan-interface
41259 description: String that identifies the interface
41262 example: __VLAN-INTERFACE__
41263 - name: l3-interface-ipv4-address
41265 description: IP address
41268 example: __L3-INTERFACE-IPV4-ADDRESS__
41271 description: l3-interface-ipv4-address-list object that needs to be created or updated.
41274 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
41278 summary: delete an existing l3-interface-ipv4-address-list
41279 description: delete an existing l3-interface-ipv4-address-list
41280 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
41289 description: Response codes found in [response codes](https://wiki.onap.org/).
41293 description: unique name of Physical Network Function.
41296 example: __PNF-NAME__
41297 - name: interface-name
41299 description: Name that identifies the physical interface
41302 example: __INTERFACE-NAME__
41303 - name: interface-name
41305 description: Name given to the interface
41308 example: __INTERFACE-NAME__
41309 - name: vlan-interface
41311 description: String that identifies the interface
41314 example: __VLAN-INTERFACE__
41315 - name: l3-interface-ipv4-address
41317 description: IP address
41320 example: __L3-INTERFACE-IPV4-ADDRESS__
41321 - name: resource-version
41323 description: resource-version for concurrency
41326 /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:
41330 summary: see node definition for valid relationships
41331 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
41340 description: Response codes found in [response codes](https://wiki.onap.org/).
41344 description: unique name of Physical Network Function.
41347 example: __PNF-NAME__
41348 - name: interface-name
41350 description: Name that identifies the physical interface
41353 example: __INTERFACE-NAME__
41354 - name: interface-name
41356 description: Name given to the interface
41359 example: __INTERFACE-NAME__
41360 - name: vlan-interface
41362 description: String that identifies the interface
41365 example: __VLAN-INTERFACE__
41366 - name: l3-interface-ipv6-address
41368 description: IP address
41371 example: __L3-INTERFACE-IPV6-ADDRESS__
41374 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
41377 $ref: "#/definitions/relationship"
41381 summary: delete an existing relationship
41382 description: delete an existing relationship
41383 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
41392 description: Response codes found in [response codes](https://wiki.onap.org/).
41396 description: unique name of Physical Network Function.
41399 example: __PNF-NAME__
41400 - name: interface-name
41402 description: Name that identifies the physical interface
41405 example: __INTERFACE-NAME__
41406 - name: interface-name
41408 description: Name given to the interface
41411 example: __INTERFACE-NAME__
41412 - name: vlan-interface
41414 description: String that identifies the interface
41417 example: __VLAN-INTERFACE__
41418 - name: l3-interface-ipv6-address
41420 description: IP address
41423 example: __L3-INTERFACE-IPV6-ADDRESS__
41424 /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}:
41428 summary: returns l3-interface-ipv6-address-list
41429 description: returns l3-interface-ipv6-address-list
41430 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
41436 description: successful operation
41438 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
41440 description: Response codes found in [response codes](https://wiki.onap.org/).
41444 description: unique name of Physical Network Function.
41447 example: __PNF-NAME__
41448 - name: interface-name
41450 description: Name that identifies the physical interface
41453 example: __INTERFACE-NAME__
41454 - name: interface-name
41456 description: Name given to the interface
41459 example: __INTERFACE-NAME__
41460 - name: vlan-interface
41462 description: String that identifies the interface
41465 example: __VLAN-INTERFACE__
41466 - name: l3-interface-ipv6-address
41468 description: IP address
41471 example: __L3-INTERFACE-IPV6-ADDRESS__
41474 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
41477 - name: prov-status
41479 description: Trigger for operational monitoring of this resource by Service Assurance systems.
41482 - name: interface-id
41484 description: ID of interface
41489 description: MAC address for the interface
41492 - name: network-name
41494 description: Name of the network
41497 - name: vlan-id-inner
41499 description: Inner VLAN tag
41505 description: This indicates the customers VPN ID associated with this vlan
41508 - name: vlan-id-inner
41510 description: Inner VLAN tag
41514 - name: neutron-network-id
41516 description: Neutron network id of the interface that address belongs to
41519 - name: neutron-subnet-id
41521 description: Neutron id of subnet that address belongs to
41527 summary: create or update an existing l3-interface-ipv6-address-list
41529 Create or update an existing l3-interface-ipv6-address-list.
41531 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
41532 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
41541 description: Response codes found in [response codes](https://wiki.onap.org/).
41545 description: unique name of Physical Network Function.
41548 example: __PNF-NAME__
41549 - name: interface-name
41551 description: Name that identifies the physical interface
41554 example: __INTERFACE-NAME__
41555 - name: interface-name
41557 description: Name given to the interface
41560 example: __INTERFACE-NAME__
41561 - name: vlan-interface
41563 description: String that identifies the interface
41566 example: __VLAN-INTERFACE__
41567 - name: l3-interface-ipv6-address
41569 description: IP address
41572 example: __L3-INTERFACE-IPV6-ADDRESS__
41575 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
41578 $ref: "#/definitions/l3-interface-ipv6-address-list"
41582 summary: update an existing l3-interface-ipv6-address-list
41584 Update an existing l3-interface-ipv6-address-list
41586 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41587 The PUT operation will entirely replace an existing object.
41588 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
41590 Other differences between PUT and PATCH are:
41592 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
41593 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41594 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41595 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
41604 description: Response codes found in [response codes](https://wiki.onap.org/).
41608 description: unique name of Physical Network Function.
41611 example: __PNF-NAME__
41612 - name: interface-name
41614 description: Name that identifies the physical interface
41617 example: __INTERFACE-NAME__
41618 - name: interface-name
41620 description: Name given to the interface
41623 example: __INTERFACE-NAME__
41624 - name: vlan-interface
41626 description: String that identifies the interface
41629 example: __VLAN-INTERFACE__
41630 - name: l3-interface-ipv6-address
41632 description: IP address
41635 example: __L3-INTERFACE-IPV6-ADDRESS__
41638 description: l3-interface-ipv6-address-list object that needs to be created or updated.
41641 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
41645 summary: delete an existing l3-interface-ipv6-address-list
41646 description: delete an existing l3-interface-ipv6-address-list
41647 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
41656 description: Response codes found in [response codes](https://wiki.onap.org/).
41660 description: unique name of Physical Network Function.
41663 example: __PNF-NAME__
41664 - name: interface-name
41666 description: Name that identifies the physical interface
41669 example: __INTERFACE-NAME__
41670 - name: interface-name
41672 description: Name given to the interface
41675 example: __INTERFACE-NAME__
41676 - name: vlan-interface
41678 description: String that identifies the interface
41681 example: __VLAN-INTERFACE__
41682 - name: l3-interface-ipv6-address
41684 description: IP address
41687 example: __L3-INTERFACE-IPV6-ADDRESS__
41688 - name: resource-version
41690 description: resource-version for concurrency
41693 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
41697 summary: returns vlan
41698 description: returns vlan
41699 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
41705 description: successful operation
41707 $ref: "#/getDefinitions/vlan"
41709 description: Response codes found in [response codes](https://wiki.onap.org/).
41713 description: unique name of Physical Network Function.
41716 example: __PNF-NAME__
41717 - name: interface-name
41719 description: Name that identifies the physical interface
41722 example: __INTERFACE-NAME__
41723 - name: interface-name
41725 description: Name given to the interface
41728 example: __INTERFACE-NAME__
41729 - name: vlan-interface
41731 description: String that identifies the interface
41734 example: __VLAN-INTERFACE__
41737 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
41740 - name: prov-status
41742 description: Trigger for operational monitoring of this resource by Service Assurance systems.
41745 - name: interface-id
41747 description: ID of interface
41752 description: MAC address for the interface
41755 - name: network-name
41757 description: Name of the network
41760 - name: vlan-id-inner
41762 description: Inner VLAN tag
41768 description: This indicates the customers VPN ID associated with this vlan
41774 summary: create or update an existing vlan
41776 Create or update an existing vlan.
41778 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
41779 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
41788 description: Response codes found in [response codes](https://wiki.onap.org/).
41792 description: unique name of Physical Network Function.
41795 example: __PNF-NAME__
41796 - name: interface-name
41798 description: Name that identifies the physical interface
41801 example: __INTERFACE-NAME__
41802 - name: interface-name
41804 description: Name given to the interface
41807 example: __INTERFACE-NAME__
41808 - name: vlan-interface
41810 description: String that identifies the interface
41813 example: __VLAN-INTERFACE__
41816 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
41819 $ref: "#/definitions/vlan"
41823 summary: update an existing vlan
41825 Update an existing vlan
41827 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41828 The PUT operation will entirely replace an existing object.
41829 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
41831 Other differences between PUT and PATCH are:
41833 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
41834 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41835 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41836 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
41845 description: Response codes found in [response codes](https://wiki.onap.org/).
41849 description: unique name of Physical Network Function.
41852 example: __PNF-NAME__
41853 - name: interface-name
41855 description: Name that identifies the physical interface
41858 example: __INTERFACE-NAME__
41859 - name: interface-name
41861 description: Name given to the interface
41864 example: __INTERFACE-NAME__
41865 - name: vlan-interface
41867 description: String that identifies the interface
41870 example: __VLAN-INTERFACE__
41873 description: vlan object that needs to be created or updated.
41876 $ref: "#/patchDefinitions/vlan"
41880 summary: delete an existing vlan
41881 description: delete an existing vlan
41882 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
41891 description: Response codes found in [response codes](https://wiki.onap.org/).
41895 description: unique name of Physical Network Function.
41898 example: __PNF-NAME__
41899 - name: interface-name
41901 description: Name that identifies the physical interface
41904 example: __INTERFACE-NAME__
41905 - name: interface-name
41907 description: Name given to the interface
41910 example: __INTERFACE-NAME__
41911 - name: vlan-interface
41913 description: String that identifies the interface
41916 example: __VLAN-INTERFACE__
41917 - name: resource-version
41919 description: resource-version for concurrency
41922 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
41926 summary: returns vlans
41927 description: returns vlans
41928 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans
41934 description: successful operation
41936 $ref: "#/getDefinitions/vlans"
41938 description: Response codes found in [response codes](https://wiki.onap.org/).
41942 description: unique name of Physical Network Function.
41945 example: __PNF-NAME__
41946 - name: interface-name
41948 description: Name that identifies the physical interface
41951 example: __INTERFACE-NAME__
41952 - name: interface-name
41954 description: Name given to the interface
41957 example: __INTERFACE-NAME__
41960 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
41963 - name: prov-status
41965 description: Trigger for operational monitoring of this resource by Service Assurance systems.
41968 - name: interface-id
41970 description: ID of interface
41975 description: MAC address for the interface
41978 - name: network-name
41980 description: Name of the network
41983 /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:
41987 summary: see node definition for valid relationships
41988 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
41997 description: Response codes found in [response codes](https://wiki.onap.org/).
42001 description: unique name of Physical Network Function.
42004 example: __PNF-NAME__
42005 - name: interface-name
42007 description: Name that identifies the physical interface
42010 example: __INTERFACE-NAME__
42011 - name: interface-name
42013 description: Name given to the interface
42016 example: __INTERFACE-NAME__
42019 description: PCI ID used to identify the sriov-vf
42022 example: __PCI-ID__
42025 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
42028 $ref: "#/definitions/relationship"
42032 summary: delete an existing relationship
42033 description: delete an existing relationship
42034 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
42043 description: Response codes found in [response codes](https://wiki.onap.org/).
42047 description: unique name of Physical Network Function.
42050 example: __PNF-NAME__
42051 - name: interface-name
42053 description: Name that identifies the physical interface
42056 example: __INTERFACE-NAME__
42057 - name: interface-name
42059 description: Name given to the interface
42062 example: __INTERFACE-NAME__
42065 description: PCI ID used to identify the sriov-vf
42068 example: __PCI-ID__
42069 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
42073 summary: returns sriov-vf
42074 description: returns sriov-vf
42075 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
42081 description: successful operation
42083 $ref: "#/getDefinitions/sriov-vf"
42085 description: Response codes found in [response codes](https://wiki.onap.org/).
42089 description: unique name of Physical Network Function.
42092 example: __PNF-NAME__
42093 - name: interface-name
42095 description: Name that identifies the physical interface
42098 example: __INTERFACE-NAME__
42099 - name: interface-name
42101 description: Name given to the interface
42104 example: __INTERFACE-NAME__
42107 description: PCI ID used to identify the sriov-vf
42110 example: __PCI-ID__
42113 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
42116 - name: prov-status
42118 description: Trigger for operational monitoring of this resource by Service Assurance systems.
42121 - name: interface-id
42123 description: ID of interface
42128 description: MAC address for the interface
42131 - name: network-name
42133 description: Name of the network
42136 - name: vf-vlan-filter
42138 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
42141 - name: vf-mac-filter
42143 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
42146 - name: vf-vlan-strip
42148 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
42151 - name: neutron-network-id
42153 description: Neutron network id of the interface
42159 summary: create or update an existing sriov-vf
42161 Create or update an existing sriov-vf.
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: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
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 physical interface
42186 example: __INTERFACE-NAME__
42187 - name: interface-name
42189 description: Name given to the interface
42192 example: __INTERFACE-NAME__
42195 description: PCI ID used to identify the sriov-vf
42198 example: __PCI-ID__
42201 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
42204 $ref: "#/definitions/sriov-vf"
42208 summary: update an existing sriov-vf
42210 Update an existing sriov-vf
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: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
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 physical interface
42243 example: __INTERFACE-NAME__
42244 - name: interface-name
42246 description: Name given to the interface
42249 example: __INTERFACE-NAME__
42252 description: PCI ID used to identify the sriov-vf
42255 example: __PCI-ID__
42258 description: sriov-vf object that needs to be created or updated.
42261 $ref: "#/patchDefinitions/sriov-vf"
42265 summary: delete an existing sriov-vf
42266 description: delete an existing sriov-vf
42267 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
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 physical interface
42289 example: __INTERFACE-NAME__
42290 - name: interface-name
42292 description: Name given to the interface
42295 example: __INTERFACE-NAME__
42298 description: PCI ID used to identify the sriov-vf
42301 example: __PCI-ID__
42302 - name: resource-version
42304 description: resource-version for concurrency
42307 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
42311 summary: returns sriov-vfs
42312 description: returns sriov-vfs
42313 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
42319 description: successful operation
42321 $ref: "#/getDefinitions/sriov-vfs"
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 physical interface
42336 example: __INTERFACE-NAME__
42337 - name: interface-name
42339 description: Name given to the interface
42342 example: __INTERFACE-NAME__
42345 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
42348 - name: prov-status
42350 description: Trigger for operational monitoring of this resource by Service Assurance systems.
42353 - name: interface-id
42355 description: ID of interface
42360 description: MAC address for the interface
42363 - name: network-name
42365 description: Name of the network
42368 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
42372 summary: see node definition for valid relationships
42373 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
42382 description: Response codes found in [response codes](https://wiki.onap.org/).
42386 description: unique name of Physical Network Function.
42389 example: __PNF-NAME__
42390 - name: interface-name
42392 description: Name that identifies the physical interface
42395 example: __INTERFACE-NAME__
42396 - name: interface-name
42398 description: Name given to the interface
42401 example: __INTERFACE-NAME__
42404 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
42407 $ref: "#/definitions/relationship"
42411 summary: delete an existing relationship
42412 description: delete an existing relationship
42413 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
42422 description: Response codes found in [response codes](https://wiki.onap.org/).
42426 description: unique name of Physical Network Function.
42429 example: __PNF-NAME__
42430 - name: interface-name
42432 description: Name that identifies the physical interface
42435 example: __INTERFACE-NAME__
42436 - name: interface-name
42438 description: Name given to the interface
42441 example: __INTERFACE-NAME__
42442 /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:
42446 summary: see node definition for valid relationships
42447 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
42456 description: Response codes found in [response codes](https://wiki.onap.org/).
42460 description: unique name of Physical Network Function.
42463 example: __PNF-NAME__
42464 - name: interface-name
42466 description: Name that identifies the physical interface
42469 example: __INTERFACE-NAME__
42470 - name: interface-name
42472 description: Name given to the interface
42475 example: __INTERFACE-NAME__
42476 - name: l3-interface-ipv4-address
42478 description: IP address
42481 example: __L3-INTERFACE-IPV4-ADDRESS__
42484 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
42487 $ref: "#/definitions/relationship"
42491 summary: delete an existing relationship
42492 description: delete an existing relationship
42493 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
42502 description: Response codes found in [response codes](https://wiki.onap.org/).
42506 description: unique name of Physical Network Function.
42509 example: __PNF-NAME__
42510 - name: interface-name
42512 description: Name that identifies the physical interface
42515 example: __INTERFACE-NAME__
42516 - name: interface-name
42518 description: Name given to the interface
42521 example: __INTERFACE-NAME__
42522 - name: l3-interface-ipv4-address
42524 description: IP address
42527 example: __L3-INTERFACE-IPV4-ADDRESS__
42528 /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}:
42532 summary: returns l3-interface-ipv4-address-list
42533 description: returns l3-interface-ipv4-address-list
42534 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
42540 description: successful operation
42542 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
42544 description: Response codes found in [response codes](https://wiki.onap.org/).
42548 description: unique name of Physical Network Function.
42551 example: __PNF-NAME__
42552 - name: interface-name
42554 description: Name that identifies the physical interface
42557 example: __INTERFACE-NAME__
42558 - name: interface-name
42560 description: Name given to the interface
42563 example: __INTERFACE-NAME__
42564 - name: l3-interface-ipv4-address
42566 description: IP address
42569 example: __L3-INTERFACE-IPV4-ADDRESS__
42572 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
42575 - name: prov-status
42577 description: Trigger for operational monitoring of this resource by Service Assurance systems.
42580 - name: interface-id
42582 description: ID of interface
42587 description: MAC address for the interface
42590 - name: network-name
42592 description: Name of the network
42595 - name: vlan-id-inner
42597 description: Inner VLAN tag
42601 - name: neutron-network-id
42603 description: Neutron network id of the interface that address belongs to
42606 - name: neutron-subnet-id
42608 description: Neutron id of subnet that address belongs to
42614 summary: create or update an existing l3-interface-ipv4-address-list
42616 Create or update an existing l3-interface-ipv4-address-list.
42618 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
42619 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
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 physical interface
42641 example: __INTERFACE-NAME__
42642 - name: interface-name
42644 description: Name given to the interface
42647 example: __INTERFACE-NAME__
42648 - name: l3-interface-ipv4-address
42650 description: IP address
42653 example: __L3-INTERFACE-IPV4-ADDRESS__
42656 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
42659 $ref: "#/definitions/l3-interface-ipv4-address-list"
42663 summary: update an existing l3-interface-ipv4-address-list
42665 Update an existing l3-interface-ipv4-address-list
42667 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42668 The PUT operation will entirely replace an existing object.
42669 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
42671 Other differences between PUT and PATCH are:
42673 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
42674 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42675 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42676 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
42685 description: Response codes found in [response codes](https://wiki.onap.org/).
42689 description: unique name of Physical Network Function.
42692 example: __PNF-NAME__
42693 - name: interface-name
42695 description: Name that identifies the physical interface
42698 example: __INTERFACE-NAME__
42699 - name: interface-name
42701 description: Name given to the interface
42704 example: __INTERFACE-NAME__
42705 - name: l3-interface-ipv4-address
42707 description: IP address
42710 example: __L3-INTERFACE-IPV4-ADDRESS__
42713 description: l3-interface-ipv4-address-list object that needs to be created or updated.
42716 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
42720 summary: delete an existing l3-interface-ipv4-address-list
42721 description: delete an existing l3-interface-ipv4-address-list
42722 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
42731 description: Response codes found in [response codes](https://wiki.onap.org/).
42735 description: unique name of Physical Network Function.
42738 example: __PNF-NAME__
42739 - name: interface-name
42741 description: Name that identifies the physical interface
42744 example: __INTERFACE-NAME__
42745 - name: interface-name
42747 description: Name given to the interface
42750 example: __INTERFACE-NAME__
42751 - name: l3-interface-ipv4-address
42753 description: IP address
42756 example: __L3-INTERFACE-IPV4-ADDRESS__
42757 - name: resource-version
42759 description: resource-version for concurrency
42762 /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:
42766 summary: see node definition for valid relationships
42767 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
42776 description: Response codes found in [response codes](https://wiki.onap.org/).
42780 description: unique name of Physical Network Function.
42783 example: __PNF-NAME__
42784 - name: interface-name
42786 description: Name that identifies the physical interface
42789 example: __INTERFACE-NAME__
42790 - name: interface-name
42792 description: Name given to the interface
42795 example: __INTERFACE-NAME__
42796 - name: l3-interface-ipv6-address
42798 description: IP address
42801 example: __L3-INTERFACE-IPV6-ADDRESS__
42804 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
42807 $ref: "#/definitions/relationship"
42811 summary: delete an existing relationship
42812 description: delete an existing relationship
42813 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
42822 description: Response codes found in [response codes](https://wiki.onap.org/).
42826 description: unique name of Physical Network Function.
42829 example: __PNF-NAME__
42830 - name: interface-name
42832 description: Name that identifies the physical interface
42835 example: __INTERFACE-NAME__
42836 - name: interface-name
42838 description: Name given to the interface
42841 example: __INTERFACE-NAME__
42842 - name: l3-interface-ipv6-address
42844 description: IP address
42847 example: __L3-INTERFACE-IPV6-ADDRESS__
42848 /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}:
42852 summary: returns l3-interface-ipv6-address-list
42853 description: returns l3-interface-ipv6-address-list
42854 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
42860 description: successful operation
42862 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
42864 description: Response codes found in [response codes](https://wiki.onap.org/).
42868 description: unique name of Physical Network Function.
42871 example: __PNF-NAME__
42872 - name: interface-name
42874 description: Name that identifies the physical interface
42877 example: __INTERFACE-NAME__
42878 - name: interface-name
42880 description: Name given to the interface
42883 example: __INTERFACE-NAME__
42884 - name: l3-interface-ipv6-address
42886 description: IP address
42889 example: __L3-INTERFACE-IPV6-ADDRESS__
42892 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
42895 - name: prov-status
42897 description: Trigger for operational monitoring of this resource by Service Assurance systems.
42900 - name: interface-id
42902 description: ID of interface
42907 description: MAC address for the interface
42910 - name: network-name
42912 description: Name of the network
42915 - name: vlan-id-inner
42917 description: Inner VLAN tag
42921 - name: neutron-network-id
42923 description: Neutron network id of the interface that address belongs to
42926 - name: neutron-subnet-id
42928 description: Neutron id of subnet that address belongs to
42934 summary: create or update an existing l3-interface-ipv6-address-list
42936 Create or update an existing l3-interface-ipv6-address-list.
42938 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
42939 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
42948 description: Response codes found in [response codes](https://wiki.onap.org/).
42952 description: unique name of Physical Network Function.
42955 example: __PNF-NAME__
42956 - name: interface-name
42958 description: Name that identifies the physical interface
42961 example: __INTERFACE-NAME__
42962 - name: interface-name
42964 description: Name given to the interface
42967 example: __INTERFACE-NAME__
42968 - name: l3-interface-ipv6-address
42970 description: IP address
42973 example: __L3-INTERFACE-IPV6-ADDRESS__
42976 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
42979 $ref: "#/definitions/l3-interface-ipv6-address-list"
42983 summary: update an existing l3-interface-ipv6-address-list
42985 Update an existing l3-interface-ipv6-address-list
42987 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42988 The PUT operation will entirely replace an existing object.
42989 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
42991 Other differences between PUT and PATCH are:
42993 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
42994 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42995 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42996 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
43005 description: Response codes found in [response codes](https://wiki.onap.org/).
43009 description: unique name of Physical Network Function.
43012 example: __PNF-NAME__
43013 - name: interface-name
43015 description: Name that identifies the physical interface
43018 example: __INTERFACE-NAME__
43019 - name: interface-name
43021 description: Name given to the interface
43024 example: __INTERFACE-NAME__
43025 - name: l3-interface-ipv6-address
43027 description: IP address
43030 example: __L3-INTERFACE-IPV6-ADDRESS__
43033 description: l3-interface-ipv6-address-list object that needs to be created or updated.
43036 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
43040 summary: delete an existing l3-interface-ipv6-address-list
43041 description: delete an existing l3-interface-ipv6-address-list
43042 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
43051 description: Response codes found in [response codes](https://wiki.onap.org/).
43055 description: unique name of Physical Network Function.
43058 example: __PNF-NAME__
43059 - name: interface-name
43061 description: Name that identifies the physical interface
43064 example: __INTERFACE-NAME__
43065 - name: interface-name
43067 description: Name given to the interface
43070 example: __INTERFACE-NAME__
43071 - name: l3-interface-ipv6-address
43073 description: IP address
43076 example: __L3-INTERFACE-IPV6-ADDRESS__
43077 - name: resource-version
43079 description: resource-version for concurrency
43082 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
43086 summary: returns l-interface
43087 description: returns l-interface
43088 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
43094 description: successful operation
43096 $ref: "#/getDefinitions/l-interface"
43098 description: Response codes found in [response codes](https://wiki.onap.org/).
43102 description: unique name of Physical Network Function.
43105 example: __PNF-NAME__
43106 - name: interface-name
43108 description: Name that identifies the physical interface
43111 example: __INTERFACE-NAME__
43112 - name: interface-name
43114 description: Name given to the interface
43117 example: __INTERFACE-NAME__
43120 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
43123 - name: prov-status
43125 description: Trigger for operational monitoring of this resource by Service Assurance systems.
43128 - name: interface-id
43130 description: ID of interface
43135 description: MAC address for the interface
43138 - name: network-name
43140 description: Name of the network
43146 summary: create or update an existing l-interface
43148 Create or update an existing l-interface.
43150 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
43151 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
43160 description: Response codes found in [response codes](https://wiki.onap.org/).
43164 description: unique name of Physical Network Function.
43167 example: __PNF-NAME__
43168 - name: interface-name
43170 description: Name that identifies the physical interface
43173 example: __INTERFACE-NAME__
43174 - name: interface-name
43176 description: Name given to the interface
43179 example: __INTERFACE-NAME__
43182 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
43185 $ref: "#/definitions/l-interface"
43189 summary: update an existing l-interface
43191 Update an existing l-interface
43193 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43194 The PUT operation will entirely replace an existing object.
43195 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
43197 Other differences between PUT and PATCH are:
43199 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
43200 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43201 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43202 operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
43211 description: Response codes found in [response codes](https://wiki.onap.org/).
43215 description: unique name of Physical Network Function.
43218 example: __PNF-NAME__
43219 - name: interface-name
43221 description: Name that identifies the physical interface
43224 example: __INTERFACE-NAME__
43225 - name: interface-name
43227 description: Name given to the interface
43230 example: __INTERFACE-NAME__
43233 description: l-interface object that needs to be created or updated.
43236 $ref: "#/patchDefinitions/l-interface"
43240 summary: delete an existing l-interface
43241 description: delete an existing l-interface
43242 operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
43251 description: Response codes found in [response codes](https://wiki.onap.org/).
43255 description: unique name of Physical Network Function.
43258 example: __PNF-NAME__
43259 - name: interface-name
43261 description: Name that identifies the physical interface
43264 example: __INTERFACE-NAME__
43265 - name: interface-name
43267 description: Name given to the interface
43270 example: __INTERFACE-NAME__
43271 - name: resource-version
43273 description: resource-version for concurrency
43276 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
43280 summary: returns l-interfaces
43281 description: returns l-interfaces
43282 operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces
43288 description: successful operation
43290 $ref: "#/getDefinitions/l-interfaces"
43292 description: Response codes found in [response codes](https://wiki.onap.org/).
43296 description: unique name of Physical Network Function.
43299 example: __PNF-NAME__
43300 - name: interface-name
43302 description: Name that identifies the physical interface
43305 example: __INTERFACE-NAME__
43308 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
43311 - name: prov-status
43313 description: Trigger for operational monitoring of this resource by Service Assurance systems.
43316 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}:
43320 summary: returns p-interface
43321 description: returns p-interface
43322 operationId: getNetworkPnfsPnfPInterfacesPInterface
43328 description: successful operation
43330 $ref: "#/getDefinitions/p-interface"
43332 description: Response codes found in [response codes](https://wiki.onap.org/).
43336 description: unique name of Physical Network Function.
43339 example: __PNF-NAME__
43340 - name: interface-name
43342 description: Name that identifies the physical interface
43345 example: __INTERFACE-NAME__
43348 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
43351 - name: prov-status
43353 description: Trigger for operational monitoring of this resource by Service Assurance systems.
43359 summary: create or update an existing p-interface
43361 Create or update an existing p-interface.
43363 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
43364 operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterface
43373 description: Response codes found in [response codes](https://wiki.onap.org/).
43377 description: unique name of Physical Network Function.
43380 example: __PNF-NAME__
43381 - name: interface-name
43383 description: Name that identifies the physical interface
43386 example: __INTERFACE-NAME__
43389 description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfPInterfacesPInterface.json)
43392 $ref: "#/definitions/p-interface"
43396 summary: update an existing p-interface
43398 Update an existing p-interface
43400 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43401 The PUT operation will entirely replace an existing object.
43402 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
43404 Other differences between PUT and PATCH are:
43406 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
43407 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43408 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43409 operationId: UpdateNetworkPnfsPnfPInterfacesPInterface
43418 description: Response codes found in [response codes](https://wiki.onap.org/).
43422 description: unique name of Physical Network Function.
43425 example: __PNF-NAME__
43426 - name: interface-name
43428 description: Name that identifies the physical interface
43431 example: __INTERFACE-NAME__
43434 description: p-interface object that needs to be created or updated.
43437 $ref: "#/patchDefinitions/p-interface"
43441 summary: delete an existing p-interface
43442 description: delete an existing p-interface
43443 operationId: deleteNetworkPnfsPnfPInterfacesPInterface
43452 description: Response codes found in [response codes](https://wiki.onap.org/).
43456 description: unique name of Physical Network Function.
43459 example: __PNF-NAME__
43460 - name: interface-name
43462 description: Name that identifies the physical interface
43465 example: __INTERFACE-NAME__
43466 - name: resource-version
43468 description: resource-version for concurrency
43471 /network/pnfs/pnf/{pnf-name}/p-interfaces:
43475 summary: returns p-interfaces
43476 description: returns p-interfaces
43477 operationId: getNetworkPnfsPnfPInterfaces
43483 description: successful operation
43485 $ref: "#/getDefinitions/p-interfaces"
43487 description: Response codes found in [response codes](https://wiki.onap.org/).
43491 description: unique name of Physical Network Function.
43494 example: __PNF-NAME__
43497 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
43500 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
43504 summary: see node definition for valid relationships
43505 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
43514 description: Response codes found in [response codes](https://wiki.onap.org/).
43518 description: unique name of Physical Network Function.
43521 example: __PNF-NAME__
43522 - name: interface-name
43524 description: Name that identifies the link aggregate interface
43527 example: __INTERFACE-NAME__
43530 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterface.json)
43533 $ref: "#/definitions/relationship"
43537 summary: delete an existing relationship
43538 description: delete an existing relationship
43539 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
43548 description: Response codes found in [response codes](https://wiki.onap.org/).
43552 description: unique name of Physical Network Function.
43555 example: __PNF-NAME__
43556 - name: interface-name
43558 description: Name that identifies the link aggregate interface
43561 example: __INTERFACE-NAME__
43562 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
43566 summary: see node definition for valid relationships
43567 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
43576 description: Response codes found in [response codes](https://wiki.onap.org/).
43580 description: unique name of Physical Network Function.
43583 example: __PNF-NAME__
43584 - name: interface-name
43586 description: Name that identifies the link aggregate interface
43589 example: __INTERFACE-NAME__
43590 - name: interface-name
43592 description: Name given to the interface
43595 example: __INTERFACE-NAME__
43596 - name: vlan-interface
43598 description: String that identifies the interface
43601 example: __VLAN-INTERFACE__
43604 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
43607 $ref: "#/definitions/relationship"
43611 summary: delete an existing relationship
43612 description: delete an existing relationship
43613 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
43622 description: Response codes found in [response codes](https://wiki.onap.org/).
43626 description: unique name of Physical Network Function.
43629 example: __PNF-NAME__
43630 - name: interface-name
43632 description: Name that identifies the link aggregate interface
43635 example: __INTERFACE-NAME__
43636 - name: interface-name
43638 description: Name given to the interface
43641 example: __INTERFACE-NAME__
43642 - name: vlan-interface
43644 description: String that identifies the interface
43647 example: __VLAN-INTERFACE__
43648 /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:
43652 summary: see node definition for valid relationships
43653 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
43662 description: Response codes found in [response codes](https://wiki.onap.org/).
43666 description: unique name of Physical Network Function.
43669 example: __PNF-NAME__
43670 - name: interface-name
43672 description: Name that identifies the link aggregate interface
43675 example: __INTERFACE-NAME__
43676 - name: interface-name
43678 description: Name given to the interface
43681 example: __INTERFACE-NAME__
43682 - name: vlan-interface
43684 description: String that identifies the interface
43687 example: __VLAN-INTERFACE__
43688 - name: l3-interface-ipv4-address
43690 description: IP address
43693 example: __L3-INTERFACE-IPV4-ADDRESS__
43696 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
43699 $ref: "#/definitions/relationship"
43703 summary: delete an existing relationship
43704 description: delete an existing relationship
43705 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
43714 description: Response codes found in [response codes](https://wiki.onap.org/).
43718 description: unique name of Physical Network Function.
43721 example: __PNF-NAME__
43722 - name: interface-name
43724 description: Name that identifies the link aggregate interface
43727 example: __INTERFACE-NAME__
43728 - name: interface-name
43730 description: Name given to the interface
43733 example: __INTERFACE-NAME__
43734 - name: vlan-interface
43736 description: String that identifies the interface
43739 example: __VLAN-INTERFACE__
43740 - name: l3-interface-ipv4-address
43742 description: IP address
43745 example: __L3-INTERFACE-IPV4-ADDRESS__
43746 /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}:
43750 summary: returns l3-interface-ipv4-address-list
43751 description: returns l3-interface-ipv4-address-list
43752 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
43758 description: successful operation
43760 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
43762 description: Response codes found in [response codes](https://wiki.onap.org/).
43766 description: unique name of Physical Network Function.
43769 example: __PNF-NAME__
43770 - name: interface-name
43772 description: Name that identifies the link aggregate interface
43775 example: __INTERFACE-NAME__
43776 - name: interface-name
43778 description: Name given to the interface
43781 example: __INTERFACE-NAME__
43782 - name: vlan-interface
43784 description: String that identifies the interface
43787 example: __VLAN-INTERFACE__
43788 - name: l3-interface-ipv4-address
43790 description: IP address
43793 example: __L3-INTERFACE-IPV4-ADDRESS__
43796 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
43799 - name: interface-id
43801 description: ID of interface
43804 - name: interface-role
43806 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
43809 - name: interface-id
43811 description: ID of interface
43816 description: MAC address for the interface
43819 - name: network-name
43821 description: Name of the network
43824 - name: vlan-id-inner
43826 description: Inner VLAN tag
43832 description: This indicates the customers VPN ID associated with this vlan
43835 - name: vlan-id-inner
43837 description: Inner VLAN tag
43841 - name: neutron-network-id
43843 description: Neutron network id of the interface that address belongs to
43846 - name: neutron-subnet-id
43848 description: Neutron id of subnet that address belongs to
43854 summary: create or update an existing l3-interface-ipv4-address-list
43856 Create or update an existing l3-interface-ipv4-address-list.
43858 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
43859 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
43868 description: Response codes found in [response codes](https://wiki.onap.org/).
43872 description: unique name of Physical Network Function.
43875 example: __PNF-NAME__
43876 - name: interface-name
43878 description: Name that identifies the link aggregate interface
43881 example: __INTERFACE-NAME__
43882 - name: interface-name
43884 description: Name given to the interface
43887 example: __INTERFACE-NAME__
43888 - name: vlan-interface
43890 description: String that identifies the interface
43893 example: __VLAN-INTERFACE__
43894 - name: l3-interface-ipv4-address
43896 description: IP address
43899 example: __L3-INTERFACE-IPV4-ADDRESS__
43902 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
43905 $ref: "#/definitions/l3-interface-ipv4-address-list"
43909 summary: update an existing l3-interface-ipv4-address-list
43911 Update an existing l3-interface-ipv4-address-list
43913 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43914 The PUT operation will entirely replace an existing object.
43915 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
43917 Other differences between PUT and PATCH are:
43919 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
43920 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43921 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43922 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
43931 description: Response codes found in [response codes](https://wiki.onap.org/).
43935 description: unique name of Physical Network Function.
43938 example: __PNF-NAME__
43939 - name: interface-name
43941 description: Name that identifies the link aggregate interface
43944 example: __INTERFACE-NAME__
43945 - name: interface-name
43947 description: Name given to the interface
43950 example: __INTERFACE-NAME__
43951 - name: vlan-interface
43953 description: String that identifies the interface
43956 example: __VLAN-INTERFACE__
43957 - name: l3-interface-ipv4-address
43959 description: IP address
43962 example: __L3-INTERFACE-IPV4-ADDRESS__
43965 description: l3-interface-ipv4-address-list object that needs to be created or updated.
43968 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
43972 summary: delete an existing l3-interface-ipv4-address-list
43973 description: delete an existing l3-interface-ipv4-address-list
43974 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
43983 description: Response codes found in [response codes](https://wiki.onap.org/).
43987 description: unique name of Physical Network Function.
43990 example: __PNF-NAME__
43991 - name: interface-name
43993 description: Name that identifies the link aggregate interface
43996 example: __INTERFACE-NAME__
43997 - name: interface-name
43999 description: Name given to the interface
44002 example: __INTERFACE-NAME__
44003 - name: vlan-interface
44005 description: String that identifies the interface
44008 example: __VLAN-INTERFACE__
44009 - name: l3-interface-ipv4-address
44011 description: IP address
44014 example: __L3-INTERFACE-IPV4-ADDRESS__
44015 - name: resource-version
44017 description: resource-version for concurrency
44020 /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:
44024 summary: see node definition for valid relationships
44025 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
44034 description: Response codes found in [response codes](https://wiki.onap.org/).
44038 description: unique name of Physical Network Function.
44041 example: __PNF-NAME__
44042 - name: interface-name
44044 description: Name that identifies the link aggregate interface
44047 example: __INTERFACE-NAME__
44048 - name: interface-name
44050 description: Name given to the interface
44053 example: __INTERFACE-NAME__
44054 - name: vlan-interface
44056 description: String that identifies the interface
44059 example: __VLAN-INTERFACE__
44060 - name: l3-interface-ipv6-address
44062 description: IP address
44065 example: __L3-INTERFACE-IPV6-ADDRESS__
44068 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
44071 $ref: "#/definitions/relationship"
44075 summary: delete an existing relationship
44076 description: delete an existing relationship
44077 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
44086 description: Response codes found in [response codes](https://wiki.onap.org/).
44090 description: unique name of Physical Network Function.
44093 example: __PNF-NAME__
44094 - name: interface-name
44096 description: Name that identifies the link aggregate interface
44099 example: __INTERFACE-NAME__
44100 - name: interface-name
44102 description: Name given to the interface
44105 example: __INTERFACE-NAME__
44106 - name: vlan-interface
44108 description: String that identifies the interface
44111 example: __VLAN-INTERFACE__
44112 - name: l3-interface-ipv6-address
44114 description: IP address
44117 example: __L3-INTERFACE-IPV6-ADDRESS__
44118 /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}:
44122 summary: returns l3-interface-ipv6-address-list
44123 description: returns l3-interface-ipv6-address-list
44124 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
44130 description: successful operation
44132 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
44134 description: Response codes found in [response codes](https://wiki.onap.org/).
44138 description: unique name of Physical Network Function.
44141 example: __PNF-NAME__
44142 - name: interface-name
44144 description: Name that identifies the link aggregate interface
44147 example: __INTERFACE-NAME__
44148 - name: interface-name
44150 description: Name given to the interface
44153 example: __INTERFACE-NAME__
44154 - name: vlan-interface
44156 description: String that identifies the interface
44159 example: __VLAN-INTERFACE__
44160 - name: l3-interface-ipv6-address
44162 description: IP address
44165 example: __L3-INTERFACE-IPV6-ADDRESS__
44168 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
44171 - name: interface-id
44173 description: ID of interface
44176 - name: interface-role
44178 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
44181 - name: interface-id
44183 description: ID of interface
44188 description: MAC address for the interface
44191 - name: network-name
44193 description: Name of the network
44196 - name: vlan-id-inner
44198 description: Inner VLAN tag
44204 description: This indicates the customers VPN ID associated with this vlan
44207 - name: vlan-id-inner
44209 description: Inner VLAN tag
44213 - name: neutron-network-id
44215 description: Neutron network id of the interface that address belongs to
44218 - name: neutron-subnet-id
44220 description: Neutron id of subnet that address belongs to
44226 summary: create or update an existing l3-interface-ipv6-address-list
44228 Create or update an existing l3-interface-ipv6-address-list.
44230 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
44231 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
44240 description: Response codes found in [response codes](https://wiki.onap.org/).
44244 description: unique name of Physical Network Function.
44247 example: __PNF-NAME__
44248 - name: interface-name
44250 description: Name that identifies the link aggregate interface
44253 example: __INTERFACE-NAME__
44254 - name: interface-name
44256 description: Name given to the interface
44259 example: __INTERFACE-NAME__
44260 - name: vlan-interface
44262 description: String that identifies the interface
44265 example: __VLAN-INTERFACE__
44266 - name: l3-interface-ipv6-address
44268 description: IP address
44271 example: __L3-INTERFACE-IPV6-ADDRESS__
44274 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
44277 $ref: "#/definitions/l3-interface-ipv6-address-list"
44281 summary: update an existing l3-interface-ipv6-address-list
44283 Update an existing l3-interface-ipv6-address-list
44285 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44286 The PUT operation will entirely replace an existing object.
44287 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
44289 Other differences between PUT and PATCH are:
44291 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
44292 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44293 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44294 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
44303 description: Response codes found in [response codes](https://wiki.onap.org/).
44307 description: unique name of Physical Network Function.
44310 example: __PNF-NAME__
44311 - name: interface-name
44313 description: Name that identifies the link aggregate interface
44316 example: __INTERFACE-NAME__
44317 - name: interface-name
44319 description: Name given to the interface
44322 example: __INTERFACE-NAME__
44323 - name: vlan-interface
44325 description: String that identifies the interface
44328 example: __VLAN-INTERFACE__
44329 - name: l3-interface-ipv6-address
44331 description: IP address
44334 example: __L3-INTERFACE-IPV6-ADDRESS__
44337 description: l3-interface-ipv6-address-list object that needs to be created or updated.
44340 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
44344 summary: delete an existing l3-interface-ipv6-address-list
44345 description: delete an existing l3-interface-ipv6-address-list
44346 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
44355 description: Response codes found in [response codes](https://wiki.onap.org/).
44359 description: unique name of Physical Network Function.
44362 example: __PNF-NAME__
44363 - name: interface-name
44365 description: Name that identifies the link aggregate interface
44368 example: __INTERFACE-NAME__
44369 - name: interface-name
44371 description: Name given to the interface
44374 example: __INTERFACE-NAME__
44375 - name: vlan-interface
44377 description: String that identifies the interface
44380 example: __VLAN-INTERFACE__
44381 - name: l3-interface-ipv6-address
44383 description: IP address
44386 example: __L3-INTERFACE-IPV6-ADDRESS__
44387 - name: resource-version
44389 description: resource-version for concurrency
44392 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
44396 summary: returns vlan
44397 description: returns vlan
44398 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
44404 description: successful operation
44406 $ref: "#/getDefinitions/vlan"
44408 description: Response codes found in [response codes](https://wiki.onap.org/).
44412 description: unique name of Physical Network Function.
44415 example: __PNF-NAME__
44416 - name: interface-name
44418 description: Name that identifies the link aggregate interface
44421 example: __INTERFACE-NAME__
44422 - name: interface-name
44424 description: Name given to the interface
44427 example: __INTERFACE-NAME__
44428 - name: vlan-interface
44430 description: String that identifies the interface
44433 example: __VLAN-INTERFACE__
44436 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
44439 - name: interface-id
44441 description: ID of interface
44444 - name: interface-role
44446 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
44449 - name: interface-id
44451 description: ID of interface
44456 description: MAC address for the interface
44459 - name: network-name
44461 description: Name of the network
44464 - name: vlan-id-inner
44466 description: Inner VLAN tag
44472 description: This indicates the customers VPN ID associated with this vlan
44478 summary: create or update an existing vlan
44480 Create or update an existing vlan.
44482 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
44483 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
44492 description: Response codes found in [response codes](https://wiki.onap.org/).
44496 description: unique name of Physical Network Function.
44499 example: __PNF-NAME__
44500 - name: interface-name
44502 description: Name that identifies the link aggregate interface
44505 example: __INTERFACE-NAME__
44506 - name: interface-name
44508 description: Name given to the interface
44511 example: __INTERFACE-NAME__
44512 - name: vlan-interface
44514 description: String that identifies the interface
44517 example: __VLAN-INTERFACE__
44520 description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
44523 $ref: "#/definitions/vlan"
44527 summary: update an existing vlan
44529 Update an existing vlan
44531 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44532 The PUT operation will entirely replace an existing object.
44533 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
44535 Other differences between PUT and PATCH are:
44537 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
44538 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44539 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44540 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
44549 description: Response codes found in [response codes](https://wiki.onap.org/).
44553 description: unique name of Physical Network Function.
44556 example: __PNF-NAME__
44557 - name: interface-name
44559 description: Name that identifies the link aggregate interface
44562 example: __INTERFACE-NAME__
44563 - name: interface-name
44565 description: Name given to the interface
44568 example: __INTERFACE-NAME__
44569 - name: vlan-interface
44571 description: String that identifies the interface
44574 example: __VLAN-INTERFACE__
44577 description: vlan object that needs to be created or updated.
44580 $ref: "#/patchDefinitions/vlan"
44584 summary: delete an existing vlan
44585 description: delete an existing vlan
44586 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
44595 description: Response codes found in [response codes](https://wiki.onap.org/).
44599 description: unique name of Physical Network Function.
44602 example: __PNF-NAME__
44603 - name: interface-name
44605 description: Name that identifies the link aggregate interface
44608 example: __INTERFACE-NAME__
44609 - name: interface-name
44611 description: Name given to the interface
44614 example: __INTERFACE-NAME__
44615 - name: vlan-interface
44617 description: String that identifies the interface
44620 example: __VLAN-INTERFACE__
44621 - name: resource-version
44623 description: resource-version for concurrency
44626 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
44630 summary: returns vlans
44631 description: returns vlans
44632 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
44638 description: successful operation
44640 $ref: "#/getDefinitions/vlans"
44642 description: Response codes found in [response codes](https://wiki.onap.org/).
44646 description: unique name of Physical Network Function.
44649 example: __PNF-NAME__
44650 - name: interface-name
44652 description: Name that identifies the link aggregate interface
44655 example: __INTERFACE-NAME__
44656 - name: interface-name
44658 description: Name given to the interface
44661 example: __INTERFACE-NAME__
44664 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
44667 - name: interface-id
44669 description: ID of interface
44672 - name: interface-role
44674 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
44677 - name: interface-id
44679 description: ID of interface
44684 description: MAC address for the interface
44687 - name: network-name
44689 description: Name of the network
44692 /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:
44696 summary: see node definition for valid relationships
44697 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
44706 description: Response codes found in [response codes](https://wiki.onap.org/).
44710 description: unique name of Physical Network Function.
44713 example: __PNF-NAME__
44714 - name: interface-name
44716 description: Name that identifies the link aggregate interface
44719 example: __INTERFACE-NAME__
44720 - name: interface-name
44722 description: Name given to the interface
44725 example: __INTERFACE-NAME__
44728 description: PCI ID used to identify the sriov-vf
44731 example: __PCI-ID__
44734 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
44737 $ref: "#/definitions/relationship"
44741 summary: delete an existing relationship
44742 description: delete an existing relationship
44743 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
44752 description: Response codes found in [response codes](https://wiki.onap.org/).
44756 description: unique name of Physical Network Function.
44759 example: __PNF-NAME__
44760 - name: interface-name
44762 description: Name that identifies the link aggregate interface
44765 example: __INTERFACE-NAME__
44766 - name: interface-name
44768 description: Name given to the interface
44771 example: __INTERFACE-NAME__
44774 description: PCI ID used to identify the sriov-vf
44777 example: __PCI-ID__
44778 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
44782 summary: returns sriov-vf
44783 description: returns sriov-vf
44784 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
44790 description: successful operation
44792 $ref: "#/getDefinitions/sriov-vf"
44794 description: Response codes found in [response codes](https://wiki.onap.org/).
44798 description: unique name of Physical Network Function.
44801 example: __PNF-NAME__
44802 - name: interface-name
44804 description: Name that identifies the link aggregate interface
44807 example: __INTERFACE-NAME__
44808 - name: interface-name
44810 description: Name given to the interface
44813 example: __INTERFACE-NAME__
44816 description: PCI ID used to identify the sriov-vf
44819 example: __PCI-ID__
44822 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
44825 - name: interface-id
44827 description: ID of interface
44830 - name: interface-role
44832 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
44835 - name: interface-id
44837 description: ID of interface
44842 description: MAC address for the interface
44845 - name: network-name
44847 description: Name of the network
44850 - name: vf-vlan-filter
44852 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
44855 - name: vf-mac-filter
44857 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
44860 - name: vf-vlan-strip
44862 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
44865 - name: neutron-network-id
44867 description: Neutron network id of the interface
44873 summary: create or update an existing sriov-vf
44875 Create or update an existing sriov-vf.
44877 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
44878 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
44887 description: Response codes found in [response codes](https://wiki.onap.org/).
44891 description: unique name of Physical Network Function.
44894 example: __PNF-NAME__
44895 - name: interface-name
44897 description: Name that identifies the link aggregate interface
44900 example: __INTERFACE-NAME__
44901 - name: interface-name
44903 description: Name given to the interface
44906 example: __INTERFACE-NAME__
44909 description: PCI ID used to identify the sriov-vf
44912 example: __PCI-ID__
44915 description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
44918 $ref: "#/definitions/sriov-vf"
44922 summary: update an existing sriov-vf
44924 Update an existing sriov-vf
44926 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44927 The PUT operation will entirely replace an existing object.
44928 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
44930 Other differences between PUT and PATCH are:
44932 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
44933 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44934 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44935 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
44944 description: Response codes found in [response codes](https://wiki.onap.org/).
44948 description: unique name of Physical Network Function.
44951 example: __PNF-NAME__
44952 - name: interface-name
44954 description: Name that identifies the link aggregate interface
44957 example: __INTERFACE-NAME__
44958 - name: interface-name
44960 description: Name given to the interface
44963 example: __INTERFACE-NAME__
44966 description: PCI ID used to identify the sriov-vf
44969 example: __PCI-ID__
44972 description: sriov-vf object that needs to be created or updated.
44975 $ref: "#/patchDefinitions/sriov-vf"
44979 summary: delete an existing sriov-vf
44980 description: delete an existing sriov-vf
44981 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
44990 description: Response codes found in [response codes](https://wiki.onap.org/).
44994 description: unique name of Physical Network Function.
44997 example: __PNF-NAME__
44998 - name: interface-name
45000 description: Name that identifies the link aggregate interface
45003 example: __INTERFACE-NAME__
45004 - name: interface-name
45006 description: Name given to the interface
45009 example: __INTERFACE-NAME__
45012 description: PCI ID used to identify the sriov-vf
45015 example: __PCI-ID__
45016 - name: resource-version
45018 description: resource-version for concurrency
45021 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
45025 summary: returns sriov-vfs
45026 description: returns sriov-vfs
45027 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
45033 description: successful operation
45035 $ref: "#/getDefinitions/sriov-vfs"
45037 description: Response codes found in [response codes](https://wiki.onap.org/).
45041 description: unique name of Physical Network Function.
45044 example: __PNF-NAME__
45045 - name: interface-name
45047 description: Name that identifies the link aggregate interface
45050 example: __INTERFACE-NAME__
45051 - name: interface-name
45053 description: Name given to the interface
45056 example: __INTERFACE-NAME__
45059 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
45062 - name: interface-id
45064 description: ID of interface
45067 - name: interface-role
45069 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
45072 - name: interface-id
45074 description: ID of interface
45079 description: MAC address for the interface
45082 - name: network-name
45084 description: Name of the network
45087 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
45091 summary: see node definition for valid relationships
45092 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
45101 description: Response codes found in [response codes](https://wiki.onap.org/).
45105 description: unique name of Physical Network Function.
45108 example: __PNF-NAME__
45109 - name: interface-name
45111 description: Name that identifies the link aggregate interface
45114 example: __INTERFACE-NAME__
45115 - name: interface-name
45117 description: Name given to the interface
45120 example: __INTERFACE-NAME__
45123 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
45126 $ref: "#/definitions/relationship"
45130 summary: delete an existing relationship
45131 description: delete an existing relationship
45132 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
45141 description: Response codes found in [response codes](https://wiki.onap.org/).
45145 description: unique name of Physical Network Function.
45148 example: __PNF-NAME__
45149 - name: interface-name
45151 description: Name that identifies the link aggregate interface
45154 example: __INTERFACE-NAME__
45155 - name: interface-name
45157 description: Name given to the interface
45160 example: __INTERFACE-NAME__
45161 /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:
45165 summary: see node definition for valid relationships
45166 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
45175 description: Response codes found in [response codes](https://wiki.onap.org/).
45179 description: unique name of Physical Network Function.
45182 example: __PNF-NAME__
45183 - name: interface-name
45185 description: Name that identifies the link aggregate interface
45188 example: __INTERFACE-NAME__
45189 - name: interface-name
45191 description: Name given to the interface
45194 example: __INTERFACE-NAME__
45195 - name: l3-interface-ipv4-address
45197 description: IP address
45200 example: __L3-INTERFACE-IPV4-ADDRESS__
45203 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
45206 $ref: "#/definitions/relationship"
45210 summary: delete an existing relationship
45211 description: delete an existing relationship
45212 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
45221 description: Response codes found in [response codes](https://wiki.onap.org/).
45225 description: unique name of Physical Network Function.
45228 example: __PNF-NAME__
45229 - name: interface-name
45231 description: Name that identifies the link aggregate interface
45234 example: __INTERFACE-NAME__
45235 - name: interface-name
45237 description: Name given to the interface
45240 example: __INTERFACE-NAME__
45241 - name: l3-interface-ipv4-address
45243 description: IP address
45246 example: __L3-INTERFACE-IPV4-ADDRESS__
45247 /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}:
45251 summary: returns l3-interface-ipv4-address-list
45252 description: returns l3-interface-ipv4-address-list
45253 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
45259 description: successful operation
45261 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
45263 description: Response codes found in [response codes](https://wiki.onap.org/).
45267 description: unique name of Physical Network Function.
45270 example: __PNF-NAME__
45271 - name: interface-name
45273 description: Name that identifies the link aggregate interface
45276 example: __INTERFACE-NAME__
45277 - name: interface-name
45279 description: Name given to the interface
45282 example: __INTERFACE-NAME__
45283 - name: l3-interface-ipv4-address
45285 description: IP address
45288 example: __L3-INTERFACE-IPV4-ADDRESS__
45291 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
45294 - name: interface-id
45296 description: ID of interface
45299 - name: interface-role
45301 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
45304 - name: interface-id
45306 description: ID of interface
45311 description: MAC address for the interface
45314 - name: network-name
45316 description: Name of the network
45319 - name: vlan-id-inner
45321 description: Inner VLAN tag
45325 - name: neutron-network-id
45327 description: Neutron network id of the interface that address belongs to
45330 - name: neutron-subnet-id
45332 description: Neutron id of subnet that address belongs to
45338 summary: create or update an existing l3-interface-ipv4-address-list
45340 Create or update an existing l3-interface-ipv4-address-list.
45342 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
45343 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
45352 description: Response codes found in [response codes](https://wiki.onap.org/).
45356 description: unique name of Physical Network Function.
45359 example: __PNF-NAME__
45360 - name: interface-name
45362 description: Name that identifies the link aggregate interface
45365 example: __INTERFACE-NAME__
45366 - name: interface-name
45368 description: Name given to the interface
45371 example: __INTERFACE-NAME__
45372 - name: l3-interface-ipv4-address
45374 description: IP address
45377 example: __L3-INTERFACE-IPV4-ADDRESS__
45380 description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
45383 $ref: "#/definitions/l3-interface-ipv4-address-list"
45387 summary: update an existing l3-interface-ipv4-address-list
45389 Update an existing l3-interface-ipv4-address-list
45391 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45392 The PUT operation will entirely replace an existing object.
45393 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
45395 Other differences between PUT and PATCH are:
45397 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
45398 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45399 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45400 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
45409 description: Response codes found in [response codes](https://wiki.onap.org/).
45413 description: unique name of Physical Network Function.
45416 example: __PNF-NAME__
45417 - name: interface-name
45419 description: Name that identifies the link aggregate interface
45422 example: __INTERFACE-NAME__
45423 - name: interface-name
45425 description: Name given to the interface
45428 example: __INTERFACE-NAME__
45429 - name: l3-interface-ipv4-address
45431 description: IP address
45434 example: __L3-INTERFACE-IPV4-ADDRESS__
45437 description: l3-interface-ipv4-address-list object that needs to be created or updated.
45440 $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
45444 summary: delete an existing l3-interface-ipv4-address-list
45445 description: delete an existing l3-interface-ipv4-address-list
45446 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
45455 description: Response codes found in [response codes](https://wiki.onap.org/).
45459 description: unique name of Physical Network Function.
45462 example: __PNF-NAME__
45463 - name: interface-name
45465 description: Name that identifies the link aggregate interface
45468 example: __INTERFACE-NAME__
45469 - name: interface-name
45471 description: Name given to the interface
45474 example: __INTERFACE-NAME__
45475 - name: l3-interface-ipv4-address
45477 description: IP address
45480 example: __L3-INTERFACE-IPV4-ADDRESS__
45481 - name: resource-version
45483 description: resource-version for concurrency
45486 /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:
45490 summary: see node definition for valid relationships
45491 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
45500 description: Response codes found in [response codes](https://wiki.onap.org/).
45504 description: unique name of Physical Network Function.
45507 example: __PNF-NAME__
45508 - name: interface-name
45510 description: Name that identifies the link aggregate interface
45513 example: __INTERFACE-NAME__
45514 - name: interface-name
45516 description: Name given to the interface
45519 example: __INTERFACE-NAME__
45520 - name: l3-interface-ipv6-address
45522 description: IP address
45525 example: __L3-INTERFACE-IPV6-ADDRESS__
45528 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
45531 $ref: "#/definitions/relationship"
45535 summary: delete an existing relationship
45536 description: delete an existing relationship
45537 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
45546 description: Response codes found in [response codes](https://wiki.onap.org/).
45550 description: unique name of Physical Network Function.
45553 example: __PNF-NAME__
45554 - name: interface-name
45556 description: Name that identifies the link aggregate interface
45559 example: __INTERFACE-NAME__
45560 - name: interface-name
45562 description: Name given to the interface
45565 example: __INTERFACE-NAME__
45566 - name: l3-interface-ipv6-address
45568 description: IP address
45571 example: __L3-INTERFACE-IPV6-ADDRESS__
45572 /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}:
45576 summary: returns l3-interface-ipv6-address-list
45577 description: returns l3-interface-ipv6-address-list
45578 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
45584 description: successful operation
45586 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
45588 description: Response codes found in [response codes](https://wiki.onap.org/).
45592 description: unique name of Physical Network Function.
45595 example: __PNF-NAME__
45596 - name: interface-name
45598 description: Name that identifies the link aggregate interface
45601 example: __INTERFACE-NAME__
45602 - name: interface-name
45604 description: Name given to the interface
45607 example: __INTERFACE-NAME__
45608 - name: l3-interface-ipv6-address
45610 description: IP address
45613 example: __L3-INTERFACE-IPV6-ADDRESS__
45616 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
45619 - name: interface-id
45621 description: ID of interface
45624 - name: interface-role
45626 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
45629 - name: interface-id
45631 description: ID of interface
45636 description: MAC address for the interface
45639 - name: network-name
45641 description: Name of the network
45644 - name: vlan-id-inner
45646 description: Inner VLAN tag
45650 - name: neutron-network-id
45652 description: Neutron network id of the interface that address belongs to
45655 - name: neutron-subnet-id
45657 description: Neutron id of subnet that address belongs to
45663 summary: create or update an existing l3-interface-ipv6-address-list
45665 Create or update an existing l3-interface-ipv6-address-list.
45667 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
45668 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
45677 description: Response codes found in [response codes](https://wiki.onap.org/).
45681 description: unique name of Physical Network Function.
45684 example: __PNF-NAME__
45685 - name: interface-name
45687 description: Name that identifies the link aggregate interface
45690 example: __INTERFACE-NAME__
45691 - name: interface-name
45693 description: Name given to the interface
45696 example: __INTERFACE-NAME__
45697 - name: l3-interface-ipv6-address
45699 description: IP address
45702 example: __L3-INTERFACE-IPV6-ADDRESS__
45705 description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
45708 $ref: "#/definitions/l3-interface-ipv6-address-list"
45712 summary: update an existing l3-interface-ipv6-address-list
45714 Update an existing l3-interface-ipv6-address-list
45716 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45717 The PUT operation will entirely replace an existing object.
45718 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
45720 Other differences between PUT and PATCH are:
45722 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
45723 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45724 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45725 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
45734 description: Response codes found in [response codes](https://wiki.onap.org/).
45738 description: unique name of Physical Network Function.
45741 example: __PNF-NAME__
45742 - name: interface-name
45744 description: Name that identifies the link aggregate interface
45747 example: __INTERFACE-NAME__
45748 - name: interface-name
45750 description: Name given to the interface
45753 example: __INTERFACE-NAME__
45754 - name: l3-interface-ipv6-address
45756 description: IP address
45759 example: __L3-INTERFACE-IPV6-ADDRESS__
45762 description: l3-interface-ipv6-address-list object that needs to be created or updated.
45765 $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
45769 summary: delete an existing l3-interface-ipv6-address-list
45770 description: delete an existing l3-interface-ipv6-address-list
45771 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
45780 description: Response codes found in [response codes](https://wiki.onap.org/).
45784 description: unique name of Physical Network Function.
45787 example: __PNF-NAME__
45788 - name: interface-name
45790 description: Name that identifies the link aggregate interface
45793 example: __INTERFACE-NAME__
45794 - name: interface-name
45796 description: Name given to the interface
45799 example: __INTERFACE-NAME__
45800 - name: l3-interface-ipv6-address
45802 description: IP address
45805 example: __L3-INTERFACE-IPV6-ADDRESS__
45806 - name: resource-version
45808 description: resource-version for concurrency
45811 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
45815 summary: returns l-interface
45816 description: returns l-interface
45817 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
45823 description: successful operation
45825 $ref: "#/getDefinitions/l-interface"
45827 description: Response codes found in [response codes](https://wiki.onap.org/).
45831 description: unique name of Physical Network Function.
45834 example: __PNF-NAME__
45835 - name: interface-name
45837 description: Name that identifies the link aggregate interface
45840 example: __INTERFACE-NAME__
45841 - name: interface-name
45843 description: Name given to the interface
45846 example: __INTERFACE-NAME__
45849 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
45852 - name: interface-id
45854 description: ID of interface
45857 - name: interface-role
45859 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
45862 - name: interface-id
45864 description: ID of interface
45869 description: MAC address for the interface
45872 - name: network-name
45874 description: Name of the network
45880 summary: create or update an existing l-interface
45882 Create or update an existing l-interface.
45884 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
45885 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
45894 description: Response codes found in [response codes](https://wiki.onap.org/).
45898 description: unique name of Physical Network Function.
45901 example: __PNF-NAME__
45902 - name: interface-name
45904 description: Name that identifies the link aggregate interface
45907 example: __INTERFACE-NAME__
45908 - name: interface-name
45910 description: Name given to the interface
45913 example: __INTERFACE-NAME__
45916 description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
45919 $ref: "#/definitions/l-interface"
45923 summary: update an existing l-interface
45925 Update an existing l-interface
45927 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45928 The PUT operation will entirely replace an existing object.
45929 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
45931 Other differences between PUT and PATCH are:
45933 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
45934 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45935 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45936 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
45945 description: Response codes found in [response codes](https://wiki.onap.org/).
45949 description: unique name of Physical Network Function.
45952 example: __PNF-NAME__
45953 - name: interface-name
45955 description: Name that identifies the link aggregate interface
45958 example: __INTERFACE-NAME__
45959 - name: interface-name
45961 description: Name given to the interface
45964 example: __INTERFACE-NAME__
45967 description: l-interface object that needs to be created or updated.
45970 $ref: "#/patchDefinitions/l-interface"
45974 summary: delete an existing l-interface
45975 description: delete an existing l-interface
45976 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
45985 description: Response codes found in [response codes](https://wiki.onap.org/).
45989 description: unique name of Physical Network Function.
45992 example: __PNF-NAME__
45993 - name: interface-name
45995 description: Name that identifies the link aggregate interface
45998 example: __INTERFACE-NAME__
45999 - name: interface-name
46001 description: Name given to the interface
46004 example: __INTERFACE-NAME__
46005 - name: resource-version
46007 description: resource-version for concurrency
46010 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
46014 summary: returns l-interfaces
46015 description: returns l-interfaces
46016 operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces
46022 description: successful operation
46024 $ref: "#/getDefinitions/l-interfaces"
46026 description: Response codes found in [response codes](https://wiki.onap.org/).
46030 description: unique name of Physical Network Function.
46033 example: __PNF-NAME__
46034 - name: interface-name
46036 description: Name that identifies the link aggregate interface
46039 example: __INTERFACE-NAME__
46042 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
46045 - name: interface-id
46047 description: ID of interface
46050 - name: interface-role
46052 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
46055 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}:
46059 summary: returns lag-interface
46060 description: returns lag-interface
46061 operationId: getNetworkPnfsPnfLagInterfacesLagInterface
46067 description: successful operation
46069 $ref: "#/getDefinitions/lag-interface"
46071 description: Response codes found in [response codes](https://wiki.onap.org/).
46075 description: unique name of Physical Network Function.
46078 example: __PNF-NAME__
46079 - name: interface-name
46081 description: Name that identifies the link aggregate interface
46084 example: __INTERFACE-NAME__
46087 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
46090 - name: interface-id
46092 description: ID of interface
46095 - name: interface-role
46097 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
46103 summary: create or update an existing lag-interface
46105 Create or update an existing lag-interface.
46107 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
46108 operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface
46117 description: Response codes found in [response codes](https://wiki.onap.org/).
46121 description: unique name of Physical Network Function.
46124 example: __PNF-NAME__
46125 - name: interface-name
46127 description: Name that identifies the link aggregate interface
46130 example: __INTERFACE-NAME__
46133 description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnfLagInterfacesLagInterface.json)
46136 $ref: "#/definitions/lag-interface"
46140 summary: update an existing lag-interface
46142 Update an existing lag-interface
46144 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46145 The PUT operation will entirely replace an existing object.
46146 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
46148 Other differences between PUT and PATCH are:
46150 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
46151 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46152 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46153 operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterface
46162 description: Response codes found in [response codes](https://wiki.onap.org/).
46166 description: unique name of Physical Network Function.
46169 example: __PNF-NAME__
46170 - name: interface-name
46172 description: Name that identifies the link aggregate interface
46175 example: __INTERFACE-NAME__
46178 description: lag-interface object that needs to be created or updated.
46181 $ref: "#/patchDefinitions/lag-interface"
46185 summary: delete an existing lag-interface
46186 description: delete an existing lag-interface
46187 operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface
46196 description: Response codes found in [response codes](https://wiki.onap.org/).
46200 description: unique name of Physical Network Function.
46203 example: __PNF-NAME__
46204 - name: interface-name
46206 description: Name that identifies the link aggregate interface
46209 example: __INTERFACE-NAME__
46210 - name: resource-version
46212 description: resource-version for concurrency
46215 /network/pnfs/pnf/{pnf-name}/lag-interfaces:
46219 summary: returns lag-interfaces
46220 description: returns lag-interfaces
46221 operationId: getNetworkPnfsPnfLagInterfaces
46227 description: successful operation
46229 $ref: "#/getDefinitions/lag-interfaces"
46231 description: Response codes found in [response codes](https://wiki.onap.org/).
46235 description: unique name of Physical Network Function.
46238 example: __PNF-NAME__
46241 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
46244 /network/pnfs/pnf/{pnf-name}:
46248 summary: returns pnf
46249 description: returns pnf
46250 operationId: getNetworkPnfsPnf
46256 description: successful operation
46258 $ref: "#/getDefinitions/pnf"
46260 description: Response codes found in [response codes](https://wiki.onap.org/).
46264 description: unique name of Physical Network Function.
46267 example: __PNF-NAME__
46270 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
46276 summary: create or update an existing pnf
46278 Create or update an existing pnf.
46280 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
46281 operationId: createOrUpdateNetworkPnfsPnf
46290 description: Response codes found in [response codes](https://wiki.onap.org/).
46294 description: unique name of Physical Network Function.
46297 example: __PNF-NAME__
46300 description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPnfsPnf.json)
46303 $ref: "#/definitions/pnf"
46307 summary: update an existing pnf
46309 Update an existing pnf
46311 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46312 The PUT operation will entirely replace an existing object.
46313 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
46315 Other differences between PUT and PATCH are:
46317 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
46318 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46319 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46320 operationId: UpdateNetworkPnfsPnf
46329 description: Response codes found in [response codes](https://wiki.onap.org/).
46333 description: unique name of Physical Network Function.
46336 example: __PNF-NAME__
46339 description: pnf object that needs to be created or updated.
46342 $ref: "#/patchDefinitions/pnf"
46346 summary: delete an existing pnf
46347 description: delete an existing pnf
46348 operationId: deleteNetworkPnfsPnf
46357 description: Response codes found in [response codes](https://wiki.onap.org/).
46361 description: unique name of Physical Network Function.
46364 example: __PNF-NAME__
46365 - name: resource-version
46367 description: resource-version for concurrency
46374 summary: returns pnfs
46375 description: returns pnfs
46376 operationId: getNetworkPnfs
46382 description: successful operation
46384 $ref: "#/getDefinitions/pnfs"
46386 description: Response codes found in [response codes](https://wiki.onap.org/).
46387 /network/physical-links/physical-link/{link-name}/relationship-list/relationship:
46391 summary: see node definition for valid relationships
46392 operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
46401 description: Response codes found in [response codes](https://wiki.onap.org/).
46405 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
46408 example: __LINK-NAME__
46411 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPhysicalLinksPhysicalLink.json)
46414 $ref: "#/definitions/relationship"
46418 summary: delete an existing relationship
46419 description: delete an existing relationship
46420 operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
46429 description: Response codes found in [response codes](https://wiki.onap.org/).
46433 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
46436 example: __LINK-NAME__
46437 /network/physical-links/physical-link/{link-name}:
46441 summary: returns physical-link
46442 description: returns physical-link
46443 operationId: getNetworkPhysicalLinksPhysicalLink
46449 description: successful operation
46451 $ref: "#/getDefinitions/physical-link"
46453 description: Response codes found in [response codes](https://wiki.onap.org/).
46457 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
46460 example: __LINK-NAME__
46463 description: Circuit it
46469 summary: create or update an existing physical-link
46471 Create or update an existing physical-link.
46473 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
46474 operationId: createOrUpdateNetworkPhysicalLinksPhysicalLink
46483 description: Response codes found in [response codes](https://wiki.onap.org/).
46487 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
46490 example: __LINK-NAME__
46493 description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkPhysicalLinksPhysicalLink.json)
46496 $ref: "#/definitions/physical-link"
46500 summary: update an existing physical-link
46502 Update an existing physical-link
46504 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46505 The PUT operation will entirely replace an existing object.
46506 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
46508 Other differences between PUT and PATCH are:
46510 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
46511 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46512 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46513 operationId: UpdateNetworkPhysicalLinksPhysicalLink
46522 description: Response codes found in [response codes](https://wiki.onap.org/).
46526 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
46529 example: __LINK-NAME__
46532 description: physical-link object that needs to be created or updated.
46535 $ref: "#/patchDefinitions/physical-link"
46539 summary: delete an existing physical-link
46540 description: delete an existing physical-link
46541 operationId: deleteNetworkPhysicalLinksPhysicalLink
46550 description: Response codes found in [response codes](https://wiki.onap.org/).
46554 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
46557 example: __LINK-NAME__
46558 - name: resource-version
46560 description: resource-version for concurrency
46563 /network/physical-links:
46567 summary: returns physical-links
46568 description: returns physical-links
46569 operationId: getNetworkPhysicalLinks
46575 description: successful operation
46577 $ref: "#/getDefinitions/physical-links"
46579 description: Response codes found in [response codes](https://wiki.onap.org/).
46580 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship:
46584 summary: see node definition for valid relationships
46585 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
46594 description: Response codes found in [response codes](https://wiki.onap.org/).
46596 - name: ipsec-configuration-id
46598 description: UUID of this configuration
46601 example: __IPSEC-CONFIGURATION-ID__
46604 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkIpsecConfigurationsIpsecConfiguration.json)
46607 $ref: "#/definitions/relationship"
46611 summary: delete an existing relationship
46612 description: delete an existing relationship
46613 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
46622 description: Response codes found in [response codes](https://wiki.onap.org/).
46624 - name: ipsec-configuration-id
46626 description: UUID of this configuration
46629 example: __IPSEC-CONFIGURATION-ID__
46630 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship:
46634 summary: see node definition for valid relationships
46635 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
46644 description: Response codes found in [response codes](https://wiki.onap.org/).
46646 - name: ipsec-configuration-id
46648 description: UUID of this configuration
46651 example: __IPSEC-CONFIGURATION-ID__
46652 - name: vig-address-type
46654 description: indicates whether the VIG is for AVPN or INTERNET
46657 example: __VIG-ADDRESS-TYPE__
46660 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
46663 $ref: "#/definitions/relationship"
46667 summary: delete an existing relationship
46668 description: delete an existing relationship
46669 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
46678 description: Response codes found in [response codes](https://wiki.onap.org/).
46680 - name: ipsec-configuration-id
46682 description: UUID of this configuration
46685 example: __IPSEC-CONFIGURATION-ID__
46686 - name: vig-address-type
46688 description: indicates whether the VIG is for AVPN or INTERNET
46691 example: __VIG-ADDRESS-TYPE__
46692 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}:
46696 summary: returns vig-server
46697 description: returns vig-server
46698 operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
46704 description: successful operation
46706 $ref: "#/getDefinitions/vig-server"
46708 description: Response codes found in [response codes](https://wiki.onap.org/).
46710 - name: ipsec-configuration-id
46712 description: UUID of this configuration
46715 example: __IPSEC-CONFIGURATION-ID__
46716 - name: vig-address-type
46718 description: indicates whether the VIG is for AVPN or INTERNET
46721 example: __VIG-ADDRESS-TYPE__
46725 summary: create or update an existing vig-server
46727 Create or update an existing vig-server.
46729 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
46730 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
46739 description: Response codes found in [response codes](https://wiki.onap.org/).
46741 - name: ipsec-configuration-id
46743 description: UUID of this configuration
46746 example: __IPSEC-CONFIGURATION-ID__
46747 - name: vig-address-type
46749 description: indicates whether the VIG is for AVPN or INTERNET
46752 example: __VIG-ADDRESS-TYPE__
46755 description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
46758 $ref: "#/definitions/vig-server"
46762 summary: update an existing vig-server
46764 Update an existing vig-server
46766 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46767 The PUT operation will entirely replace an existing object.
46768 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
46770 Other differences between PUT and PATCH are:
46772 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
46773 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46774 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46775 operationId: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
46784 description: Response codes found in [response codes](https://wiki.onap.org/).
46786 - name: ipsec-configuration-id
46788 description: UUID of this configuration
46791 example: __IPSEC-CONFIGURATION-ID__
46792 - name: vig-address-type
46794 description: indicates whether the VIG is for AVPN or INTERNET
46797 example: __VIG-ADDRESS-TYPE__
46800 description: vig-server object that needs to be created or updated.
46803 $ref: "#/patchDefinitions/vig-server"
46807 summary: delete an existing vig-server
46808 description: delete an existing vig-server
46809 operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
46818 description: Response codes found in [response codes](https://wiki.onap.org/).
46820 - name: ipsec-configuration-id
46822 description: UUID of this configuration
46825 example: __IPSEC-CONFIGURATION-ID__
46826 - name: vig-address-type
46828 description: indicates whether the VIG is for AVPN or INTERNET
46831 example: __VIG-ADDRESS-TYPE__
46832 - name: resource-version
46834 description: resource-version for concurrency
46837 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers:
46841 summary: returns vig-servers
46842 description: returns vig-servers
46843 operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers
46849 description: successful operation
46851 $ref: "#/getDefinitions/vig-servers"
46853 description: Response codes found in [response codes](https://wiki.onap.org/).
46855 - name: ipsec-configuration-id
46857 description: UUID of this configuration
46860 example: __IPSEC-CONFIGURATION-ID__
46861 /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}:
46865 summary: returns ipsec-configuration
46866 description: returns ipsec-configuration
46867 operationId: getNetworkIpsecConfigurationsIpsecConfiguration
46873 description: successful operation
46875 $ref: "#/getDefinitions/ipsec-configuration"
46877 description: Response codes found in [response codes](https://wiki.onap.org/).
46879 - name: ipsec-configuration-id
46881 description: UUID of this configuration
46884 example: __IPSEC-CONFIGURATION-ID__
46888 summary: create or update an existing ipsec-configuration
46890 Create or update an existing ipsec-configuration.
46892 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
46893 operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration
46902 description: Response codes found in [response codes](https://wiki.onap.org/).
46904 - name: ipsec-configuration-id
46906 description: UUID of this configuration
46909 example: __IPSEC-CONFIGURATION-ID__
46912 description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkIpsecConfigurationsIpsecConfiguration.json)
46915 $ref: "#/definitions/ipsec-configuration"
46919 summary: update an existing ipsec-configuration
46921 Update an existing ipsec-configuration
46923 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46924 The PUT operation will entirely replace an existing object.
46925 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
46927 Other differences between PUT and PATCH are:
46929 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
46930 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46931 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46932 operationId: UpdateNetworkIpsecConfigurationsIpsecConfiguration
46941 description: Response codes found in [response codes](https://wiki.onap.org/).
46943 - name: ipsec-configuration-id
46945 description: UUID of this configuration
46948 example: __IPSEC-CONFIGURATION-ID__
46951 description: ipsec-configuration object that needs to be created or updated.
46954 $ref: "#/patchDefinitions/ipsec-configuration"
46958 summary: delete an existing ipsec-configuration
46959 description: delete an existing ipsec-configuration
46960 operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration
46969 description: Response codes found in [response codes](https://wiki.onap.org/).
46971 - name: ipsec-configuration-id
46973 description: UUID of this configuration
46976 example: __IPSEC-CONFIGURATION-ID__
46977 - name: resource-version
46979 description: resource-version for concurrency
46982 /network/ipsec-configurations:
46986 summary: returns ipsec-configurations
46987 description: returns ipsec-configurations
46988 operationId: getNetworkIpsecConfigurations
46994 description: successful operation
46996 $ref: "#/getDefinitions/ipsec-configurations"
46998 description: Response codes found in [response codes](https://wiki.onap.org/).
46999 /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship:
47003 summary: see node definition for valid relationships
47004 operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
47013 description: Response codes found in [response codes](https://wiki.onap.org/).
47015 - name: route-table-reference-id
47017 description: Route Table Reference id, UUID assigned to this instance.
47020 example: __ROUTE-TABLE-REFERENCE-ID__
47023 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkRouteTableReferencesRouteTableReference.json)
47026 $ref: "#/definitions/relationship"
47030 summary: delete an existing relationship
47031 description: delete an existing relationship
47032 operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
47041 description: Response codes found in [response codes](https://wiki.onap.org/).
47043 - name: route-table-reference-id
47045 description: Route Table Reference id, UUID assigned to this instance.
47048 example: __ROUTE-TABLE-REFERENCE-ID__
47049 /network/route-table-references/route-table-reference/{route-table-reference-id}:
47053 summary: returns route-table-reference
47054 description: returns route-table-reference
47055 operationId: getNetworkRouteTableReferencesRouteTableReference
47061 description: successful operation
47063 $ref: "#/getDefinitions/route-table-reference"
47065 description: Response codes found in [response codes](https://wiki.onap.org/).
47067 - name: route-table-reference-id
47069 description: Route Table Reference id, UUID assigned to this instance.
47072 example: __ROUTE-TABLE-REFERENCE-ID__
47073 - name: route-table-reference-fqdn
47075 description: FQDN entry in the route table.
47081 summary: create or update an existing route-table-reference
47083 Create or update an existing route-table-reference.
47085 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
47086 operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference
47095 description: Response codes found in [response codes](https://wiki.onap.org/).
47097 - name: route-table-reference-id
47099 description: Route Table Reference id, UUID assigned to this instance.
47102 example: __ROUTE-TABLE-REFERENCE-ID__
47105 description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkRouteTableReferencesRouteTableReference.json)
47108 $ref: "#/definitions/route-table-reference"
47112 summary: update an existing route-table-reference
47114 Update an existing route-table-reference
47116 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47117 The PUT operation will entirely replace an existing object.
47118 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
47120 Other differences between PUT and PATCH are:
47122 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
47123 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47124 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47125 operationId: UpdateNetworkRouteTableReferencesRouteTableReference
47134 description: Response codes found in [response codes](https://wiki.onap.org/).
47136 - name: route-table-reference-id
47138 description: Route Table Reference id, UUID assigned to this instance.
47141 example: __ROUTE-TABLE-REFERENCE-ID__
47144 description: route-table-reference object that needs to be created or updated.
47147 $ref: "#/patchDefinitions/route-table-reference"
47151 summary: delete an existing route-table-reference
47152 description: delete an existing route-table-reference
47153 operationId: deleteNetworkRouteTableReferencesRouteTableReference
47162 description: Response codes found in [response codes](https://wiki.onap.org/).
47164 - name: route-table-reference-id
47166 description: Route Table Reference id, UUID assigned to this instance.
47169 example: __ROUTE-TABLE-REFERENCE-ID__
47170 - name: resource-version
47172 description: resource-version for concurrency
47175 /network/route-table-references:
47179 summary: returns route-table-references
47180 description: returns route-table-references
47181 operationId: getNetworkRouteTableReferences
47187 description: successful operation
47189 $ref: "#/getDefinitions/route-table-references"
47191 description: Response codes found in [response codes](https://wiki.onap.org/).
47192 /network/instance-groups/instance-group/{id}/relationship-list/relationship:
47196 summary: see node definition for valid relationships
47197 operationId: createOrUpdateNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
47206 description: Response codes found in [response codes](https://wiki.onap.org/).
47210 description: Instance Group ID, UUID assigned to this instance.
47216 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkInstanceGroupsInstanceGroup.json)
47219 $ref: "#/definitions/relationship"
47223 summary: delete an existing relationship
47224 description: delete an existing relationship
47225 operationId: deleteNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
47234 description: Response codes found in [response codes](https://wiki.onap.org/).
47238 description: Instance Group ID, UUID assigned to this instance.
47242 /network/instance-groups/instance-group/{id}:
47246 summary: returns instance-group
47247 description: returns instance-group
47248 operationId: getNetworkInstanceGroupsInstanceGroup
47254 description: successful operation
47256 $ref: "#/getDefinitions/instance-group"
47258 description: Response codes found in [response codes](https://wiki.onap.org/).
47262 description: Instance Group ID, UUID assigned to this instance.
47266 - name: description
47268 description: Descriptive text to help identify the usage of this instance-group
47273 description: Only valid value today is lower case ha for high availability
47278 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
47284 summary: create or update an existing instance-group
47286 Create or update an existing instance-group.
47288 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
47289 operationId: createOrUpdateNetworkInstanceGroupsInstanceGroup
47298 description: Response codes found in [response codes](https://wiki.onap.org/).
47302 description: Instance Group ID, UUID assigned to this instance.
47308 description: instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkInstanceGroupsInstanceGroup.json)
47311 $ref: "#/definitions/instance-group"
47315 summary: update an existing instance-group
47317 Update an existing instance-group
47319 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47320 The PUT operation will entirely replace an existing object.
47321 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
47323 Other differences between PUT and PATCH are:
47325 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
47326 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47327 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47328 operationId: UpdateNetworkInstanceGroupsInstanceGroup
47337 description: Response codes found in [response codes](https://wiki.onap.org/).
47341 description: Instance Group ID, UUID assigned to this instance.
47347 description: instance-group object that needs to be created or updated.
47350 $ref: "#/patchDefinitions/instance-group"
47354 summary: delete an existing instance-group
47355 description: delete an existing instance-group
47356 operationId: deleteNetworkInstanceGroupsInstanceGroup
47365 description: Response codes found in [response codes](https://wiki.onap.org/).
47369 description: Instance Group ID, UUID assigned to this instance.
47373 - name: resource-version
47375 description: resource-version for concurrency
47378 /network/instance-groups:
47382 summary: returns instance-groups
47383 description: returns instance-groups
47384 operationId: getNetworkInstanceGroups
47390 description: successful operation
47392 $ref: "#/getDefinitions/instance-groups"
47394 description: Response codes found in [response codes](https://wiki.onap.org/).
47395 /network/zones/zone/{zone-id}/relationship-list/relationship:
47399 summary: see node definition for valid relationships
47400 operationId: createOrUpdateNetworkZonesZoneRelationshipListRelationship
47409 description: Response codes found in [response codes](https://wiki.onap.org/).
47413 description: Code assigned by AIC to the zone
47416 example: __ZONE-ID__
47419 description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkZonesZone.json)
47422 $ref: "#/definitions/relationship"
47426 summary: delete an existing relationship
47427 description: delete an existing relationship
47428 operationId: deleteNetworkZonesZoneRelationshipListRelationship
47437 description: Response codes found in [response codes](https://wiki.onap.org/).
47441 description: Code assigned by AIC to the zone
47444 example: __ZONE-ID__
47445 /network/zones/zone/{zone-id}:
47449 summary: returns zone
47450 description: returns zone
47451 operationId: getNetworkZonesZone
47457 description: successful operation
47459 $ref: "#/getDefinitions/zone"
47461 description: Response codes found in [response codes](https://wiki.onap.org/).
47465 description: Code assigned by AIC to the zone
47468 example: __ZONE-ID__
47469 - name: design-type
47471 description: Design of zone [Medium/Large?]
47474 - name: zone-context
47476 description: Context of zone [production/test]
47482 summary: create or update an existing zone
47484 Create or update an existing zone.
47486 Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
47487 operationId: createOrUpdateNetworkZonesZone
47496 description: Response codes found in [response codes](https://wiki.onap.org/).
47500 description: Code assigned by AIC to the zone
47503 example: __ZONE-ID__
47506 description: zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v9/NetworkZonesZone.json)
47509 $ref: "#/definitions/zone"
47513 summary: update an existing zone
47515 Update an existing zone
47517 Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47518 The PUT operation will entirely replace an existing object.
47519 The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
47521 Other differences between PUT and PATCH are:
47523 - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
47524 - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47525 - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47526 operationId: UpdateNetworkZonesZone
47535 description: Response codes found in [response codes](https://wiki.onap.org/).
47539 description: Code assigned by AIC to the zone
47542 example: __ZONE-ID__
47545 description: zone object that needs to be created or updated.
47548 $ref: "#/patchDefinitions/zone"
47552 summary: delete an existing zone
47553 description: delete an existing zone
47554 operationId: deleteNetworkZonesZone
47563 description: Response codes found in [response codes](https://wiki.onap.org/).
47567 description: Code assigned by AIC to the zone
47570 example: __ZONE-ID__
47571 - name: resource-version
47573 description: resource-version for concurrency
47580 summary: returns zones
47581 description: returns zones
47582 operationId: getNetworkZones
47588 description: successful operation
47590 $ref: "#/getDefinitions/zones"
47592 description: Response codes found in [response codes](https://wiki.onap.org/).
47607 $ref: "#/definitions/action-data"
47616 APIs that are more action related than REST (e.g., notify, update).
47620 $ref: "#/definitions/update"
47623 $ref: "#/definitions/notify"
47626 Represents a slice or partial piece of a resource that gets separately allotted
47627 ###### Related Nodes
47628 - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
47629 - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
47630 - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
47631 - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
47632 - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
47633 - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
47634 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
47635 - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
47641 description: Allotted Resource id UUID assigned to this instance.
47644 description: The descriptive information assigned to this allotted resource instance
47647 description: Link back to more information in the controller
47650 description: the ASDC model id for this resource or service model.
47651 persona-model-version:
47653 description: the ASDC model version for this resource or service model.
47656 description: the ASDC model version for this resource or service model.
47657 persona-model-customization-id:
47659 description: captures the id of all the configuration used to customize the resource for the service.
47662 description: Concurrency value
47666 $ref: "#/definitions/tunnel-xconnect"
47670 $ref: "#/definitions/relationship"
47671 allotted-resources:
47673 This object is used to store slices of services being offered
47678 $ref: "#/definitions/allotted-resource"
47681 Availability zone, a collection of compute hosts/pservers
47682 ###### Related Nodes
47683 - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
47684 - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
47685 - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
47686 - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
47687 - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
47688 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
47689 - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
47690 - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
47691 - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
47693 - availability-zone-name
47696 availability-zone-name:
47698 description: Name of the availability zone. Unique across a cloud region
47701 description: Type of hypervisor. Source of truth should define valid values.
47704 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
47707 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47711 $ref: "#/definitions/relationship"
47712 availability-zones:
47714 Collection of availability zones
47719 $ref: "#/definitions/availability-zone"
47720 az-and-dvs-switches:
47724 $ref: "#/definitions/dvs-switches"
47727 $ref: "#/definitions/availability-zone"
47730 Namespace for business related constructs
47735 $ref: "#/definitions/connector"
47739 $ref: "#/definitions/customer"
47742 ###### Related Nodes
47743 - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
47749 description: unique identifier of probe
47752 description: identifier of probe
47755 description: type of probe
47758 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47762 $ref: "#/definitions/relationship"
47763 classes-of-service:
47765 class-of-service of probe
47770 $ref: "#/definitions/class-of-service"
47771 cloud-infrastructure:
47773 Namespace for cloud infrastructure.
47778 $ref: "#/definitions/complex"
47782 $ref: "#/definitions/cloud-region"
47786 $ref: "#/definitions/network-profile"
47790 $ref: "#/definitions/pserver"
47791 virtual-data-centers:
47794 $ref: "#/definitions/virtual-data-center"
47797 cloud-region designates an installation of a cloud cluster or region or instantiation.
47798 ###### Related Nodes
47799 - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
47800 - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
47801 - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
47802 - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
47803 - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
47804 - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
47805 - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
47806 - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
47807 - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
47808 - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
47809 - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
47810 - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
47811 - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
47812 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
47813 - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
47814 - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
47821 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
47824 description: Identifier used by the vendor for the region. Second part of composite key
47827 description: Type of the cloud (e.g., openstack)
47828 owner-defined-type:
47830 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
47831 cloud-region-version:
47833 description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
47836 description: URL of the keystone identity service
47839 description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
47842 description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
47845 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47849 $ref: "#/definitions/volume-group"
47853 $ref: "#/definitions/tenant"
47857 $ref: "#/definitions/flavor"
47861 $ref: "#/definitions/group-assignment"
47865 $ref: "#/definitions/snapshot"
47869 $ref: "#/definitions/image"
47873 $ref: "#/definitions/dvs-switch"
47877 $ref: "#/definitions/oam-network"
47878 availability-zones:
47881 $ref: "#/definitions/availability-zone"
47885 $ref: "#/definitions/relationship"
47891 $ref: "#/definitions/cloud-region"
47894 Collection of physical locations that can house cloud-regions.
47895 ###### Related Nodes
47896 - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
47897 - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
47898 - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
47899 - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
47900 - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
47901 - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
47902 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
47903 - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
47904 - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
47905 - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
47906 - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
47907 - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
47908 - COMPLEX is DELETED when these are DELETED CTAG-POOL
47910 - physical-location-id
47911 - physical-location-type
47918 physical-location-id:
47920 description: Unique identifier for physical location, e.g., CLLI
47923 description: Data center code which can be an alternate way to identify a complex
47926 description: Gamma complex name for LCP instance.
47929 description: URL of the keystone identity service
47932 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
47933 physical-location-type:
47935 description: Type, e.g., central office, data center.
47961 $ref: "#/definitions/ctag-pool"
47965 $ref: "#/definitions/relationship"
47968 Collection of physical locations that can house cloud-regions.
47973 $ref: "#/definitions/complex"
47976 Port Mirror Configuration.
47977 ###### Related Nodes
47978 - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
47979 - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
47980 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
47981 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
47982 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
47983 - CONFIGURATION is DELETED when these are DELETED METADATUM
47984 - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
47987 - configuration-type
47988 - configuration-sub-type
47989 - orchestration-status
47990 - operational-status
47991 - configuration-selflink
47992 - model-customization-id
47996 description: UUID assigned to configuration.
47999 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
48000 configuration-name:
48002 description: Name of the configuration.
48003 configuration-type:
48005 description: port-mirroring-configuration.
48006 configuration-sub-type:
48008 description: vprobe, pprobe.
48009 model-invariant-id:
48011 description: the ASDC model id for this resource or service model.
48014 description: the ASDC model version for this resource or service model.
48015 orchestration-status:
48017 description: Orchestration status of the configuration.
48018 operational-status:
48020 description: Indicator for whether the resource is considered operational.
48021 configuration-selflink:
48023 description: URL to endpoint where AAI can get more details from SDN-GC.
48024 model-customization-id:
48026 description: id of the configuration used to customize the resource
48029 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48033 $ref: "#/definitions/relationship"
48037 $ref: "#/definitions/metadatum"
48040 Collection of configurations
48045 $ref: "#/definitions/configuration"
48048 Collection of resource instances used to connect a variety of disparate inventory widgets
48049 ###### Related Nodes
48050 - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
48051 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
48052 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
48053 - CONNECTOR is DELETED when these are DELETED METADATUM
48055 - resource-instance-id
48057 resource-instance-id:
48059 description: Unique id of resource instance.
48062 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48065 description: the ASDC model id for this resource or service model.
48066 persona-model-version:
48068 description: the ASDC model version for this resource or service model.
48071 description: the ASDC model version for this resource or service model.
48074 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
48075 widget-model-version:
48077 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
48081 $ref: "#/definitions/relationship"
48085 $ref: "#/definitions/metadatum"
48088 Collection of resource instances used to connect a variety of disparate inventory widgets
48093 $ref: "#/definitions/connector"
48094 constrained-element-set:
48096 This is how we would capture constraints defining allowed sets of elements.
48097 ###### Related Nodes
48098 - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
48099 - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
48100 - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
48101 - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
48103 - constrained-element-set-uuid
48107 constrained-element-set-uuid:
48115 element-choice-sets:
48118 $ref: "#/definitions/element-choice-set"
48122 $ref: "#/definitions/relationship"
48123 constrained-element-sets:
48125 constrained-element-set:
48128 $ref: "#/definitions/constrained-element-set"
48131 ###### Related Nodes
48132 - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
48133 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
48143 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48147 $ref: "#/definitions/relationship"
48153 $ref: "#/definitions/ctag-assignment"
48156 A collection of C tags (vlan tags) grouped for a specific purpose.
48157 ###### Related Nodes
48158 - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
48159 - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
48160 - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
48163 - availability-zone-name
48164 - ctag-pool-purpose
48168 description: The Target provider edge router
48169 availability-zone-name:
48171 description: Name of the availability zone
48174 description: Describes what the intended purpose of this pool is.
48177 description: Comma separated list of ctags
48180 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48184 $ref: "#/definitions/relationship"
48190 $ref: "#/definitions/ctag-pool"
48193 customer identifiers to provide linkage back to BSS information.
48194 ###### Related Nodes
48195 - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
48196 - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
48198 - global-customer-id
48202 global-customer-id:
48204 description: Global customer id used across ECOMP to uniquely identify customer.
48207 description: Subscriber name, an alternate way to retrieve a customer.
48210 description: Subscriber type, a way to provide VID with only the INFRA customers.
48213 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48214 service-subscriptions:
48217 $ref: "#/definitions/service-subscription"
48221 $ref: "#/definitions/relationship"
48224 Collection of customer identifiers to provide linkage back to BSS information.
48229 $ref: "#/definitions/customer"
48237 description: See mis-na-virtualization-platform.yang
48240 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48244 $ref: "#/definitions/relationship"
48250 $ref: "#/definitions/cvlan-tag-entry"
48253 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.
48254 ###### Related Nodes
48255 - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48256 - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
48263 description: DVS switch name
48266 description: URL used to reach the vcenter
48269 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48273 $ref: "#/definitions/relationship"
48276 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
48281 $ref: "#/definitions/dvs-switch"
48284 Internal map to define the properties of an edge and interpret the map EdgeRules
48302 edge-tag-query-request:
48313 $ref: "#/definitions/start-node-filter"
48314 include-node-filter:
48317 $ref: "#/definitions/include-node-filter"
48321 $ref: "#/definitions/secondary-filter"
48322 edge-tag-query-result:
48324 tagged-inventory-item-list:
48327 $ref: "#/definitions/tagged-inventory-item-list"
48328 element-choice-set:
48330 This is how we would capture constraints defining allowed sets of elements.
48331 ###### Related Nodes
48332 - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
48333 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
48334 - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
48336 - element-choice-set-uuid
48337 - element-choice-set-name
48339 element-choice-set-uuid:
48341 element-choice-set-name:
48350 $ref: "#/definitions/model-element"
48354 $ref: "#/definitions/relationship"
48355 element-choice-sets:
48357 element-choice-set:
48360 $ref: "#/definitions/element-choice-set"
48363 Metadata for entitlement group.
48364 ###### Related Nodes
48365 - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
48366 - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
48373 description: Unique ID for the entitlement group the resource comes from, should be uuid.
48376 description: Unique ID of an entitlement resource.
48379 description: Concurrency value
48383 $ref: "#/definitions/relationship"
48386 Entitlements, keyed by group-uuid and resource-uuid, related to license management
48391 $ref: "#/definitions/entitlement"
48394 Persist EMS address information used by EMS driver.
48395 ###### Related Nodes
48396 - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
48397 - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
48403 description: Unique ID of EMS.
48406 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48407 esr-system-info-list:
48409 $ref: "#/definitions/esr-system-info-list"
48412 $ref: "#/definitions/relationship-list"
48418 $ref: "#/definitions/esr-ems"
48421 Persist common address information of external systems.
48422 ###### Related Nodes
48423 - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
48424 - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
48425 - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
48426 - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
48428 - esr-system-info-id
48433 esr-system-info-id:
48435 description: Unique ID of esr system info.
48438 description: name of external system.
48441 description: type of external systems.
48444 description: vendor of external systems.
48447 description: version of external systems.
48450 description: url used to access external systems.
48453 description: username used to access external systems.
48456 description: password used to access external systems.
48459 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
48462 description: protocol of third party SDNC, for example netconf/snmp.
48465 description: ca file content if enabled ssl on auth-url.
48468 description: Whether to verify VIM's certificate.
48471 description: service IP of ftp server.
48474 description: service port of ftp server.
48477 description: domain info for authentication.
48480 description: default tenant of VIM.
48483 description: ftp passive mode or not.
48486 description: resource or performance data file path.
48489 description: the status of external system.
48492 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48496 $ref: "#/definitions/relationship"
48497 esr-system-info-list:
48499 Collection of persistent block-level external system auth info.
48504 $ref: "#/definitions/esr-system-info"
48505 esr-thirdparty-sdnc:
48507 Persist SDNC address information used by ONAP SDNC.
48508 ###### Related Nodes
48509 - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
48510 - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
48511 - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
48513 - thirdparty-sdnc-id
48515 thirdparty-sdnc-id:
48517 description: Unique ID of SDNC.
48520 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
48523 description: password used to access SDNC server.
48526 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48527 esr-system-info-list:
48529 $ref: "#/definitions/esr-system-info-list"
48532 $ref: "#/definitions/relationship-list"
48533 esr-thirdparty-sdnc-list:
48535 esr-thirdparty-sdnc:
48538 $ref: "#/definitions/esr-thirdparty-sdnc"
48541 Persist VNFM address information used by VF-C.
48542 ###### Related Nodes
48543 - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
48544 - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
48550 description: Unique ID of VNFM.
48553 description: indecate the VIM to deploy VNF.
48556 description: certificate url of VNFM.
48559 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48560 esr-system-info-list:
48562 $ref: "#/definitions/esr-system-info-list"
48565 $ref: "#/definitions/relationship-list"
48571 $ref: "#/definitions/esr-vnfm"
48574 evc object is an optional child object of the Configuration object.
48575 ###### Related Nodes
48576 - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
48582 description: Unique/key field for the evc object
48583 forwarding-path-topology:
48585 description: Point-to-Point, Multi-Point
48588 description: Commited Information Rate
48591 description: CIR units
48592 connection-diversity-group-id:
48594 description: Diversity Group ID
48597 description: formerly Performance Group
48598 esp-evc-circuit-id:
48600 description: EVC Circuit ID of ESP EVC
48603 description: Committed Information Rate (For ESP)
48606 description: CIR units (For ESP)
48609 description: Identifies ESP
48610 collector-pop-clli:
48612 description: Collector POP CLLI (from the hostname of the access pnf)
48613 inter-connect-type-ingress:
48615 description: Interconnect type on ingress side of EVC.
48616 tagmode-access-ingress:
48618 description: tagode for collector side of EVC
48619 tagmode-access-egress:
48621 description: tagMode for network side of EVC
48625 $ref: "#/definitions/relationship"
48628 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48634 $ref: "#/definitions/evc"
48637 Namespace for external system.
48641 $ref: "#/definitions/esr-ems-list"
48644 $ref: "#/definitions/esr-vnfm-list"
48645 esr-thirdparty-sdnc-list:
48647 $ref: "#/definitions/esr-thirdparty-sdnc-list"
48650 Extra properties for inventory item for response list
48658 ###### Related Nodes
48659 - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48660 - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
48661 - FLAVOR cannot be deleted if linked to VSERVER
48669 description: Flavor id, expected to be unique across cloud-region.
48672 description: Flavor name
48676 description: Number of CPUs
48680 description: Amount of memory
48684 description: Disk space
48688 description: Amount of ephemeral disk space
48691 description: amount of swap space allocation
48694 description: whether flavor is available to all users or private to the tenant it was created in.
48697 description: URL to endpoint where AAI can get more details
48700 description: Boolean as to whether this flavor is no longer enabled
48703 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48707 $ref: "#/definitions/relationship"
48710 Collection of openstack flavors.
48715 $ref: "#/definitions/flavor"
48718 Entity describing a sequenced segment of forwarding path
48719 ###### Related Nodes
48720 - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
48721 - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
48722 - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
48723 - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
48724 - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
48725 - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
48732 description: Unique ID of this segmentation
48735 description: ingress, intermediate, egress
48739 $ref: "#/definitions/relationship"
48742 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48745 forwarder object is an optional child object of the Configuration object.
48746 ###### Related Nodes
48747 - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
48753 description: Key for forwarder-evc object
48756 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
48759 description: Internal VLAN.
48762 description: SVLAN value for ingress of egress forwarder.
48765 description: CVLAN value for ingress of egress forwarder.
48769 $ref: "#/definitions/relationship"
48772 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48778 $ref: "#/definitions/forwarder-evc"
48784 $ref: "#/definitions/forwarder"
48787 Entity that describes the sequenced forwarding path between interfaces of services or resources
48788 ###### Related Nodes
48789 - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
48790 - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
48791 - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
48792 - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
48793 - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
48795 - forwarding-path-id
48796 - forwarding-path-name
48798 forwarding-path-id:
48800 description: Unique ID of this FP
48801 forwarding-path-name:
48803 description: Name of the FP
48807 $ref: "#/definitions/relationship"
48810 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48813 description: the self link for this FP
48817 $ref: "#/definitions/forwarder"
48823 $ref: "#/definitions/forwarding-path"
48826 General purpose VNF
48827 ###### Related Nodes
48828 - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
48829 - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
48830 - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
48831 - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
48832 - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
48833 - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
48834 - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
48835 - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
48836 - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
48837 - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
48838 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
48839 - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
48840 - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
48841 - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
48842 - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
48843 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
48844 - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
48845 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
48846 - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
48847 - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
48848 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
48849 - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
48855 - is-closed-loop-disabled
48859 description: Unique id of VNF. This is unique across the graph.
48862 description: Name of VNF.
48865 description: Alternate name of VNF.
48868 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
48871 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
48872 regional-resource-zone:
48874 description: Regional way of organizing pservers, source of truth should define values
48877 description: Trigger for operational monitoring of this resource by Service Assurance systems.
48880 description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
48883 description: OBSOLETE - do not use
48886 description: Client should send valid enumerated value
48887 orchestration-status:
48889 description: Orchestration status of this VNF, used by MSO.
48892 description: Heat stack id corresponding to this instance, managed by MSO
48895 description: Corresponds to the SDN-C catalog id used to configure this VCE
48898 description: identifier of managed by company or customer
48901 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
48902 ipv4-loopback0-address:
48904 description: v4 Loopback0 address
48907 description: v6 Loopback address
48908 management-v6-address:
48910 description: v6 management address
48914 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
48917 description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only in some usecases
48921 description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
48924 description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only in some usecases
48928 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
48931 description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases
48934 is-closed-loop-disabled:
48938 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48941 description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
48942 encrypted-access-flag:
48944 description: indicates whether generic-vnf access uses SSH
48947 description: the ASDC model id for this resource or service model.
48948 persona-model-version:
48950 description: the ASDC model version for this resource or service model.
48953 description: the ASDC model version for this resource or service model.
48954 persona-model-customization-id:
48956 description: captures the id of all the configuration used to customize the resource for the service.
48959 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
48960 widget-model-version:
48962 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
48965 description: as-number of the VNF
48966 regional-resource-subzone:
48968 description: represents sub zone of the rr plane
48971 description: Path to the controller object.
48975 $ref: "#/definitions/relationship"
48979 $ref: "#/definitions/l-interface"
48983 $ref: "#/definitions/lag-interface"
48987 $ref: "#/definitions/vf-module"
48991 $ref: "#/definitions/license"
48995 $ref: "#/definitions/entitlement"
49003 $ref: "#/definitions/generic-vnf"
49006 Openstack group-assignment used to store exclusivity groups (EG).
49007 ###### Related Nodes
49008 - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
49009 - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
49010 - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
49018 description: Group id, expected to be unique across cloud-region.
49021 description: Group type - the type of group this instance refers to
49024 description: Group name - name assigned to the group
49027 description: Group description - description of the group
49030 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49034 $ref: "#/definitions/relationship"
49037 Collection of openstack group assignments
49042 $ref: "#/definitions/group-assignment"
49045 ###### Related Nodes
49046 - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
49054 description: host-route id
49057 description: subnet prefix
49060 description: Could be ip-address, hostname, or service-instance
49063 description: Should be ip-address, hostname, or service-instance to match next-hop
49066 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49070 $ref: "#/definitions/relationship"
49076 $ref: "#/definitions/host-route"
49080 ###### Related Nodes
49081 - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
49082 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
49083 - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
49084 - IMAGE cannot be deleted if linked to VSERVER
49085 - IMAGE is DELETED when these are DELETED METADATUM
49095 description: Image id, expected to be unique across cloud region
49098 description: Image name
49099 image-architecture:
49101 description: Operating system architecture.
49104 description: The common name of the operating system distribution in lowercase
49107 description: The operating system version as specified by the distributor.
49110 description: The application that the image instantiates.
49111 application-vendor:
49113 description: The vendor of the application.
49114 application-version:
49116 description: The version of the application.
49119 description: URL to endpoint where AAI can get more details
49122 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49126 $ref: "#/definitions/relationship"
49130 $ref: "#/definitions/metadatum"
49133 Collectio of Openstack images.
49138 $ref: "#/definitions/image"
49139 include-node-filter:
49145 InstanceFilter for performing a named-query or model query
49148 InstanceFilters for performing a named-query or model query
49153 $ref: "#/definitions/instance-filter"
49156 General mechanism for grouping instances
49157 ###### Related Nodes
49158 - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
49159 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
49160 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
49161 - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
49162 - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
49170 description: Instance Group ID, UUID assigned to this instance.
49173 description: Descriptive text to help identify the usage of this instance-group
49176 description: Only valid value today is lower case ha for high availability
49179 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
49182 description: Concurrency value
49186 $ref: "#/definitions/relationship"
49189 Collection of openstack route table references
49194 $ref: "#/definitions/instance-group"
49199 $ref: "#/definitions/search"
49202 $ref: "#/definitions/actions"
49203 cloud-infrastructure:
49205 $ref: "#/definitions/cloud-infrastructure"
49208 $ref: "#/definitions/business"
49209 service-design-and-creation:
49211 $ref: "#/definitions/service-design-and-creation"
49214 $ref: "#/definitions/network"
49217 $ref: "#/definitions/aai-internal"
49221 $ref: "#/definitions/aai-internal"
49224 inventory-item-type:
49226 inventory-item-link:
49228 inventory-item-data:
49231 $ref: "#/definitions/inventory-item-data"
49232 tagged-inventory-item-list:
49235 $ref: "#/definitions/tagged-inventory-item-list"
49236 inventory-item-data:
49242 inventory-response-item:
49244 Inventory item for response list
49250 $ref: "#/definitions/extra-properties"
49251 inventory-response-items:
49253 $ref: "#/definitions/inventory-response-items"
49254 inventory-response-items:
49256 Container for inventory items in response list
49258 inventory-response-item:
49261 $ref: "#/definitions/inventory-response-item"
49262 ipsec-configuration:
49264 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
49265 ###### Related Nodes
49266 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
49267 - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
49268 - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
49270 - ipsec-configuration-id
49272 ipsec-configuration-id:
49274 description: UUID of this configuration
49275 requested-vig-address-type:
49277 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
49278 requested-encryption-strength:
49280 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
49281 requested-dmz-type:
49283 description: can offer a shared DMZ or a DMZ specific to a customer
49284 shared-dmz-network-address:
49286 description: Network address of shared DMZ
49287 requested-customer-name:
49289 description: If the DMZ is a custom DMZ, this field will indicate the customer information
49292 description: can be 1 or 2
49293 ikev1-authentication:
49295 description: Contains values like md5, sha1, sha256, sha384
49298 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
49301 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
49304 description: Group name defined in VIG for clients using aggressive mode
49307 description: pre-shared key for the above group name
49310 description: Lifetime for IKEv1 SA
49311 ipsec-authentication:
49313 description: md5, sha1, sha256, sha384
49316 description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
49319 description: Life time for IPSec SA
49322 description: enable PFS or not
49325 description: user ID for xAuth, sm-user, ,nmteHostName
49326 xauth-user-password:
49328 description: Encrypted using the Juniper $9$ algorithm
49331 description: The time between DPD probe
49334 description: Maximum number of DPD before claiming the tunnel is down
49337 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49341 $ref: "#/definitions/relationship"
49345 $ref: "#/definitions/vig-server"
49346 ipsec-configurations:
49348 ipsec-configuration:
49351 $ref: "#/definitions/ipsec-configuration"
49360 Logical interfaces, e.g., a vnic.
49361 ###### Related Nodes
49362 - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49363 - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
49364 - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
49365 - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
49366 - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
49367 - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
49368 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
49369 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
49370 - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
49371 - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
49372 - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
49373 - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
49379 description: Name given to the interface
49382 description: E.g., CUSTOMER, UPLINK, etc.
49385 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
49388 description: URL to endpoint where AAI can get more details
49391 description: ID of interface
49394 description: MAC address for the interface
49397 description: Name of the network
49400 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
49401 interface-description:
49403 description: Human friendly text regarding this interface.
49406 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49410 $ref: "#/definitions/vlan"
49414 $ref: "#/definitions/sriov-vf"
49418 $ref: "#/definitions/relationship"
49419 l3-interface-ipv4-address-list:
49422 $ref: "#/definitions/l3-interface-ipv4-address-list"
49423 l3-interface-ipv6-address-list:
49426 $ref: "#/definitions/l3-interface-ipv6-address-list"
49429 Collection of logical interfaces.
49434 $ref: "#/definitions/l-interface"
49435 l3-interface-ipv4-address-list:
49438 ###### Related Nodes
49439 - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
49440 - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
49441 - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
49442 - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
49444 - l3-interface-ipv4-address
49446 l3-interface-ipv4-address:
49448 description: IP address
49449 l3-interface-ipv4-prefix-length:
49452 description: Prefix length, 32 for single address
49456 description: Inner VLAN tag
49460 description: Outer VLAN tag
49463 description: Indicator of fixed or floating address
49466 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49467 neutron-network-id:
49469 description: Neutron network id of the interface that address belongs to
49472 description: Neutron id of subnet that address belongs to
49476 $ref: "#/definitions/relationship"
49477 l3-interface-ipv6-address-list:
49480 ###### Related Nodes
49481 - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
49482 - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
49483 - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
49484 - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
49486 - l3-interface-ipv6-address
49488 l3-interface-ipv6-address:
49490 description: IP address
49491 l3-interface-ipv6-prefix-length:
49494 description: Prefix length, 128 for single address
49498 description: Inner VLAN tag
49502 description: Outer VLAN tag
49505 description: Indicator of fixed or floating address
49508 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49509 neutron-network-id:
49511 description: Neutron network id of the interface that address belongs to
49514 description: Neutron id of subnet that address belongs to
49518 $ref: "#/definitions/relationship"
49521 Generic network definition
49522 ###### Related Nodes
49523 - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
49524 - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
49525 - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
49526 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
49527 - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
49528 - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
49529 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
49530 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
49531 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
49532 - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
49533 - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
49534 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
49535 - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
49536 - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
49537 - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
49538 - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
49543 - is-provider-network
49544 - is-shared-network
49545 - is-external-network
49549 description: Network ID, should be uuid. Unique across A&AI.
49552 description: Name of the network, governed by some naming convention..
49555 description: Type of the network - who defines these values?
49558 description: Role the network plans - who defines these values?
49559 network-technology:
49561 description: Network technology - who defines these values?
49562 neutron-network-id:
49564 description: Neutron network id of this Interface
49569 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
49570 network-role-instance:
49573 description: network role instance
49576 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49577 orchestration-status:
49579 description: Orchestration status of this VNF, mastered by MSO
49582 description: Heat stack id corresponding to this instance, managed by MSO
49585 description: Corresponds to the SDN-C catalog id used to configure this VCE
49586 contrail-network-fqdn:
49588 description: Contrail FQDN for the network
49591 description: the ASDC model id for this resource or service model.
49592 persona-model-version:
49594 description: the ASDC model version for this resource or service model.
49597 description: the ASDC model version for this resource or service model.
49598 persona-model-customization-id:
49600 description: captures the id of all the configuration used to customize the resource for the service.
49603 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
49604 widget-model-version:
49606 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
49607 physical-network-name:
49609 description: Name associated with the physical network.
49610 is-provider-network:
49614 is-external-network:
49618 description: Path to the controller object.
49622 $ref: "#/definitions/subnet"
49626 $ref: "#/definitions/ctag-assignment"
49627 segmentation-assignments:
49630 $ref: "#/definitions/segmentation-assignment"
49634 $ref: "#/definitions/relationship"
49635 description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
49641 $ref: "#/definitions/l3-network"
49644 Link aggregate interface
49645 ###### Related Nodes
49646 - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49647 - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
49648 - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
49649 - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
49650 - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
49651 - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
49652 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
49653 - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
49654 - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK
49660 description: Name that identifies the link aggregate interface
49661 interface-description:
49663 description: Human friendly text regarding this interface.
49666 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49669 description: Captures the numeric part of the speed
49672 description: Captures the units corresponding to the speed
49675 description: ID of interface
49678 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
49681 description: Trigger for operational monitoring of this resource by Service Assurance systems.
49685 $ref: "#/definitions/relationship"
49689 $ref: "#/definitions/l-interface"
49692 Collection of link aggregate interfaces.
49697 $ref: "#/definitions/lag-interface"
49700 LAG links can connect lag-interfaces
49701 ###### Related Nodes
49702 - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
49703 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
49709 description: Alphabetical concatenation of lag-interface names
49712 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49716 $ref: "#/definitions/relationship"
49719 Collection of link aggregation connections
49724 $ref: "#/definitions/lag-link"
49727 Metadata for license group.
49728 ###### Related Nodes
49729 - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49730 - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
49737 description: Unique ID for the license group the resource belongs to, should be uuid.
49740 description: Unique ID of a license resource.
49743 description: Concurrency value
49747 $ref: "#/definitions/relationship"
49750 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
49755 $ref: "#/definitions/license"
49758 describes a line-of-business
49759 ###### Related Nodes
49760 - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
49762 - line-of-business-name
49764 line-of-business-name:
49766 description: Name of the line-of-business (product)
49769 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49773 $ref: "#/definitions/relationship"
49776 Collection of lines-of-business
49781 $ref: "#/definitions/line-of-business"
49784 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
49785 ###### Related Nodes
49786 - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
49787 - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
49788 - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
49789 - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
49790 - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
49791 - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
49792 - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
49793 - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
49794 - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
49795 - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
49796 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
49797 - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
49798 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
49805 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
49808 description: Type of logical link, e.g., evc
49811 description: Captures the numeric part of the speed
49814 description: Captures the units corresponding to the speed
49817 description: v4, v6, or ds for dual stack
49820 description: For example, static or BGP
49823 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49826 description: the ASDC model id for this resource or service model.
49827 persona-model-version:
49829 description: the ASDC model version for this resource or service model.
49832 description: the ASDC model version for this resource or service model.
49835 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
49836 widget-model-version:
49838 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
49839 operational-status:
49841 description: Indication of operational status of the logical link.
49844 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
49847 description: Indication of the network use of the logical link.
49850 description: Alias or alternate name (CLCI or D1 name).
49853 description: UUID of the logical-link, SDNC generates this.
49856 description: Circuit id
49859 description: Reason for this entity, role it is playing
49863 $ref: "#/definitions/relationship"
49866 Collection of logical connections
49871 $ref: "#/definitions/logical-link"
49874 Collection of metadatum (key/value pairs)
49879 $ref: "#/definitions/metadatum"
49883 ###### Related Nodes
49884 - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
49885 - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
49886 - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
49887 - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
49898 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49901 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
49902 ###### Related Nodes
49903 - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
49904 - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
49905 - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
49906 - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
49907 - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
49908 - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
49909 - MODEL is DELETED when these are DELETED MODEL-VER
49911 - model-invariant-id
49914 model-invariant-id:
49916 description: Unique identifier corresponding to the main definition of a model in ASDC
49919 description: Type of the model, e.g., service, resource, widget, etc.
49922 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49926 $ref: "#/definitions/model-ver"
49930 $ref: "#/definitions/relationship"
49931 model-and-named-query-search:
49933 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
49937 $ref: "#/definitions/query-parameters"
49940 $ref: "#/definitions/instance-filters"
49943 $ref: "#/definitions/secondary-filts"
49946 secondary-filter-cut-point:
49950 This is how we would capture constraints defining allowed sets of elements.
49951 ###### Related Nodes
49952 - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
49953 - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
49954 - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
49956 - model-constraint-uuid
49957 - constrained-element-set-uuid-to-replace
49959 model-constraint-uuid:
49961 constrained-element-set-uuid-to-replace:
49963 constrained-element-sets:
49966 $ref: "#/definitions/constrained-element-set"
49969 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49975 $ref: "#/definitions/model-constraint"
49978 Defines how other models combine to make up a higher-level model.
49979 ###### Related Nodes
49980 - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
49981 - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
49982 - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
49983 - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
49984 - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
49985 - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
49986 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
49987 - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
49989 - model-element-uuid
49990 - new-data-del-flag
49993 model-element-uuid:
49997 description: Indicates whether this element was created as part of instantiation from this model
50000 description: How many of this type of element are required/allowed
50005 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50009 $ref: "#/definitions/model-element"
50010 description: Defines how other models combine to make up a higher-level model
50014 $ref: "#/definitions/model-constraint"
50015 description: Describes new constraints on this model element that are not part of that model's definition
50019 $ref: "#/definitions/relationship"
50025 $ref: "#/definitions/model-element"
50028 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
50029 ###### Related Nodes
50030 - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
50031 - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
50032 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
50033 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
50034 - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
50035 - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
50043 description: Unique identifier corresponding to one version of a model in ASDC
50046 description: Name of the model, which can change from version to version.
50049 description: Version
50052 description: Description
50055 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50059 $ref: "#/definitions/model-element"
50063 $ref: "#/definitions/metadatum"
50067 $ref: "#/definitions/relationship"
50073 $ref: "#/definitions/model-ver"
50076 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
50081 $ref: "#/definitions/model"
50082 multicast-configuration:
50084 ###### Related Nodes
50085 - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
50087 - multicast-configuration-id
50088 - multicast-protocol
50091 multicast-configuration-id:
50093 description: Unique id of multicast configuration.
50094 multicast-protocol:
50096 description: protocol of multicast configuration
50099 description: rp type of multicast configuration
50102 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50106 $ref: "#/definitions/relationship"
50107 multicast-configurations:
50109 multicast configuration of generic-vnf ip-address
50111 multicast-configuration:
50114 $ref: "#/definitions/multicast-configuration"
50120 $ref: "#/definitions/named-query"
50124 ###### Related Nodes
50125 - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
50126 - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
50127 - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
50128 - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
50132 - named-query-version
50138 named-query-version:
50140 required-input-param:
50146 named-query-elements:
50149 $ref: "#/definitions/named-query-element"
50153 $ref: "#/definitions/relationship"
50154 named-query-element:
50157 ###### Related Nodes
50158 - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
50159 - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
50160 - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
50161 - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
50162 - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
50163 - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
50164 - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
50166 - named-query-element-uuid
50168 named-query-element-uuid:
50170 property-collect-list:
50174 property-limit-desc:
50178 named-query-elements:
50181 $ref: "#/definitions/named-query-element"
50185 $ref: "#/definitions/related-lookup"
50186 property-constraints:
50189 $ref: "#/definitions/property-constraint"
50193 $ref: "#/definitions/relationship"
50194 named-query-elements:
50196 named-query-element:
50199 $ref: "#/definitions/named-query-element"
50202 Namespace for network inventory resources.
50207 $ref: "#/definitions/logical-link"
50211 $ref: "#/definitions/site-pair-set"
50215 $ref: "#/definitions/vpn-binding"
50219 $ref: "#/definitions/vpls-pe"
50220 multicast-configurations:
50223 $ref: "#/definitions/multicast-configuration"
50227 $ref: "#/definitions/vce"
50231 $ref: "#/definitions/vnfc"
50235 $ref: "#/definitions/l3-network"
50239 $ref: "#/definitions/network-policy"
50243 $ref: "#/definitions/generic-vnf"
50247 $ref: "#/definitions/lag-link"
50251 $ref: "#/definitions/newvce"
50255 $ref: "#/definitions/pnf"
50259 $ref: "#/definitions/physical-link"
50260 ipsec-configurations:
50263 $ref: "#/definitions/ipsec-configuration"
50264 route-table-references:
50267 $ref: "#/definitions/route-table-reference"
50271 $ref: "#/definitions/instance-group"
50275 $ref: "#/definitions/zone"
50281 $ref: "#/definitions/network-policy"
50284 ###### Related Nodes
50285 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
50287 - network-policy-id
50291 description: UUID representing unique key to this instance
50292 network-policy-fqdn:
50294 description: Contrail FQDN for the policy
50297 description: ID for the openStack Heat instance
50300 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50304 $ref: "#/definitions/relationship"
50307 Network profile populated by SDN-GP for SNMP
50308 ###### Related Nodes
50309 - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
50315 description: Unique name of network profile.
50318 description: Encrypted SNMP community string
50321 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50325 $ref: "#/definitions/relationship"
50328 Collection of network profiles
50333 $ref: "#/definitions/network-profile"
50336 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
50337 ###### Related Nodes
50338 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
50339 - NEWVCE is DELETED when these are DELETED L-INTERFACE
50347 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
50350 description: Name of VNF.
50353 description: Alternate name of VNF.
50356 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
50359 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
50362 description: Indicator for whether the resource is considered operational
50365 description: OBSOLETE - do not use
50368 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
50371 description: Client should send valid enumerated value.
50374 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50375 ipv4-loopback0-address:
50377 description: v4 Loopback0 address
50378 orchestration-status:
50380 description: Orchestration status of this VNF, mastered by MSO.
50383 description: Heat stack id corresponding to this instance, managed by MSO
50386 description: Corresponds to the SDN-C catalog id used to configure this VCE
50390 $ref: "#/definitions/relationship"
50394 $ref: "#/definitions/l-interface"
50397 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
50402 $ref: "#/definitions/newvce"
50403 notification-event:
50407 notification-event-header:
50409 $ref: "#/definitions/notification-event-header"
50410 notification-event-header:
50451 $ref: "#/definitions/key-data"
50456 OAM network, to be deprecated shortly. Do not use for new purposes.
50457 ###### Related Nodes
50458 - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
50459 - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
50460 - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
50468 description: UUID of the network. Unique across a cloud-region
50471 description: Name of the network.
50475 description: cvlan-id
50476 ipv4-oam-gateway-address:
50478 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
50479 ipv4-oam-gateway-address-prefix-length:
50482 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
50485 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50489 $ref: "#/definitions/relationship"
50492 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
50497 $ref: "#/definitions/oam-network"
50498 operational-environment:
50500 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
50501 ###### Related Nodes
50502 - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
50503 - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
50505 - operational-environment-id
50506 - operational-environment-name
50507 - operational-environment-type
50508 - operational-environment-status
50512 operational-environment-id:
50514 description: UUID of an operational environment
50515 operational-environment-name:
50517 description: Operational Environment name
50518 operational-environment-type:
50520 description: Operational Environment Type.
50521 operational-environment-status:
50523 description: Status
50526 description: Tenant Context.
50529 description: Workload Context.
50532 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50536 $ref: "#/definitions/relationship"
50537 operational-environments:
50539 a logical partition of the cloud which allows to have multiple environments in the production AIC.
50541 operational-environment:
50544 $ref: "#/definitions/operational-environment"
50547 Allows for legacy POST of old-style and new-style models
50549 - model-invariant-id
50550 - model-name-version-id
50556 model-invariant-id:
50558 description: Unique identifier corresponding to the main definition of a model in ASDC
50559 model-name-version-id:
50561 description: Unique identifier corresponding to one version of a model in ASDC
50564 description: Type of the model, e.g., service, resource, widget, etc.
50567 description: Name of the model, which can change from version to version.
50570 description: Invariant unique ID which does not change from version to version
50573 description: Version
50576 description: Description
50579 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50582 $ref: "#/definitions/model-vers"
50585 $ref: "#/definitions/relationship-list"
50588 Collection of owning-entities
50593 $ref: "#/definitions/owning-entity"
50596 describes an owning-entity
50597 ###### Related Nodes
50598 - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
50601 - owning-entity-name
50605 description: UUID of an owning entity
50606 owning-entity-name:
50608 description: Owning entity name
50611 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50615 $ref: "#/definitions/relationship"
50618 Physical interface (e.g., nic)
50619 ###### Related Nodes
50620 - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
50621 - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
50622 - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
50623 - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
50624 - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
50625 - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
50626 - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
50627 - P-INTERFACE is DELETED when these are DELETED L-INTERFACE
50628 - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
50634 description: Name that identifies the physical interface
50637 description: Captures the numeric part of the speed
50640 description: Captures the units corresponding to the speed
50643 description: Nature of the services and connectivity on this port.
50644 equipment-identifier:
50646 description: CLEI or other specification for p-interface hardware.
50649 description: Role specification for p-interface hardware.
50652 description: Indicates the physical properties of the interface.
50655 description: Trigger for operational monitoring of this resource by Service Assurance systems.
50658 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50662 $ref: "#/definitions/relationship"
50666 $ref: "#/definitions/l-interface"
50669 Collection of physical interfaces.
50674 $ref: "#/definitions/p-interface"
50677 Collection of physical connections, typically between p-interfaces
50678 ###### Related Nodes
50679 - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
50685 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
50688 description: Captures the numeric part of the speed
50691 description: Captures the units corresponding to the speed
50694 description: Circuit it
50697 description: Dual access mode (e.g., primary, secondary
50700 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
50701 service-provider-name:
50703 description: Name of the service Provider on this link.
50706 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50710 $ref: "#/definitions/relationship"
50713 Collection of physical connections, typically between p-interfaces
50718 $ref: "#/definitions/physical-link"
50721 describes a platform
50722 ###### Related Nodes
50723 - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
50729 description: Name of the platform
50732 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50736 $ref: "#/definitions/relationship"
50739 Collection of platforms
50744 $ref: "#/definitions/platform"
50747 PNF represents a physical network function. typically equipment used in the D1 world.
50748 ###### Related Nodes
50749 - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
50750 - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
50751 - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
50752 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
50753 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
50754 - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
50755 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
50756 - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
50763 description: unique name of Physical Network Function.
50766 description: name of Physical Network Function.
50769 description: source of name2
50772 description: id of pnf
50775 description: Equipment type. Source of truth should define valid values.
50778 description: Equipment vendor. Source of truth should define valid values.
50781 description: Equipment model. Source of truth should define valid values.
50784 description: identifier of managed by company or customer
50787 description: ipv4-oam-address with new naming convention for IP addresses
50790 description: sw-version is the version of SW for the hosted application on the PNF.
50795 description: ID of the physical frame (relay rack) where pnf is installed.
50798 description: Serial number of the device
50799 ipaddress-v4-loopback-0:
50801 description: IPV4 Loopback 0 address
50802 ipaddress-v6-loopback-0:
50804 description: IPV6 Loopback 0 address
50807 description: IPV4 AIM address
50810 description: IPV6 AIM address
50813 description: IPV6 OAM address
50816 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
50819 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50822 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
50825 description: Nf Role is the role performed by this instance in the network.
50829 $ref: "#/definitions/relationship"
50833 $ref: "#/definitions/p-interface"
50837 $ref: "#/definitions/lag-interface"
50840 Collection of Physical Network Functions.
50845 $ref: "#/definitions/pnf"
50848 Used to capture the network interfaces of this VCE
50849 ###### Related Nodes
50850 - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
50851 - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
50852 - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
50855 - orchestration-status
50859 description: Unique ID of the interface
50860 neutron-network-id:
50862 description: Neutron network id of this Interface
50863 neutron-network-name:
50865 description: Neutron network name of this Interface
50868 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50871 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50874 description: Unique ID for port group in vmware
50877 description: Likely to duplicate value of neutron network name
50880 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
50881 orchestration-status:
50883 description: Orchestration status of this VNF, mastered by MSO
50886 description: Heat stack id corresponding to this instance, managed by MSO
50889 description: Corresponds to the SDN-C catalog id used to configure this VCE
50893 $ref: "#/definitions/cvlan-tag-entry"
50897 $ref: "#/definitions/relationship"
50903 $ref: "#/definitions/port-group"
50906 describes the project
50907 ###### Related Nodes
50908 - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
50914 description: Name of the project deploying a service
50917 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
50921 $ref: "#/definitions/relationship"
50924 Collection of projects
50929 $ref: "#/definitions/project"
50932 Property holder for query properties or instance properties
50938 property-constraint:
50941 ###### Related Nodes
50942 - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
50944 - property-constraint-uuid
50949 property-constraint-uuid:
50959 property-constraints:
50961 property-constraint:
50964 $ref: "#/definitions/property-constraint"
50967 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
50968 ###### Related Nodes
50969 - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
50970 - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
50971 - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
50972 - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
50973 - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
50974 - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
50975 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
50976 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
50977 - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
50978 - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
50979 - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
50980 - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
50981 - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
50988 description: Value from executing hostname on the compute node.
50991 description: PTNII name
50995 description: Number of cpus
50999 description: Disk size, in GBs
51003 description: RAM size, in MBs
51006 description: Equipment type. Source of truth should define valid values.
51009 description: Equipment vendor. Source of truth should define valid values.
51012 description: Equipment model. Source of truth should define valid values.
51015 description: Fully-qualified domain name
51018 description: URL to endpoint where AAI can get more details
51021 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
51024 description: Serial number, may be queried
51025 ipaddress-v4-loopback-0:
51027 description: IPV4 Loopback 0 address
51028 ipaddress-v6-loopback-0:
51030 description: IPV6 Loopback 0 address
51033 description: IPV4 AIM address
51036 description: IPV6 AIM address
51039 description: IPV6 OAM address
51042 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
51045 description: ID of Pserver
51048 description: internet topology of Pserver
51053 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51056 description: alternative pserver name
51059 description: purpose of pserver
51062 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
51066 $ref: "#/definitions/relationship"
51070 $ref: "#/definitions/p-interface"
51074 $ref: "#/definitions/lag-interface"
51077 Collection of compute hosts.
51082 $ref: "#/definitions/pserver"
51085 QueryParameters for performing a named-query or model query
51089 $ref: "#/definitions/named-query"
51092 $ref: "#/definitions/overloaded-model"
51096 ###### Related Nodes
51097 - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
51099 - related-lookup-uuid
51101 - source-node-property
51103 - target-node-property
51105 related-lookup-uuid:
51109 source-node-property:
51113 target-node-property:
51115 property-collect-list:
51122 $ref: "#/definitions/relationship"
51128 $ref: "#/definitions/related-lookup"
51129 related-to-property:
51133 description: Key part of a key/value pair
51136 description: Value part of a key/value pair
51141 description: A keyword provided by A&AI to indicate type of node.
51144 description: URL to the object in A&AI.
51148 $ref: "#/definitions/relationship-data"
51152 - relationship-value
51156 description: A keyword provided by A&AI to indicate an attribute.
51157 relationship-value:
51159 description: Value of the attribute.
51165 $ref: "#/definitions/relationship"
51166 reserved-prop-names:
51168 Internal map to define some reserved properties of a vertex
51170 last-mod-source-of-truth:
51188 Response container for the results of a named-query or model query
51190 inventory-response-items:
51192 $ref: "#/definitions/inventory-response-items"
51197 description: The specific type of node in the A&AI graph
51200 description: The URL to the specific resource
51201 route-table-reference:
51203 Openstack route table reference.
51204 ###### Related Nodes
51205 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
51207 - route-table-reference-id
51208 - route-table-reference-fqdn
51210 route-table-reference-id:
51212 description: Route Table Reference id, UUID assigned to this instance.
51213 route-table-reference-fqdn:
51215 description: FQDN entry in the route table.
51218 description: Concurrency value
51222 $ref: "#/definitions/relationship"
51223 route-table-references:
51225 Collection of openstack route table references
51227 route-table-reference:
51230 $ref: "#/definitions/route-table-reference"
51233 Route target information
51234 ###### Related Nodes
51235 - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
51237 - global-route-target
51238 - route-target-role
51240 global-route-target:
51242 description: Number used to identify an RT, globally unique in the network
51245 description: Role assigned to this route target
51248 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51252 $ref: "#/definitions/relationship"
51255 Collection of route target information
51260 $ref: "#/definitions/route-target"
51263 ###### Related Nodes
51264 - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
51265 - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
51266 - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
51268 - routing-instance-id
51270 routing-instance-id:
51272 description: Unique id of routing instance
51275 description: rpm owner
51278 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51282 $ref: "#/definitions/site-pair"
51286 $ref: "#/definitions/relationship"
51289 set of probes related to generic-vnf routing instance
51294 $ref: "#/definitions/routing-instance"
51299 $ref: "#/definitions/oam-networks"
51300 az-and-dvs-switches:
51303 $ref: "#/definitions/az-and-dvs-switches"
51306 edge-tag-query-result:
51308 $ref: "#/definitions/edge-tag-query-result"
51309 edge-tag-query-request:
51311 $ref: "#/definitions/edge-tag-query-request"
51314 $ref: "#/definitions/search-results"
51317 $ref: "#/definitions/sdn-zone-response"
51323 $ref: "#/definitions/result-data"
51326 SecondaryFilt for performing a named-query or model query
51337 SecondaryFilts for performing a named-query or model query
51342 $ref: "#/definitions/secondary-filt"
51343 segmentation-assignment:
51345 Openstack segmentation assignment.
51346 ###### Related Nodes
51347 - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
51353 description: Route Table Reference id, UUID assigned to this instance.
51356 description: Concurrency value
51360 $ref: "#/definitions/relationship"
51361 segmentation-assignments:
51363 Collection of openstack segmentation assignments
51365 segmentation-assignment:
51368 $ref: "#/definitions/segmentation-assignment"
51371 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
51374 - service-description
51378 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
51379 service-description:
51381 description: Description of the service
51384 description: URL to endpoint where AAI can get more details
51387 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51390 description: service version
51394 $ref: "#/definitions/relationship"
51395 service-capabilities:
51397 Collection of service capabilities.
51399 service-capability:
51402 $ref: "#/definitions/service-capability"
51403 service-capability:
51405 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
51406 ###### Related Nodes
51407 - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
51408 - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
51409 - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
51416 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
51419 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
51422 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51426 $ref: "#/definitions/relationship"
51427 service-design-and-creation:
51429 Namespace for objects managed by ASDC
51434 $ref: "#/definitions/vnf-image"
51438 $ref: "#/definitions/service"
51439 service-capabilities:
51442 $ref: "#/definitions/service-capability"
51446 $ref: "#/definitions/model"
51450 $ref: "#/definitions/named-query"
51453 Instance of a service
51454 ###### Related Nodes
51455 - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
51456 - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
51457 - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
51458 - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
51459 - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
51460 - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
51461 - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
51462 - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
51463 - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
51464 - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
51465 - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
51466 - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
51467 - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
51468 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
51469 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
51470 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
51471 - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM
51472 - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
51474 - service-instance-id
51476 service-instance-id:
51478 description: Uniquely identifies this instance of a service
51479 service-instance-name:
51481 description: This field will store a name assigned to the service-instance.
51484 description: the ASDC model id for this resource or service model.
51485 persona-model-version:
51487 description: the ASDC model version for this resource or service model.
51490 description: the ASDC model version for this resource or service model.
51493 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
51494 widget-model-version:
51496 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
51499 description: Indicates the total bandwidth to be used for this service.
51502 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
51503 bandwidth-down-wan1:
51505 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
51508 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
51509 bandwidth-down-wan2:
51511 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
51514 description: URL customers will use to access the vHN Portal.
51515 service-instance-location-id:
51517 description: An identifier that customers assign to the location where this service is being used.
51520 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51523 description: Path to the controller object.
51524 orchestration-status:
51526 description: Orchestration status of this service.
51530 $ref: "#/definitions/relationship"
51534 $ref: "#/definitions/metadatum"
51535 allotted-resources:
51538 $ref: "#/definitions/allotted-resource"
51541 Collection of service instances
51546 $ref: "#/definitions/service-instance"
51547 service-subscription:
51549 Object that group service instances.
51550 ###### Related Nodes
51551 - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
51552 - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
51553 - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
51554 - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
51560 description: Value defined by orchestration to identify this service across ECOMP.
51561 temp-ub-sub-account-id:
51563 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
51566 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51570 $ref: "#/definitions/service-instance"
51574 $ref: "#/definitions/relationship"
51575 service-subscriptions:
51577 Collection of objects that group service instances.
51579 service-subscription:
51582 $ref: "#/definitions/service-subscription"
51585 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
51590 $ref: "#/definitions/service"
51593 ###### Related Nodes
51594 - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
51595 - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
51596 - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
51602 description: unique identifier of probe
51605 description: Prefix address
51608 description: Prefix address
51611 description: ip version, v4, v6
51612 destination-hostname:
51614 description: Hostname of the destination equipment to which SLAs are measured against.
51615 destination-equip-type:
51617 description: The type of destinatination equipment. Could be Router, etc.
51620 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51621 classes-of-service:
51624 $ref: "#/definitions/class-of-service"
51628 $ref: "#/definitions/relationship"
51631 Set of instances for probes used to measure service level agreements
51632 ###### Related Nodes
51633 - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
51634 - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
51635 - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
51641 description: Unique id of site pair set.
51644 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51648 $ref: "#/definitions/routing-instance"
51652 $ref: "#/definitions/relationship"
51655 Collection of sets of instances for probes related to generic-vnf
51660 $ref: "#/definitions/site-pair-set"
51668 $ref: "#/definitions/site-pair"
51672 ###### Related Nodes
51673 - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
51674 - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
51680 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
51683 description: Snapshot name
51684 snapshot-architecture:
51686 description: Operating system architecture
51687 snapshot-os-distro:
51689 description: The common name of the operating system distribution in lowercase
51690 snapshot-os-version:
51692 description: The operating system version as specified by the distributor.
51695 description: The application that the image instantiates.
51696 application-vendor:
51698 description: The vendor of the application.
51699 application-version:
51701 description: The version of the application.
51704 description: URL to endpoint where AAI can get more details
51707 description: This field contains the UUID of the previous snapshot (if any).
51710 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51714 $ref: "#/definitions/relationship"
51717 Collection of openstack snapshots
51722 $ref: "#/definitions/snapshot"
51725 SR-IOV Physical Function
51726 ###### Related Nodes
51727 - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
51728 - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
51734 description: Identifier for the sriov-pf
51737 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51741 $ref: "#/definitions/relationship"
51744 Collection of SR-IOV Physical Functions.
51749 $ref: "#/definitions/sriov-pf"
51752 SR-IOV Virtual Function (not to be confused with virtual network function)
51753 ###### Related Nodes
51754 - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
51760 description: PCI ID used to identify the sriov-vf
51763 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
51766 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
51769 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
51770 vf-vlan-anti-spoof-check:
51772 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.
51773 vf-mac-anti-spoof-check:
51775 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.
51778 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
51779 vf-broadcast-allow:
51781 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
51782 vf-unknown-multicast-allow:
51784 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
51785 vf-unknown-unicast-allow:
51787 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
51790 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
51793 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
51796 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51797 neutron-network-id:
51799 description: Neutron network id of the interface
51803 $ref: "#/definitions/relationship"
51806 Collection of SR-IOV Virtual Functions.
51811 $ref: "#/definitions/sriov-vf"
51820 ###### Related Nodes
51821 - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
51822 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
51823 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
51824 - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
51831 description: Subnet ID, should be UUID.
51834 description: Name associated with the subnet.
51837 description: Neutron id of this subnet
51840 description: gateway ip address
51841 network-start-address:
51843 description: network start address
51846 description: cidr mask
51849 description: ip version
51850 orchestration-status:
51852 description: Orchestration status of this VNF, mastered by MSO
51857 description: the start address reserved for use by dhcp
51860 description: the last address reserved for use by dhcp
51863 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51867 $ref: "#/definitions/relationship"
51873 $ref: "#/definitions/subnet"
51874 tagged-inventory-item-list:
51879 $ref: "#/definitions/inventory-item"
51883 ###### Related Nodes
51884 - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
51885 - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
51886 - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
51887 - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
51888 - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
51889 - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
51890 - TENANT cannot be deleted if linked to VSERVER
51897 description: Unique id relative to the cloud-region.
51900 description: Readable name of tenant
51903 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
51907 $ref: "#/definitions/vserver"
51911 $ref: "#/definitions/relationship"
51914 Collection of openstack tenants.
51919 $ref: "#/definitions/tenant"
51922 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
51923 ###### Related Nodes
51924 - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
51927 - bandwidth-up-wan1
51928 - bandwidth-down-wan1
51929 - bandwidth-up-wan2
51930 - bandwidth-down-wan2
51934 description: Allotted Resource id UUID assigned to this instance.
51937 description: The WAN uplink bandwidth for WAN1
51938 bandwidth-down-wan1:
51940 description: The WAN downlink bandwidth for WAN1
51943 description: The WAN uplink bandwidth for WAN2
51944 bandwidth-down-wan2:
51946 description: The WAN downlink bandwidth for WAN2
51949 description: Concurrency value
51953 $ref: "#/definitions/relationship"
51956 This object is used to store the specific tunnel cross connect aspects of an allotted resource
51961 $ref: "#/definitions/tunnel-xconnect"
51964 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
51973 $ref: "#/definitions/update-node-key"
51979 $ref: "#/definitions/action"
51988 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
51989 ###### Related Nodes
51990 - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
51991 - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
51992 - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
51993 - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
51994 - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
51995 - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
51996 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
51997 - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
52005 description: Unique id of VNF. This is unique across the graph.
52008 description: Name of VNF.
52011 description: Alternate name of VNF.
52014 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
52017 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
52018 regional-resource-zone:
52020 description: Regional way of organizing pservers, source of truth should define values
52023 description: Trigger for operational monitoring of this resource by Service Assurance systems.
52026 description: Indicator for whether the resource is considered operational
52029 description: OBSOLETE - do not use
52032 description: Network role being played by this VNF
52033 orchestration-status:
52035 description: Orchestration status of this VNF, mastered by MSO
52038 description: Heat stack id corresponding to this instance, managed by MSO
52041 description: Corresponds to the SDN-C catalog id used to configure this VCE
52044 description: Unique ID of VPE connected to this VCE.
52045 v6-vce-wan-address:
52047 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
52050 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
52053 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52054 ipv4-loopback0-address:
52056 description: Loopback0 address
52057 entitlement-resource-uuid:
52059 description: OBSOLETE - see child relationships
52063 $ref: "#/definitions/port-group"
52067 $ref: "#/definitions/license"
52071 $ref: "#/definitions/entitlement"
52075 $ref: "#/definitions/relationship"
52078 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
52083 $ref: "#/definitions/vce"
52086 a deployment unit of VNFCs
52087 ###### Related Nodes
52088 - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
52089 - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
52090 - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
52091 - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
52092 - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
52093 - VF-MODULE cannot be deleted if linked to VNFC
52096 - is-base-vf-module
52100 description: Unique ID of vf-module.
52103 description: Name of vf-module
52106 description: Heat stack id corresponding to this instance.
52107 orchestration-status:
52109 description: orchestration status of this vf-module, mastered by MSO
52114 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52117 description: the ASDC model id for this resource or service model.
52118 persona-model-version:
52120 description: the ASDC model version for this resource or service model.
52123 description: the ASDC model version for this resource or service model.
52124 persona-model-customization-id:
52126 description: captures the id of all the configuration used to customize the resource for the service.
52129 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
52130 widget-model-version:
52132 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
52133 contrail-service-instance-fqdn:
52135 description: the Contrail unique ID for a service-instance
52139 description: the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit
52142 description: Path to the controller object.
52146 $ref: "#/definitions/relationship"
52149 Collection of vf-modules, a deployment unit of VNFCs
52154 $ref: "#/definitions/vf-module"
52157 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
52158 ###### Related Nodes
52159 - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
52165 description: indicates whether the VIG is for AVPN or INTERNET
52168 description: v4 IP of the vig server
52171 description: v6 IP of the vig server
52174 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52178 $ref: "#/definitions/relationship"
52184 $ref: "#/definitions/vig-server"
52185 vip-ipv4-address-list:
52188 ###### Related Nodes
52189 - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52190 - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
52191 - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
52192 - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
52198 description: IP address
52199 vip-ipv4-prefix-length:
52202 description: Prefix length, 32 for single address
52206 description: Inner VLAN tag
52210 description: Outer VLAN tag
52213 description: Indicator of fixed or floating address
52216 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52217 neutron-network-id:
52219 description: Neutron network id of the interface that address belongs to
52222 description: Neutron id of subnet that address belongs to
52226 $ref: "#/definitions/relationship"
52227 vip-ipv6-address-list:
52230 ###### Related Nodes
52231 - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52232 - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
52233 - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
52234 - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
52240 description: IP address
52241 vip-ipv6-prefix-length:
52244 description: Prefix length, 128 for single address
52248 description: Inner VLAN tag
52252 description: Outer VLAN tag
52255 description: Indicator of fixed or floating address
52258 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52259 neutron-network-id:
52261 description: Neutron network id of the interface that address belongs to
52264 description: Neutron id of subnet that address belongs to
52268 $ref: "#/definitions/relationship"
52269 virtual-data-center:
52271 Virtual organization of cloud infrastructure elements in a data center context
52272 ###### Related Nodes
52273 - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
52274 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
52275 - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
52282 description: Unique ID of the vdc
52285 description: Name of the virtual data center
52288 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52292 $ref: "#/definitions/relationship"
52293 virtual-data-centers:
52295 Virtual organization of cloud infrastructure elements in a data center context
52297 virtual-data-center:
52300 $ref: "#/definitions/virtual-data-center"
52304 ###### Related Nodes
52305 - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
52306 - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
52307 - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
52308 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
52309 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
52310 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
52311 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
52312 - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
52313 - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
52319 description: String that identifies the interface
52323 description: Inner VLAN tag
52327 description: Outer VLAN tag
52330 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52333 description: Captures the numeric part of the speed
52336 description: Captures the units corresponding to the speed
52339 description: Used to describe (the service associated with) the vlan
52340 backdoor-connection:
52342 description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
52345 description: This indicates the customers VPN ID associated with this vlan
52346 orchestration-status:
52348 description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
52352 $ref: "#/definitions/relationship"
52353 l3-interface-ipv4-address-list:
52356 $ref: "#/definitions/l3-interface-ipv4-address-list"
52357 l3-interface-ipv6-address-list:
52360 $ref: "#/definitions/l3-interface-ipv6-address-list"
52366 $ref: "#/definitions/vlan"
52375 description: Unique id of VNF. This is unique across the graph.
52378 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
52379 ###### Related Nodes
52380 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
52381 - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
52385 - application-vendor
52389 description: Unique ID of this asset
52392 description: The application that the image instantiates.
52393 application-vendor:
52395 description: The vendor of the application.
52396 application-version:
52398 description: The version of the application.
52401 description: URL to endpoint where AAI can get more details
52404 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52408 $ref: "#/definitions/relationship"
52411 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
52416 $ref: "#/definitions/vnf-image"
52419 ###### Related Nodes
52420 - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
52421 - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
52422 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
52425 - vnfc-function-code
52428 - is-closed-loop-disabled
52432 description: Unique ID of vnfc.
52433 vnfc-function-code:
52435 description: function code
52441 description: prov status of this vnfc
52442 orchestration-status:
52444 description: Orchestration status of this VNF, mastered by APP-C
52445 ipaddress-v4-oam-vip:
52447 description: Oam V4 vip address of this vnfc
52450 is-closed-loop-disabled:
52454 description: Group notation of VNFC
52457 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52461 $ref: "#/definitions/relationship"
52464 virtual network components associated with a vserver from application controller.
52469 $ref: "#/definitions/vnfc"
52472 Ephemeral Block storage volume.
52473 ###### Related Nodes
52474 - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
52481 description: Unique ID of block storage volume relative to the vserver.
52484 description: URL to endpoint where AAI can get more details
52487 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52491 $ref: "#/definitions/relationship"
52494 Persistent block-level storage.
52495 ###### Related Nodes
52496 - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52497 - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52498 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
52499 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
52500 - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
52503 - volume-group-name
52508 description: Unique ID of volume-group.
52511 description: Name of the volume group.
52514 description: Heat stack id corresponding to this volume-group
52517 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
52518 orchestration-status:
52520 description: Orchestration status of this volume-group
52521 persona-model-customization-id:
52523 description: captures the id of all the configuration used to customize the resource for the service.
52524 vf-module-persona-model-customization-id:
52526 description: helps relate the volume group to the vf-module whose components will require the volume group
52529 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52533 $ref: "#/definitions/relationship"
52536 Collection of persistent block-level storage.
52541 $ref: "#/definitions/volume-group"
52544 Collection of ephemeral Block storage volumes.
52549 $ref: "#/definitions/volume"
52552 VPLS Provider Edge routers.
52553 ###### Related Nodes
52554 - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52555 - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
52556 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
52557 - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
52558 - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
52566 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
52569 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
52572 description: Client should send valid enumerated value, e.g., VPLS-PE.
52576 description: Temporary location for stag to get to VCE
52579 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52583 $ref: "#/definitions/relationship"
52587 $ref: "#/definitions/p-interface"
52591 $ref: "#/definitions/lag-interface"
52594 Collection of VPLS Provider Edge routers
52599 $ref: "#/definitions/vpls-pe"
52603 ###### Related Nodes
52604 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
52605 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
52606 - VPN-BINDING cannot be deleted if linked to L3-NETWORK,LOGICAL-LINK
52610 - global-route-target
52611 - route-target-role
52615 description: VPN ID, globally unique within A&AI
52618 description: VPN Name
52619 global-route-target:
52621 description: Number used to identify a VPN, globally unique in the network
52624 description: the platform associated with the VPN example AVPN, Mobility
52627 description: Type of the vpn, should be taken from enumerated/valid values
52628 route-distinguisher:
52630 description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
52633 description: Role assigned to this route target
52636 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52640 $ref: "#/definitions/relationship"
52641 description: l3-networks relate to vpn-bindings
52647 $ref: "#/definitions/vpn-binding"
52650 Virtual Servers, aka virtual machine or VM.
52651 ###### Related Nodes
52652 - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
52653 - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
52654 - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
52655 - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
52656 - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
52657 - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
52658 - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
52659 - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
52660 - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
52661 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
52662 - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
52663 - VSERVER is DELETED when these are DELETED L-INTERFACE
52664 - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
52670 - is-closed-loop-disabled
52674 description: Unique identifier for this vserver relative to its tenant
52677 description: Name of vserver
52680 description: Alternative name of vserver
52683 description: Trigger for operational monitoring of this resource by Service Assurance systems.
52686 description: URL to endpoint where AAI can get more details
52689 is-closed-loop-disabled:
52693 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
52697 $ref: "#/definitions/volume"
52701 $ref: "#/definitions/relationship"
52705 $ref: "#/definitions/l-interface"
52708 Collection of virtual Servers, aka virtual machines or VMs.
52713 $ref: "#/definitions/vserver"
52716 A zone is a grouping of assets in a location homing to the same connections into the CBB
52717 ###### Related Nodes
52718 - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52719 - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
52720 - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
52721 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
52730 description: Code assigned by AIC to the zone
52733 description: English name associated with the zone
52736 description: Design of zone [Medium/Large?]
52739 description: Context of zone [production/test]
52742 description: Status of a zone.
52745 description: Concurrency value
52749 $ref: "#/definitions/relationship"
52752 Collection of zones
52757 $ref: "#/definitions/zone"
52772 $ref: "#/patchDefinitions/action-data"
52781 APIs that are more action related than REST (e.g., notify, update).
52785 $ref: "#/patchDefinitions/update"
52788 $ref: "#/patchDefinitions/notify"
52791 Represents a slice or partial piece of a resource that gets separately allotted
52792 ###### Related Nodes
52793 - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
52794 - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
52795 - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
52796 - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
52797 - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
52798 - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
52799 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
52800 - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
52806 description: Allotted Resource id UUID assigned to this instance.
52809 description: The descriptive information assigned to this allotted resource instance
52812 description: Link back to more information in the controller
52815 description: the ASDC model id for this resource or service model.
52816 persona-model-version:
52818 description: the ASDC model version for this resource or service model.
52821 description: the ASDC model version for this resource or service model.
52822 persona-model-customization-id:
52824 description: captures the id of all the configuration used to customize the resource for the service.
52825 allotted-resources:
52827 This object is used to store slices of services being offered
52832 $ref: "#/patchDefinitions/allotted-resource"
52835 Availability zone, a collection of compute hosts/pservers
52836 ###### Related Nodes
52837 - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52838 - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
52839 - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52840 - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
52841 - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
52842 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
52843 - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
52844 - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
52845 - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
52847 - availability-zone-name
52850 availability-zone-name:
52852 description: Name of the availability zone. Unique across a cloud region
52855 description: Type of hypervisor. Source of truth should define valid values.
52858 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
52859 availability-zones:
52861 Collection of availability zones
52866 $ref: "#/patchDefinitions/availability-zone"
52867 az-and-dvs-switches:
52871 $ref: "#/patchDefinitions/dvs-switches"
52874 $ref: "#/patchDefinitions/availability-zone"
52877 Namespace for business related constructs
52882 $ref: "#/patchDefinitions/connector"
52886 $ref: "#/patchDefinitions/customer"
52889 ###### Related Nodes
52890 - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
52896 description: unique identifier of probe
52899 description: identifier of probe
52902 description: type of probe
52903 classes-of-service:
52905 class-of-service of probe
52910 $ref: "#/patchDefinitions/class-of-service"
52911 cloud-infrastructure:
52913 Namespace for cloud infrastructure.
52918 $ref: "#/patchDefinitions/complex"
52922 $ref: "#/patchDefinitions/cloud-region"
52926 $ref: "#/patchDefinitions/network-profile"
52930 $ref: "#/patchDefinitions/pserver"
52931 virtual-data-centers:
52934 $ref: "#/patchDefinitions/virtual-data-center"
52937 cloud-region designates an installation of a cloud cluster or region or instantiation.
52938 ###### Related Nodes
52939 - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52940 - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
52941 - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
52942 - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52943 - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52944 - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52945 - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52946 - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52947 - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52948 - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52949 - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52950 - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52951 - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
52952 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
52953 - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
52954 - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
52961 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
52964 description: Identifier used by the vendor for the region. Second part of composite key
52967 description: Type of the cloud (e.g., openstack)
52968 owner-defined-type:
52970 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
52971 cloud-region-version:
52973 description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
52976 description: URL of the keystone identity service
52979 description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
52982 description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
52988 $ref: "#/patchDefinitions/cloud-region"
52991 Collection of physical locations that can house cloud-regions.
52992 ###### Related Nodes
52993 - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
52994 - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52995 - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52996 - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
52997 - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
52998 - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52999 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53000 - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
53001 - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53002 - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53003 - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53004 - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
53005 - COMPLEX is DELETED when these are DELETED CTAG-POOL
53007 - physical-location-id
53008 - physical-location-type
53015 physical-location-id:
53017 description: Unique identifier for physical location, e.g., CLLI
53020 description: Data center code which can be an alternate way to identify a complex
53023 description: Gamma complex name for LCP instance.
53026 description: URL of the keystone identity service
53029 Collection of physical locations that can house cloud-regions.
53034 $ref: "#/patchDefinitions/complex"
53037 Port Mirror Configuration.
53038 ###### Related Nodes
53039 - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
53040 - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
53041 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
53042 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
53043 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
53044 - CONFIGURATION is DELETED when these are DELETED METADATUM
53045 - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
53048 - configuration-type
53049 - configuration-sub-type
53050 - orchestration-status
53051 - operational-status
53052 - configuration-selflink
53053 - model-customization-id
53057 description: UUID assigned to configuration.
53060 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
53061 configuration-name:
53063 description: Name of the configuration.
53064 configuration-type:
53066 description: port-mirroring-configuration.
53067 configuration-sub-type:
53069 description: vprobe, pprobe.
53070 model-invariant-id:
53072 description: the ASDC model id for this resource or service model.
53075 description: the ASDC model version for this resource or service model.
53076 orchestration-status:
53078 description: Orchestration status of the configuration.
53079 operational-status:
53081 description: Indicator for whether the resource is considered operational.
53082 configuration-selflink:
53084 description: URL to endpoint where AAI can get more details from SDN-GC.
53085 model-customization-id:
53087 description: id of the configuration used to customize the resource
53090 Collection of configurations
53095 $ref: "#/patchDefinitions/configuration"
53098 Collection of resource instances used to connect a variety of disparate inventory widgets
53099 ###### Related Nodes
53100 - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
53101 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
53102 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
53103 - CONNECTOR is DELETED when these are DELETED METADATUM
53105 - resource-instance-id
53107 resource-instance-id:
53109 description: Unique id of resource instance.
53112 Collection of resource instances used to connect a variety of disparate inventory widgets
53117 $ref: "#/patchDefinitions/connector"
53118 constrained-element-set:
53120 This is how we would capture constraints defining allowed sets of elements.
53121 ###### Related Nodes
53122 - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
53123 - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
53124 - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
53125 - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
53127 - constrained-element-set-uuid
53131 constrained-element-set-uuid:
53137 constrained-element-sets:
53139 constrained-element-set:
53142 $ref: "#/patchDefinitions/constrained-element-set"
53145 ###### Related Nodes
53146 - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
53147 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
53160 $ref: "#/patchDefinitions/ctag-assignment"
53163 A collection of C tags (vlan tags) grouped for a specific purpose.
53164 ###### Related Nodes
53165 - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
53166 - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
53167 - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
53170 - availability-zone-name
53171 - ctag-pool-purpose
53175 description: The Target provider edge router
53176 availability-zone-name:
53178 description: Name of the availability zone
53181 description: Describes what the intended purpose of this pool is.
53184 description: Comma separated list of ctags
53190 $ref: "#/patchDefinitions/ctag-pool"
53193 customer identifiers to provide linkage back to BSS information.
53194 ###### Related Nodes
53195 - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
53196 - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
53198 - global-customer-id
53202 global-customer-id:
53204 description: Global customer id used across ECOMP to uniquely identify customer.
53207 description: Subscriber name, an alternate way to retrieve a customer.
53210 description: Subscriber type, a way to provide VID with only the INFRA customers.
53213 Collection of customer identifiers to provide linkage back to BSS information.
53218 $ref: "#/patchDefinitions/customer"
53226 description: See mis-na-virtualization-platform.yang
53232 $ref: "#/patchDefinitions/cvlan-tag-entry"
53235 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.
53236 ###### Related Nodes
53237 - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53238 - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
53245 description: DVS switch name
53248 description: URL used to reach the vcenter
53251 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
53256 $ref: "#/patchDefinitions/dvs-switch"
53259 Internal map to define the properties of an edge and interpret the map EdgeRules
53277 edge-tag-query-request:
53288 $ref: "#/patchDefinitions/start-node-filter"
53289 include-node-filter:
53292 $ref: "#/patchDefinitions/include-node-filter"
53296 $ref: "#/patchDefinitions/secondary-filter"
53297 edge-tag-query-result:
53299 tagged-inventory-item-list:
53302 $ref: "#/patchDefinitions/tagged-inventory-item-list"
53303 element-choice-set:
53305 This is how we would capture constraints defining allowed sets of elements.
53306 ###### Related Nodes
53307 - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
53308 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
53309 - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
53311 - element-choice-set-uuid
53312 - element-choice-set-name
53314 element-choice-set-uuid:
53316 element-choice-set-name:
53320 element-choice-sets:
53322 element-choice-set:
53325 $ref: "#/patchDefinitions/element-choice-set"
53328 Metadata for entitlement group.
53329 ###### Related Nodes
53330 - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53331 - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
53338 description: Unique ID for the entitlement group the resource comes from, should be uuid.
53341 description: Unique ID of an entitlement resource.
53344 Entitlements, keyed by group-uuid and resource-uuid, related to license management
53349 $ref: "#/patchDefinitions/entitlement"
53352 Persist EMS address information used by EMS driver.
53353 ###### Related Nodes
53354 - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
53355 - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
53361 description: Unique ID of EMS.
53367 $ref: "#/patchDefinitions/esr-ems"
53370 Persist common address information of external systems.
53371 ###### Related Nodes
53372 - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
53373 - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
53374 - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
53375 - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
53377 - esr-system-info-id
53382 esr-system-info-id:
53384 description: Unique ID of esr system info.
53387 description: name of external system.
53390 description: type of external systems.
53393 description: vendor of external systems.
53396 description: version of external systems.
53399 description: url used to access external systems.
53402 description: username used to access external systems.
53405 description: password used to access external systems.
53408 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
53411 description: protocol of third party SDNC, for example netconf/snmp.
53414 description: ca file content if enabled ssl on auth-url.
53417 description: Whether to verify VIM's certificate.
53420 description: service IP of ftp server.
53423 description: service port of ftp server.
53426 description: domain info for authentication.
53429 description: default tenant of VIM.
53432 description: ftp passive mode or not.
53435 description: resource or performance data file path.
53438 description: the status of external system.
53439 esr-system-info-list:
53441 Collection of persistent block-level external system auth info.
53446 $ref: "#/patchDefinitions/esr-system-info"
53447 esr-thirdparty-sdnc:
53449 Persist SDNC address information used by ONAP SDNC.
53450 ###### Related Nodes
53451 - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
53452 - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
53453 - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
53455 - thirdparty-sdnc-id
53457 thirdparty-sdnc-id:
53459 description: Unique ID of SDNC.
53462 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
53465 description: password used to access SDNC server.
53466 esr-thirdparty-sdnc-list:
53468 esr-thirdparty-sdnc:
53471 $ref: "#/patchDefinitions/esr-thirdparty-sdnc"
53474 Persist VNFM address information used by VF-C.
53475 ###### Related Nodes
53476 - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
53477 - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
53483 description: Unique ID of VNFM.
53486 description: indecate the VIM to deploy VNF.
53489 description: certificate url of VNFM.
53495 $ref: "#/patchDefinitions/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
53551 $ref: "#/patchDefinitions/evc"
53554 Namespace for external system.
53558 $ref: "#/patchDefinitions/esr-ems-list"
53561 $ref: "#/patchDefinitions/esr-vnfm-list"
53562 esr-thirdparty-sdnc-list:
53564 $ref: "#/patchDefinitions/esr-thirdparty-sdnc-list"
53567 Extra properties for inventory item for response list
53575 ###### Related Nodes
53576 - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53577 - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
53578 - FLAVOR cannot be deleted if linked to VSERVER
53586 description: Flavor id, expected to be unique across cloud-region.
53589 description: Flavor name
53593 description: Number of CPUs
53597 description: Amount of memory
53601 description: Disk space
53605 description: Amount of ephemeral disk space
53608 description: amount of swap space allocation
53611 description: whether flavor is available to all users or private to the tenant it was created in.
53614 description: URL to endpoint where AAI can get more details
53617 description: Boolean as to whether this flavor is no longer enabled
53620 Collection of openstack flavors.
53625 $ref: "#/patchDefinitions/flavor"
53628 Entity describing a sequenced segment of forwarding path
53629 ###### Related Nodes
53630 - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
53631 - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
53632 - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
53633 - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
53634 - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
53635 - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
53642 description: Unique ID of this segmentation
53645 description: ingress, intermediate, egress
53648 forwarder object is an optional child object of the Configuration object.
53649 ###### Related Nodes
53650 - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
53656 description: Key for forwarder-evc object
53659 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
53662 description: Internal VLAN.
53665 description: SVLAN value for ingress of egress forwarder.
53668 description: CVLAN value for ingress of egress forwarder.
53674 $ref: "#/patchDefinitions/forwarder-evc"
53680 $ref: "#/patchDefinitions/forwarder"
53683 Entity that describes the sequenced forwarding path between interfaces of services or resources
53684 ###### Related Nodes
53685 - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
53686 - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
53687 - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
53688 - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
53689 - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
53691 - forwarding-path-id
53692 - forwarding-path-name
53694 forwarding-path-id:
53696 description: Unique ID of this FP
53697 forwarding-path-name:
53699 description: Name of the FP
53705 $ref: "#/patchDefinitions/forwarding-path"
53708 General purpose VNF
53709 ###### Related Nodes
53710 - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
53711 - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
53712 - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
53713 - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
53714 - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
53715 - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
53716 - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
53717 - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
53718 - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
53719 - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
53720 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
53721 - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53722 - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53723 - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53724 - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53725 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53726 - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
53727 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
53728 - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
53729 - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53730 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
53731 - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
53737 - is-closed-loop-disabled
53741 description: Unique id of VNF. This is unique across the graph.
53744 description: Name of VNF.
53747 description: Alternate name of VNF.
53750 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
53753 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
53754 regional-resource-zone:
53756 description: Regional way of organizing pservers, source of truth should define values
53759 description: Trigger for operational monitoring of this resource by Service Assurance systems.
53762 description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
53765 description: OBSOLETE - do not use
53768 description: Client should send valid enumerated value
53769 orchestration-status:
53771 description: Orchestration status of this VNF, used by MSO.
53774 description: Heat stack id corresponding to this instance, managed by MSO
53777 description: Corresponds to the SDN-C catalog id used to configure this VCE
53780 description: identifier of managed by company or customer
53783 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
53784 ipv4-loopback0-address:
53786 description: v4 Loopback0 address
53789 description: v6 Loopback address
53790 management-v6-address:
53792 description: v6 management address
53796 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
53799 description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only in some usecases
53803 description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
53806 description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only in some usecases
53810 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
53813 description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases
53816 is-closed-loop-disabled:
53825 $ref: "#/patchDefinitions/generic-vnf"
53828 Openstack group-assignment used to store exclusivity groups (EG).
53829 ###### Related Nodes
53830 - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53831 - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
53832 - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
53840 description: Group id, expected to be unique across cloud-region.
53843 description: Group type - the type of group this instance refers to
53846 description: Group name - name assigned to the group
53849 description: Group description - description of the group
53852 Collection of openstack group assignments
53857 $ref: "#/patchDefinitions/group-assignment"
53860 ###### Related Nodes
53861 - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
53869 description: host-route id
53872 description: subnet prefix
53875 description: Could be ip-address, hostname, or service-instance
53878 description: Should be ip-address, hostname, or service-instance to match next-hop
53884 $ref: "#/patchDefinitions/host-route"
53888 ###### Related Nodes
53889 - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53890 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
53891 - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
53892 - IMAGE cannot be deleted if linked to VSERVER
53893 - IMAGE is DELETED when these are DELETED METADATUM
53903 description: Image id, expected to be unique across cloud region
53906 description: Image name
53907 image-architecture:
53909 description: Operating system architecture.
53912 description: The common name of the operating system distribution in lowercase
53915 description: The operating system version as specified by the distributor.
53918 description: The application that the image instantiates.
53919 application-vendor:
53921 description: The vendor of the application.
53922 application-version:
53924 description: The version of the application.
53927 description: URL to endpoint where AAI can get more details
53930 Collectio of Openstack images.
53935 $ref: "#/patchDefinitions/image"
53936 include-node-filter:
53942 InstanceFilter for performing a named-query or model query
53945 InstanceFilters for performing a named-query or model query
53950 $ref: "#/patchDefinitions/instance-filter"
53953 General mechanism for grouping instances
53954 ###### Related Nodes
53955 - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
53956 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
53957 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
53958 - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
53959 - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
53967 description: Instance Group ID, UUID assigned to this instance.
53970 description: Descriptive text to help identify the usage of this instance-group
53973 description: Only valid value today is lower case ha for high availability
53976 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
53979 Collection of openstack route table references
53984 $ref: "#/patchDefinitions/instance-group"
53989 $ref: "#/patchDefinitions/search"
53992 $ref: "#/patchDefinitions/actions"
53993 cloud-infrastructure:
53995 $ref: "#/patchDefinitions/cloud-infrastructure"
53998 $ref: "#/patchDefinitions/business"
53999 service-design-and-creation:
54001 $ref: "#/patchDefinitions/service-design-and-creation"
54004 $ref: "#/patchDefinitions/network"
54007 $ref: "#/patchDefinitions/aai-internal"
54011 $ref: "#/patchDefinitions/aai-internal"
54014 inventory-item-type:
54016 inventory-item-link:
54018 inventory-item-data:
54021 $ref: "#/patchDefinitions/inventory-item-data"
54022 tagged-inventory-item-list:
54025 $ref: "#/patchDefinitions/tagged-inventory-item-list"
54026 inventory-item-data:
54032 inventory-response-item:
54034 Inventory item for response list
54040 $ref: "#/patchDefinitions/extra-properties"
54041 inventory-response-items:
54043 $ref: "#/patchDefinitions/inventory-response-items"
54044 inventory-response-items:
54046 Container for inventory items in response list
54048 inventory-response-item:
54051 $ref: "#/patchDefinitions/inventory-response-item"
54052 ipsec-configuration:
54054 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
54055 ###### Related Nodes
54056 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
54057 - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
54058 - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
54060 - ipsec-configuration-id
54062 ipsec-configuration-id:
54064 description: UUID of this configuration
54065 requested-vig-address-type:
54067 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
54068 requested-encryption-strength:
54070 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
54071 requested-dmz-type:
54073 description: can offer a shared DMZ or a DMZ specific to a customer
54074 shared-dmz-network-address:
54076 description: Network address of shared DMZ
54077 requested-customer-name:
54079 description: If the DMZ is a custom DMZ, this field will indicate the customer information
54082 description: can be 1 or 2
54083 ikev1-authentication:
54085 description: Contains values like md5, sha1, sha256, sha384
54088 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
54091 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
54094 description: Group name defined in VIG for clients using aggressive mode
54097 description: pre-shared key for the above group name
54100 description: Lifetime for IKEv1 SA
54101 ipsec-authentication:
54103 description: md5, sha1, sha256, sha384
54106 description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
54109 description: Life time for IPSec SA
54112 description: enable PFS or not
54115 description: user ID for xAuth, sm-user, ,nmteHostName
54116 xauth-user-password:
54118 description: Encrypted using the Juniper $9$ algorithm
54121 description: The time between DPD probe
54124 description: Maximum number of DPD before claiming the tunnel is down
54125 ipsec-configurations:
54127 ipsec-configuration:
54130 $ref: "#/patchDefinitions/ipsec-configuration"
54139 Logical interfaces, e.g., a vnic.
54140 ###### Related Nodes
54141 - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54142 - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
54143 - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
54144 - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
54145 - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
54146 - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
54147 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
54148 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
54149 - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
54150 - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
54151 - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
54152 - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
54158 description: Name given to the interface
54161 description: E.g., CUSTOMER, UPLINK, etc.
54164 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
54167 description: URL to endpoint where AAI can get more details
54170 description: ID of interface
54173 description: MAC address for the interface
54176 description: Name of the network
54179 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
54180 interface-description:
54182 description: Human friendly text regarding this interface.
54185 Collection of logical interfaces.
54190 $ref: "#/patchDefinitions/l-interface"
54191 l3-interface-ipv4-address-list:
54194 ###### Related Nodes
54195 - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
54196 - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
54197 - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
54198 - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
54200 - l3-interface-ipv4-address
54202 l3-interface-ipv4-address:
54204 description: IP address
54205 l3-interface-ipv4-prefix-length:
54208 description: Prefix length, 32 for single address
54212 description: Inner VLAN tag
54216 description: Outer VLAN tag
54219 description: Indicator of fixed or floating address
54220 l3-interface-ipv6-address-list:
54223 ###### Related Nodes
54224 - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
54225 - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
54226 - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
54227 - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
54229 - l3-interface-ipv6-address
54231 l3-interface-ipv6-address:
54233 description: IP address
54234 l3-interface-ipv6-prefix-length:
54237 description: Prefix length, 128 for single address
54241 description: Inner VLAN tag
54245 description: Outer VLAN tag
54248 description: Indicator of fixed or floating address
54251 Generic network definition
54252 ###### Related Nodes
54253 - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
54254 - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
54255 - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
54256 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
54257 - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54258 - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54259 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54260 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
54261 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
54262 - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
54263 - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
54264 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
54265 - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
54266 - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54267 - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
54268 - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
54273 - is-provider-network
54274 - is-shared-network
54275 - is-external-network
54279 description: Network ID, should be uuid. Unique across A&AI.
54282 description: Name of the network, governed by some naming convention..
54285 description: Type of the network - who defines these values?
54288 description: Role the network plans - who defines these values?
54289 network-technology:
54291 description: Network technology - who defines these values?
54292 neutron-network-id:
54294 description: Neutron network id of this Interface
54299 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
54300 network-role-instance:
54303 description: network role instance
54309 $ref: "#/patchDefinitions/l3-network"
54312 Link aggregate interface
54313 ###### Related Nodes
54314 - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54315 - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
54316 - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
54317 - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
54318 - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
54319 - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
54320 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
54321 - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
54322 - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK
54328 description: Name that identifies the link aggregate interface
54329 interface-description:
54331 description: Human friendly text regarding this interface.
54334 Collection of link aggregate interfaces.
54339 $ref: "#/patchDefinitions/lag-interface"
54342 LAG links can connect lag-interfaces
54343 ###### Related Nodes
54344 - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
54345 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
54351 description: Alphabetical concatenation of lag-interface names
54354 Collection of link aggregation connections
54359 $ref: "#/patchDefinitions/lag-link"
54362 Metadata for license group.
54363 ###### Related Nodes
54364 - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54365 - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
54372 description: Unique ID for the license group the resource belongs to, should be uuid.
54375 description: Unique ID of a license resource.
54378 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
54383 $ref: "#/patchDefinitions/license"
54386 describes a line-of-business
54387 ###### Related Nodes
54388 - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
54390 - line-of-business-name
54392 line-of-business-name:
54394 description: Name of the line-of-business (product)
54397 Collection of lines-of-business
54402 $ref: "#/patchDefinitions/line-of-business"
54405 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
54406 ###### Related Nodes
54407 - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
54408 - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
54409 - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
54410 - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
54411 - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
54412 - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
54413 - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
54414 - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
54415 - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
54416 - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
54417 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
54418 - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
54419 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
54426 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
54429 description: Type of logical link, e.g., evc
54432 description: Captures the numeric part of the speed
54435 description: Captures the units corresponding to the speed
54438 description: v4, v6, or ds for dual stack
54441 description: For example, static or BGP
54444 Collection of logical connections
54449 $ref: "#/patchDefinitions/logical-link"
54452 Collection of metadatum (key/value pairs)
54457 $ref: "#/patchDefinitions/metadatum"
54461 ###### Related Nodes
54462 - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
54463 - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
54464 - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
54465 - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
54476 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
54477 ###### Related Nodes
54478 - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
54479 - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
54480 - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
54481 - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
54482 - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
54483 - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
54484 - MODEL is DELETED when these are DELETED MODEL-VER
54486 - model-invariant-id
54489 model-invariant-id:
54491 description: Unique identifier corresponding to the main definition of a model in ASDC
54494 description: Type of the model, e.g., service, resource, widget, etc.
54495 model-and-named-query-search:
54497 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
54501 $ref: "#/patchDefinitions/query-parameters"
54504 $ref: "#/patchDefinitions/instance-filters"
54507 $ref: "#/patchDefinitions/secondary-filts"
54510 secondary-filter-cut-point:
54514 This is how we would capture constraints defining allowed sets of elements.
54515 ###### Related Nodes
54516 - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
54517 - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
54518 - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
54520 - model-constraint-uuid
54521 - constrained-element-set-uuid-to-replace
54523 model-constraint-uuid:
54525 constrained-element-set-uuid-to-replace:
54527 constrained-element-sets:
54530 $ref: "#/patchDefinitions/constrained-element-set"
54536 $ref: "#/patchDefinitions/model-constraint"
54539 Defines how other models combine to make up a higher-level model.
54540 ###### Related Nodes
54541 - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
54542 - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
54543 - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
54544 - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
54545 - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
54546 - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
54547 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
54548 - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
54550 - model-element-uuid
54551 - new-data-del-flag
54554 model-element-uuid:
54558 description: Indicates whether this element was created as part of instantiation from this model
54561 description: How many of this type of element are required/allowed
54569 $ref: "#/patchDefinitions/model-element"
54572 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
54573 ###### Related Nodes
54574 - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
54575 - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
54576 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
54577 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
54578 - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
54579 - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
54587 description: Unique identifier corresponding to one version of a model in ASDC
54590 description: Name of the model, which can change from version to version.
54593 description: Version
54596 description: Description
54602 $ref: "#/patchDefinitions/model-ver"
54605 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
54610 $ref: "#/patchDefinitions/model"
54611 multicast-configuration:
54613 ###### Related Nodes
54614 - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
54616 - multicast-configuration-id
54617 - multicast-protocol
54620 multicast-configuration-id:
54622 description: Unique id of multicast configuration.
54623 multicast-protocol:
54625 description: protocol of multicast configuration
54628 description: rp type of multicast configuration
54629 multicast-configurations:
54631 multicast configuration of generic-vnf ip-address
54633 multicast-configuration:
54636 $ref: "#/patchDefinitions/multicast-configuration"
54642 $ref: "#/patchDefinitions/named-query"
54646 ###### Related Nodes
54647 - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
54648 - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
54649 - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
54650 - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
54654 - named-query-version
54660 named-query-version:
54662 required-input-param:
54666 named-query-element:
54669 ###### Related Nodes
54670 - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
54671 - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
54672 - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
54673 - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
54674 - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
54675 - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
54676 - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
54678 - named-query-element-uuid
54680 named-query-element-uuid:
54682 property-collect-list:
54684 named-query-elements:
54686 named-query-element:
54689 $ref: "#/patchDefinitions/named-query-element"
54692 Namespace for network inventory resources.
54697 $ref: "#/patchDefinitions/logical-link"
54701 $ref: "#/patchDefinitions/site-pair-set"
54705 $ref: "#/patchDefinitions/vpn-binding"
54709 $ref: "#/patchDefinitions/vpls-pe"
54710 multicast-configurations:
54713 $ref: "#/patchDefinitions/multicast-configuration"
54717 $ref: "#/patchDefinitions/vce"
54721 $ref: "#/patchDefinitions/vnfc"
54725 $ref: "#/patchDefinitions/l3-network"
54729 $ref: "#/patchDefinitions/network-policy"
54733 $ref: "#/patchDefinitions/generic-vnf"
54737 $ref: "#/patchDefinitions/lag-link"
54741 $ref: "#/patchDefinitions/newvce"
54745 $ref: "#/patchDefinitions/pnf"
54749 $ref: "#/patchDefinitions/physical-link"
54750 ipsec-configurations:
54753 $ref: "#/patchDefinitions/ipsec-configuration"
54754 route-table-references:
54757 $ref: "#/patchDefinitions/route-table-reference"
54761 $ref: "#/patchDefinitions/instance-group"
54765 $ref: "#/patchDefinitions/zone"
54771 $ref: "#/patchDefinitions/network-policy"
54774 ###### Related Nodes
54775 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
54777 - network-policy-id
54781 description: UUID representing unique key to this instance
54782 network-policy-fqdn:
54784 description: Contrail FQDN for the policy
54787 description: ID for the openStack Heat instance
54790 Network profile populated by SDN-GP for SNMP
54791 ###### Related Nodes
54792 - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
54798 description: Unique name of network profile.
54801 description: Encrypted SNMP community string
54804 Collection of network profiles
54809 $ref: "#/patchDefinitions/network-profile"
54812 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
54813 ###### Related Nodes
54814 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
54815 - NEWVCE is DELETED when these are DELETED L-INTERFACE
54823 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
54826 description: Name of VNF.
54829 description: Alternate name of VNF.
54832 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
54835 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
54838 description: Indicator for whether the resource is considered operational
54841 description: OBSOLETE - do not use
54844 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
54847 description: Client should send valid enumerated value.
54850 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
54855 $ref: "#/patchDefinitions/newvce"
54856 notification-event:
54860 notification-event-header:
54862 $ref: "#/patchDefinitions/notification-event-header"
54863 notification-event-header:
54904 $ref: "#/patchDefinitions/key-data"
54909 OAM network, to be deprecated shortly. Do not use for new purposes.
54910 ###### Related Nodes
54911 - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54912 - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
54913 - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
54921 description: UUID of the network. Unique across a cloud-region
54924 description: Name of the network.
54928 description: cvlan-id
54929 ipv4-oam-gateway-address:
54931 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
54932 ipv4-oam-gateway-address-prefix-length:
54935 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
54938 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
54943 $ref: "#/patchDefinitions/oam-network"
54944 operational-environment:
54946 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
54947 ###### Related Nodes
54948 - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
54949 - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
54951 - operational-environment-id
54952 - operational-environment-name
54953 - operational-environment-type
54954 - operational-environment-status
54958 operational-environment-id:
54960 description: UUID of an operational environment
54961 operational-environment-name:
54963 description: Operational Environment name
54964 operational-environment-type:
54966 description: Operational Environment Type.
54967 operational-environment-status:
54969 description: Status
54972 description: Tenant Context.
54975 description: Workload Context.
54976 operational-environments:
54978 a logical partition of the cloud which allows to have multiple environments in the production AIC.
54980 operational-environment:
54983 $ref: "#/patchDefinitions/operational-environment"
54986 Allows for legacy POST of old-style and new-style models
54988 - model-invariant-id
54989 - model-name-version-id
54995 model-invariant-id:
54997 description: Unique identifier corresponding to the main definition of a model in ASDC
54998 model-name-version-id:
55000 description: Unique identifier corresponding to one version of a model in ASDC
55003 description: Type of the model, e.g., service, resource, widget, etc.
55006 description: Name of the model, which can change from version to version.
55009 description: Invariant unique ID which does not change from version to version
55012 description: Version
55015 description: Description
55018 Collection of owning-entities
55023 $ref: "#/patchDefinitions/owning-entity"
55026 describes an owning-entity
55027 ###### Related Nodes
55028 - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
55031 - owning-entity-name
55035 description: UUID of an owning entity
55036 owning-entity-name:
55038 description: Owning entity name
55041 Physical interface (e.g., nic)
55042 ###### Related Nodes
55043 - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
55044 - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
55045 - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
55046 - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
55047 - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
55048 - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
55049 - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
55050 - P-INTERFACE is DELETED when these are DELETED L-INTERFACE
55051 - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
55057 description: Name that identifies the physical interface
55060 description: Captures the numeric part of the speed
55063 description: Captures the units corresponding to the speed
55066 description: Nature of the services and connectivity on this port.
55067 equipment-identifier:
55069 description: CLEI or other specification for p-interface hardware.
55072 description: Role specification for p-interface hardware.
55075 description: Indicates the physical properties of the interface.
55078 description: Trigger for operational monitoring of this resource by Service Assurance systems.
55081 Collection of physical interfaces.
55086 $ref: "#/patchDefinitions/p-interface"
55089 Collection of physical connections, typically between p-interfaces
55090 ###### Related Nodes
55091 - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
55097 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
55100 description: Captures the numeric part of the speed
55103 description: Captures the units corresponding to the speed
55106 description: Circuit it
55109 description: Dual access mode (e.g., primary, secondary
55112 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
55113 service-provider-name:
55115 description: Name of the service Provider on this link.
55118 Collection of physical connections, typically between p-interfaces
55123 $ref: "#/patchDefinitions/physical-link"
55126 describes a platform
55127 ###### Related Nodes
55128 - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
55134 description: Name of the platform
55137 Collection of platforms
55142 $ref: "#/patchDefinitions/platform"
55145 PNF represents a physical network function. typically equipment used in the D1 world.
55146 ###### Related Nodes
55147 - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
55148 - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
55149 - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
55150 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
55151 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
55152 - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
55153 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
55154 - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
55161 description: unique name of Physical Network Function.
55164 description: name of Physical Network Function.
55167 description: source of name2
55170 description: id of pnf
55173 description: Equipment type. Source of truth should define valid values.
55176 description: Equipment vendor. Source of truth should define valid values.
55179 description: Equipment model. Source of truth should define valid values.
55182 description: identifier of managed by company or customer
55185 description: ipv4-oam-address with new naming convention for IP addresses
55188 description: sw-version is the version of SW for the hosted application on the PNF.
55193 description: ID of the physical frame (relay rack) where pnf is installed.
55196 description: Serial number of the device
55197 ipaddress-v4-loopback-0:
55199 description: IPV4 Loopback 0 address
55200 ipaddress-v6-loopback-0:
55202 description: IPV6 Loopback 0 address
55205 description: IPV4 AIM address
55208 description: IPV6 AIM address
55211 description: IPV6 OAM address
55214 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
55217 Collection of Physical Network Functions.
55222 $ref: "#/patchDefinitions/pnf"
55225 Used to capture the network interfaces of this VCE
55226 ###### Related Nodes
55227 - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
55228 - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
55229 - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
55232 - orchestration-status
55236 description: Unique ID of the interface
55237 neutron-network-id:
55239 description: Neutron network id of this Interface
55240 neutron-network-name:
55242 description: Neutron network name of this Interface
55245 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
55251 $ref: "#/patchDefinitions/port-group"
55254 describes the project
55255 ###### Related Nodes
55256 - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
55262 description: Name of the project deploying a service
55265 Collection of projects
55270 $ref: "#/patchDefinitions/project"
55273 Property holder for query properties or instance properties
55279 property-constraint:
55282 ###### Related Nodes
55283 - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55285 - property-constraint-uuid
55290 property-constraint-uuid:
55298 property-constraints:
55300 property-constraint:
55303 $ref: "#/patchDefinitions/property-constraint"
55306 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
55307 ###### Related Nodes
55308 - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
55309 - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
55310 - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
55311 - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
55312 - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
55313 - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
55314 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
55315 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
55316 - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
55317 - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
55318 - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
55319 - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
55320 - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
55327 description: Value from executing hostname on the compute node.
55330 description: PTNII name
55334 description: Number of cpus
55338 description: Disk size, in GBs
55342 description: RAM size, in MBs
55345 description: Equipment type. Source of truth should define valid values.
55348 description: Equipment vendor. Source of truth should define valid values.
55351 description: Equipment model. Source of truth should define valid values.
55354 description: Fully-qualified domain name
55357 description: URL to endpoint where AAI can get more details
55360 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
55363 description: Serial number, may be queried
55364 ipaddress-v4-loopback-0:
55366 description: IPV4 Loopback 0 address
55367 ipaddress-v6-loopback-0:
55369 description: IPV6 Loopback 0 address
55372 description: IPV4 AIM address
55375 description: IPV6 AIM address
55378 description: IPV6 OAM address
55381 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
55384 description: ID of Pserver
55387 description: internet topology of Pserver
55392 Collection of compute hosts.
55397 $ref: "#/patchDefinitions/pserver"
55400 QueryParameters for performing a named-query or model query
55404 $ref: "#/patchDefinitions/named-query"
55407 $ref: "#/patchDefinitions/overloaded-model"
55411 ###### Related Nodes
55412 - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55414 - related-lookup-uuid
55416 - source-node-property
55418 - target-node-property
55420 related-lookup-uuid:
55424 source-node-property:
55428 target-node-property:
55430 property-collect-list:
55437 $ref: "#/patchDefinitions/related-lookup"
55438 related-to-property:
55442 description: Key part of a key/value pair
55445 description: Value part of a key/value pair
55450 description: A keyword provided by A&AI to indicate type of node.
55453 description: URL to the object in A&AI.
55457 $ref: "#/patchDefinitions/relationship-data"
55458 related-to-property:
55461 $ref: "#/patchDefinitions/related-to-property"
55465 - relationship-value
55469 description: A keyword provided by A&AI to indicate an attribute.
55470 relationship-value:
55472 description: Value of the attribute.
55473 reserved-prop-names:
55475 Internal map to define some reserved properties of a vertex
55477 last-mod-source-of-truth:
55495 Response container for the results of a named-query or model query
55497 inventory-response-items:
55499 $ref: "#/patchDefinitions/inventory-response-items"
55504 description: The specific type of node in the A&AI graph
55507 description: The URL to the specific resource
55508 route-table-reference:
55510 Openstack route table reference.
55511 ###### Related Nodes
55512 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
55514 - route-table-reference-id
55515 - route-table-reference-fqdn
55517 route-table-reference-id:
55519 description: Route Table Reference id, UUID assigned to this instance.
55520 route-table-reference-fqdn:
55522 description: FQDN entry in the route table.
55523 route-table-references:
55525 Collection of openstack route table references
55527 route-table-reference:
55530 $ref: "#/patchDefinitions/route-table-reference"
55533 Route target information
55534 ###### Related Nodes
55535 - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
55537 - global-route-target
55538 - route-target-role
55540 global-route-target:
55542 description: Number used to identify an RT, globally unique in the network
55545 description: Role assigned to this route target
55548 Collection of route target information
55553 $ref: "#/patchDefinitions/route-target"
55556 ###### Related Nodes
55557 - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
55558 - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
55559 - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
55561 - routing-instance-id
55563 routing-instance-id:
55565 description: Unique id of routing instance
55568 description: rpm owner
55571 set of probes related to generic-vnf routing instance
55576 $ref: "#/patchDefinitions/routing-instance"
55581 $ref: "#/patchDefinitions/oam-networks"
55582 az-and-dvs-switches:
55585 $ref: "#/patchDefinitions/az-and-dvs-switches"
55588 edge-tag-query-result:
55590 $ref: "#/patchDefinitions/edge-tag-query-result"
55591 edge-tag-query-request:
55593 $ref: "#/patchDefinitions/edge-tag-query-request"
55596 $ref: "#/patchDefinitions/search-results"
55599 $ref: "#/patchDefinitions/sdn-zone-response"
55605 $ref: "#/patchDefinitions/result-data"
55608 SecondaryFilt for performing a named-query or model query
55619 SecondaryFilts for performing a named-query or model query
55624 $ref: "#/patchDefinitions/secondary-filt"
55625 segmentation-assignment:
55627 Openstack segmentation assignment.
55628 ###### Related Nodes
55629 - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
55635 description: Route Table Reference id, UUID assigned to this instance.
55636 segmentation-assignments:
55638 Collection of openstack segmentation assignments
55640 segmentation-assignment:
55643 $ref: "#/patchDefinitions/segmentation-assignment"
55646 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
55649 - service-description
55653 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
55654 service-description:
55656 description: Description of the service
55659 description: URL to endpoint where AAI can get more details
55660 service-capabilities:
55662 Collection of service capabilities.
55664 service-capability:
55667 $ref: "#/patchDefinitions/service-capability"
55668 service-capability:
55670 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
55671 ###### Related Nodes
55672 - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
55673 - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
55674 - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
55681 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
55684 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
55685 service-design-and-creation:
55687 Namespace for objects managed by ASDC
55692 $ref: "#/patchDefinitions/vnf-image"
55696 $ref: "#/patchDefinitions/service"
55697 service-capabilities:
55700 $ref: "#/patchDefinitions/service-capability"
55704 $ref: "#/patchDefinitions/model"
55708 $ref: "#/patchDefinitions/named-query"
55711 Instance of a service
55712 ###### Related Nodes
55713 - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
55714 - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
55715 - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
55716 - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
55717 - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
55718 - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
55719 - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
55720 - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
55721 - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
55722 - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
55723 - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
55724 - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
55725 - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
55726 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
55727 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
55728 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
55729 - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM
55730 - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
55732 - service-instance-id
55734 service-instance-id:
55736 description: Uniquely identifies this instance of a service
55737 service-instance-name:
55739 description: This field will store a name assigned to the service-instance.
55742 description: the ASDC model id for this resource or service model.
55743 persona-model-version:
55745 description: the ASDC model version for this resource or service model.
55748 description: the ASDC model version for this resource or service model.
55751 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
55752 widget-model-version:
55754 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
55757 description: Indicates the total bandwidth to be used for this service.
55760 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
55761 bandwidth-down-wan1:
55763 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
55766 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
55767 bandwidth-down-wan2:
55769 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
55772 description: URL customers will use to access the vHN Portal.
55773 service-instance-location-id:
55775 description: An identifier that customers assign to the location where this service is being used.
55778 Collection of service instances
55783 $ref: "#/patchDefinitions/service-instance"
55784 service-subscription:
55786 Object that group service instances.
55787 ###### Related Nodes
55788 - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
55789 - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
55790 - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
55791 - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
55797 description: Value defined by orchestration to identify this service across ECOMP.
55798 temp-ub-sub-account-id:
55800 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
55801 service-subscriptions:
55803 Collection of objects that group service instances.
55805 service-subscription:
55808 $ref: "#/patchDefinitions/service-subscription"
55811 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
55816 $ref: "#/patchDefinitions/service"
55819 ###### Related Nodes
55820 - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
55821 - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
55822 - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
55828 description: unique identifier of probe
55831 description: Prefix address
55834 description: Prefix address
55837 description: ip version, v4, v6
55838 destination-hostname:
55840 description: Hostname of the destination equipment to which SLAs are measured against.
55841 destination-equip-type:
55843 description: The type of destinatination equipment. Could be Router, etc.
55846 Set of instances for probes used to measure service level agreements
55847 ###### Related Nodes
55848 - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
55849 - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
55850 - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
55856 description: Unique id of site pair set.
55859 Collection of sets of instances for probes related to generic-vnf
55864 $ref: "#/patchDefinitions/site-pair-set"
55872 $ref: "#/patchDefinitions/site-pair"
55876 ###### Related Nodes
55877 - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
55878 - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
55884 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
55887 description: Snapshot name
55888 snapshot-architecture:
55890 description: Operating system architecture
55891 snapshot-os-distro:
55893 description: The common name of the operating system distribution in lowercase
55894 snapshot-os-version:
55896 description: The operating system version as specified by the distributor.
55899 description: The application that the image instantiates.
55900 application-vendor:
55902 description: The vendor of the application.
55903 application-version:
55905 description: The version of the application.
55908 description: URL to endpoint where AAI can get more details
55911 description: This field contains the UUID of the previous snapshot (if any).
55914 Collection of openstack snapshots
55919 $ref: "#/patchDefinitions/snapshot"
55922 SR-IOV Physical Function
55923 ###### Related Nodes
55924 - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
55925 - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
55931 description: Identifier for the sriov-pf
55934 Collection of SR-IOV Physical Functions.
55939 $ref: "#/patchDefinitions/sriov-pf"
55942 SR-IOV Virtual Function (not to be confused with virtual network function)
55943 ###### Related Nodes
55944 - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
55950 description: PCI ID used to identify the sriov-vf
55953 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
55956 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
55959 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
55960 vf-vlan-anti-spoof-check:
55962 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.
55963 vf-mac-anti-spoof-check:
55965 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.
55968 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
55969 vf-broadcast-allow:
55971 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
55972 vf-unknown-multicast-allow:
55974 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
55975 vf-unknown-unicast-allow:
55977 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
55980 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
55983 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
55986 Collection of SR-IOV Virtual Functions.
55991 $ref: "#/patchDefinitions/sriov-vf"
56000 ###### Related Nodes
56001 - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
56002 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
56003 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
56004 - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
56011 description: Subnet ID, should be UUID.
56014 description: Name associated with the subnet.
56017 description: Neutron id of this subnet
56020 description: gateway ip address
56021 network-start-address:
56023 description: network start address
56026 description: cidr mask
56029 description: ip version
56030 orchestration-status:
56032 description: Orchestration status of this VNF, mastered by MSO
56037 description: the start address reserved for use by dhcp
56040 description: the last address reserved for use by dhcp
56046 $ref: "#/patchDefinitions/subnet"
56047 tagged-inventory-item-list:
56052 $ref: "#/patchDefinitions/inventory-item"
56056 ###### Related Nodes
56057 - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56058 - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
56059 - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
56060 - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
56061 - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
56062 - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
56063 - TENANT cannot be deleted if linked to VSERVER
56070 description: Unique id relative to the cloud-region.
56073 description: Readable name of tenant
56076 Collection of openstack tenants.
56081 $ref: "#/patchDefinitions/tenant"
56084 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
56085 ###### Related Nodes
56086 - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
56089 - bandwidth-up-wan1
56090 - bandwidth-down-wan1
56091 - bandwidth-up-wan2
56092 - bandwidth-down-wan2
56096 description: Allotted Resource id UUID assigned to this instance.
56099 description: The WAN uplink bandwidth for WAN1
56100 bandwidth-down-wan1:
56102 description: The WAN downlink bandwidth for WAN1
56105 description: The WAN uplink bandwidth for WAN2
56106 bandwidth-down-wan2:
56108 description: The WAN downlink bandwidth for WAN2
56111 This object is used to store the specific tunnel cross connect aspects of an allotted resource
56116 $ref: "#/patchDefinitions/tunnel-xconnect"
56119 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
56128 $ref: "#/patchDefinitions/update-node-key"
56134 $ref: "#/patchDefinitions/action"
56143 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
56144 ###### Related Nodes
56145 - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
56146 - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
56147 - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
56148 - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
56149 - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
56150 - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
56151 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
56152 - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
56160 description: Unique id of VNF. This is unique across the graph.
56163 description: Name of VNF.
56166 description: Alternate name of VNF.
56169 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
56172 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
56173 regional-resource-zone:
56175 description: Regional way of organizing pservers, source of truth should define values
56178 description: Trigger for operational monitoring of this resource by Service Assurance systems.
56181 description: Indicator for whether the resource is considered operational
56184 description: OBSOLETE - do not use
56187 description: Network role being played by this VNF
56188 orchestration-status:
56190 description: Orchestration status of this VNF, mastered by MSO
56193 description: Heat stack id corresponding to this instance, managed by MSO
56196 description: Corresponds to the SDN-C catalog id used to configure this VCE
56199 description: Unique ID of VPE connected to this VCE.
56200 v6-vce-wan-address:
56202 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
56205 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
56208 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
56213 $ref: "#/patchDefinitions/vce"
56216 a deployment unit of VNFCs
56217 ###### Related Nodes
56218 - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
56219 - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
56220 - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
56221 - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
56222 - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
56223 - VF-MODULE cannot be deleted if linked to VNFC
56226 - is-base-vf-module
56230 description: Unique ID of vf-module.
56233 description: Name of vf-module
56236 description: Heat stack id corresponding to this instance.
56237 orchestration-status:
56239 description: orchestration status of this vf-module, mastered by MSO
56244 Collection of vf-modules, a deployment unit of VNFCs
56249 $ref: "#/patchDefinitions/vf-module"
56252 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
56253 ###### Related Nodes
56254 - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
56260 description: indicates whether the VIG is for AVPN or INTERNET
56263 description: v4 IP of the vig server
56266 description: v6 IP of the vig server
56272 $ref: "#/patchDefinitions/vig-server"
56273 vip-ipv4-address-list:
56276 ###### Related Nodes
56277 - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56278 - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56279 - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
56280 - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
56286 description: IP address
56287 vip-ipv4-prefix-length:
56290 description: Prefix length, 32 for single address
56294 description: Inner VLAN tag
56298 description: Outer VLAN tag
56301 description: Indicator of fixed or floating address
56302 vip-ipv6-address-list:
56305 ###### Related Nodes
56306 - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56307 - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56308 - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
56309 - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
56315 description: IP address
56316 vip-ipv6-prefix-length:
56319 description: Prefix length, 128 for single address
56323 description: Inner VLAN tag
56327 description: Outer VLAN tag
56330 description: Indicator of fixed or floating address
56331 virtual-data-center:
56333 Virtual organization of cloud infrastructure elements in a data center context
56334 ###### Related Nodes
56335 - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
56336 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
56337 - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
56344 description: Unique ID of the vdc
56347 description: Name of the virtual data center
56348 virtual-data-centers:
56350 Virtual organization of cloud infrastructure elements in a data center context
56352 virtual-data-center:
56355 $ref: "#/patchDefinitions/virtual-data-center"
56359 ###### Related Nodes
56360 - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
56361 - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
56362 - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
56363 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
56364 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
56365 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
56366 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
56367 - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
56368 - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
56374 description: String that identifies the interface
56378 description: Inner VLAN tag
56382 description: Outer VLAN tag
56388 $ref: "#/patchDefinitions/vlan"
56397 description: Unique id of VNF. This is unique across the graph.
56400 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
56401 ###### Related Nodes
56402 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
56403 - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
56407 - application-vendor
56411 description: Unique ID of this asset
56414 description: The application that the image instantiates.
56415 application-vendor:
56417 description: The vendor of the application.
56418 application-version:
56420 description: The version of the application.
56423 description: URL to endpoint where AAI can get more details
56426 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
56431 $ref: "#/patchDefinitions/vnf-image"
56434 ###### Related Nodes
56435 - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
56436 - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
56437 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
56440 - vnfc-function-code
56443 - is-closed-loop-disabled
56447 description: Unique ID of vnfc.
56448 vnfc-function-code:
56450 description: function code
56456 description: prov status of this vnfc
56457 orchestration-status:
56459 description: Orchestration status of this VNF, mastered by APP-C
56460 ipaddress-v4-oam-vip:
56462 description: Oam V4 vip address of this vnfc
56465 is-closed-loop-disabled:
56469 description: Group notation of VNFC
56472 virtual network components associated with a vserver from application controller.
56477 $ref: "#/patchDefinitions/vnfc"
56480 Ephemeral Block storage volume.
56481 ###### Related Nodes
56482 - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
56489 description: Unique ID of block storage volume relative to the vserver.
56492 description: URL to endpoint where AAI can get more details
56495 Persistent block-level storage.
56496 ###### Related Nodes
56497 - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56498 - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
56499 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
56500 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
56501 - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
56504 - volume-group-name
56509 description: Unique ID of volume-group.
56512 description: Name of the volume group.
56515 description: Heat stack id corresponding to this volume-group
56518 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
56519 orchestration-status:
56521 description: Orchestration status of this volume-group
56522 persona-model-customization-id:
56524 description: captures the id of all the configuration used to customize the resource for the service.
56525 vf-module-persona-model-customization-id:
56527 description: helps relate the volume group to the vf-module whose components will require the volume group
56530 Collection of persistent block-level storage.
56535 $ref: "#/patchDefinitions/volume-group"
56538 Collection of ephemeral Block storage volumes.
56543 $ref: "#/patchDefinitions/volume"
56546 VPLS Provider Edge routers.
56547 ###### Related Nodes
56548 - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
56549 - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
56550 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
56551 - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
56552 - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
56560 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
56563 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
56566 description: Client should send valid enumerated value, e.g., VPLS-PE.
56570 description: Temporary location for stag to get to VCE
56573 Collection of VPLS Provider Edge routers
56578 $ref: "#/patchDefinitions/vpls-pe"
56582 ###### Related Nodes
56583 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
56584 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
56585 - VPN-BINDING cannot be deleted if linked to L3-NETWORK,LOGICAL-LINK
56589 - global-route-target
56590 - route-target-role
56594 description: VPN ID, globally unique within A&AI
56597 description: VPN Name
56598 global-route-target:
56600 description: Number used to identify a VPN, globally unique in the network
56603 description: the platform associated with the VPN example AVPN, Mobility
56606 description: Type of the vpn, should be taken from enumerated/valid values
56607 route-distinguisher:
56609 description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
56612 description: Role assigned to this route target
56618 $ref: "#/patchDefinitions/vpn-binding"
56621 Virtual Servers, aka virtual machine or VM.
56622 ###### Related Nodes
56623 - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
56624 - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
56625 - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
56626 - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
56627 - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
56628 - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
56629 - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
56630 - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
56631 - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
56632 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
56633 - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
56634 - VSERVER is DELETED when these are DELETED L-INTERFACE
56635 - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
56641 - is-closed-loop-disabled
56645 description: Unique identifier for this vserver relative to its tenant
56648 description: Name of vserver
56651 description: Alternative name of vserver
56654 description: Trigger for operational monitoring of this resource by Service Assurance systems.
56657 description: URL to endpoint where AAI can get more details
56660 is-closed-loop-disabled:
56664 Collection of virtual Servers, aka virtual machines or VMs.
56669 $ref: "#/patchDefinitions/vserver"
56672 A zone is a grouping of assets in a location homing to the same connections into the CBB
56673 ###### Related Nodes
56674 - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
56675 - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
56676 - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
56677 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
56686 description: Code assigned by AIC to the zone
56689 description: English name associated with the zone
56692 description: Design of zone [Medium/Large?]
56695 description: Context of zone [production/test]
56698 description: Status of a zone.
56701 Collection of zones
56706 $ref: "#/patchDefinitions/zone"
56721 $ref: "#/getDefinitions/action-data"
56730 APIs that are more action related than REST (e.g., notify, update).
56734 $ref: "#/getDefinitions/update"
56737 $ref: "#/getDefinitions/notify"
56740 Represents a slice or partial piece of a resource that gets separately allotted
56741 ###### Related Nodes
56742 - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
56743 - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56744 - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
56745 - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
56746 - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
56747 - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
56748 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
56749 - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
56755 description: Allotted Resource id UUID assigned to this instance.
56758 description: The descriptive information assigned to this allotted resource instance
56761 description: Link back to more information in the controller
56764 description: the ASDC model id for this resource or service model.
56765 persona-model-version:
56767 description: the ASDC model version for this resource or service model.
56770 description: the ASDC model version for this resource or service model.
56771 persona-model-customization-id:
56773 description: captures the id of all the configuration used to customize the resource for the service.
56776 description: Concurrency value
56780 $ref: "#/getDefinitions/tunnel-xconnect"
56784 $ref: "#/getDefinitions/relationship"
56785 allotted-resources:
56787 This object is used to store slices of services being offered
56792 $ref: "#/getDefinitions/allotted-resource"
56795 Availability zone, a collection of compute hosts/pservers
56796 ###### Related Nodes
56797 - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
56798 - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
56799 - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56800 - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
56801 - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
56802 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
56803 - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
56804 - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
56805 - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
56807 - availability-zone-name
56810 availability-zone-name:
56812 description: Name of the availability zone. Unique across a cloud region
56815 description: Type of hypervisor. Source of truth should define valid values.
56818 description: State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
56821 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56825 $ref: "#/getDefinitions/relationship"
56826 availability-zones:
56828 Collection of availability zones
56833 $ref: "#/getDefinitions/availability-zone"
56834 az-and-dvs-switches:
56838 $ref: "#/getDefinitions/dvs-switches"
56841 $ref: "#/getDefinitions/availability-zone"
56844 Namespace for business related constructs
56849 $ref: "#/getDefinitions/connector"
56853 $ref: "#/getDefinitions/customer"
56856 ###### Related Nodes
56857 - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
56863 description: unique identifier of probe
56866 description: identifier of probe
56869 description: type of probe
56872 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56876 $ref: "#/getDefinitions/relationship"
56877 classes-of-service:
56879 class-of-service of probe
56884 $ref: "#/getDefinitions/class-of-service"
56885 cloud-infrastructure:
56887 Namespace for cloud infrastructure.
56892 $ref: "#/getDefinitions/complex"
56896 $ref: "#/getDefinitions/cloud-region"
56900 $ref: "#/getDefinitions/network-profile"
56904 $ref: "#/getDefinitions/pserver"
56905 virtual-data-centers:
56908 $ref: "#/getDefinitions/virtual-data-center"
56911 cloud-region designates an installation of a cloud cluster or region or instantiation.
56912 ###### Related Nodes
56913 - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
56914 - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
56915 - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
56916 - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56917 - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56918 - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56919 - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56920 - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56921 - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56922 - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56923 - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56924 - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56925 - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
56926 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
56927 - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
56928 - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
56935 description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
56938 description: Identifier used by the vendor for the region. Second part of composite key
56941 description: Type of the cloud (e.g., openstack)
56942 owner-defined-type:
56944 description: Cloud-owner defined type indicator (e.g., dcp, lcp)
56945 cloud-region-version:
56947 description: Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
56950 description: URL of the keystone identity service
56953 description: Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
56956 description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
56959 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
56963 $ref: "#/getDefinitions/volume-group"
56967 $ref: "#/getDefinitions/tenant"
56971 $ref: "#/getDefinitions/flavor"
56975 $ref: "#/getDefinitions/group-assignment"
56979 $ref: "#/getDefinitions/snapshot"
56983 $ref: "#/getDefinitions/image"
56987 $ref: "#/getDefinitions/dvs-switch"
56991 $ref: "#/getDefinitions/oam-network"
56992 availability-zones:
56995 $ref: "#/getDefinitions/availability-zone"
56999 $ref: "#/getDefinitions/relationship"
57005 $ref: "#/getDefinitions/cloud-region"
57008 Collection of physical locations that can house cloud-regions.
57009 ###### Related Nodes
57010 - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
57011 - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57012 - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57013 - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
57014 - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
57015 - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57016 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57017 - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
57018 - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57019 - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57020 - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57021 - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
57022 - COMPLEX is DELETED when these are DELETED CTAG-POOL
57024 - physical-location-id
57025 - physical-location-type
57032 physical-location-id:
57034 description: Unique identifier for physical location, e.g., CLLI
57037 description: Data center code which can be an alternate way to identify a complex
57040 description: Gamma complex name for LCP instance.
57043 description: URL of the keystone identity service
57046 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57047 physical-location-type:
57049 description: Type, e.g., central office, data center.
57075 $ref: "#/getDefinitions/ctag-pool"
57079 $ref: "#/getDefinitions/relationship"
57082 Collection of physical locations that can house cloud-regions.
57087 $ref: "#/getDefinitions/complex"
57090 Port Mirror Configuration.
57091 ###### Related Nodes
57092 - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
57093 - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
57094 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
57095 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
57096 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
57097 - CONFIGURATION is DELETED when these are DELETED METADATUM
57098 - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
57101 - configuration-type
57102 - configuration-sub-type
57103 - orchestration-status
57104 - operational-status
57105 - configuration-selflink
57106 - model-customization-id
57110 description: UUID assigned to configuration.
57113 description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
57114 configuration-name:
57116 description: Name of the configuration.
57117 configuration-type:
57119 description: port-mirroring-configuration.
57120 configuration-sub-type:
57122 description: vprobe, pprobe.
57123 model-invariant-id:
57125 description: the ASDC model id for this resource or service model.
57128 description: the ASDC model version for this resource or service model.
57129 orchestration-status:
57131 description: Orchestration status of the configuration.
57132 operational-status:
57134 description: Indicator for whether the resource is considered operational.
57135 configuration-selflink:
57137 description: URL to endpoint where AAI can get more details from SDN-GC.
57138 model-customization-id:
57140 description: id of the configuration used to customize the resource
57143 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57147 $ref: "#/getDefinitions/relationship"
57151 $ref: "#/getDefinitions/metadatum"
57154 Collection of configurations
57159 $ref: "#/getDefinitions/configuration"
57162 Collection of resource instances used to connect a variety of disparate inventory widgets
57163 ###### Related Nodes
57164 - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
57165 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
57166 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
57167 - CONNECTOR is DELETED when these are DELETED METADATUM
57169 - resource-instance-id
57171 resource-instance-id:
57173 description: Unique id of resource instance.
57176 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57179 description: the ASDC model id for this resource or service model.
57180 persona-model-version:
57182 description: the ASDC model version for this resource or service model.
57185 description: the ASDC model version for this resource or service model.
57188 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
57189 widget-model-version:
57191 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
57195 $ref: "#/getDefinitions/relationship"
57199 $ref: "#/getDefinitions/metadatum"
57202 Collection of resource instances used to connect a variety of disparate inventory widgets
57207 $ref: "#/getDefinitions/connector"
57208 constrained-element-set:
57210 This is how we would capture constraints defining allowed sets of elements.
57211 ###### Related Nodes
57212 - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
57213 - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
57214 - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
57215 - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
57217 - constrained-element-set-uuid
57221 constrained-element-set-uuid:
57229 element-choice-sets:
57232 $ref: "#/getDefinitions/element-choice-set"
57236 $ref: "#/getDefinitions/relationship"
57237 constrained-element-sets:
57239 constrained-element-set:
57242 $ref: "#/getDefinitions/constrained-element-set"
57245 ###### Related Nodes
57246 - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
57247 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
57257 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57261 $ref: "#/getDefinitions/relationship"
57267 $ref: "#/getDefinitions/ctag-assignment"
57270 A collection of C tags (vlan tags) grouped for a specific purpose.
57271 ###### Related Nodes
57272 - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
57273 - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
57274 - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
57277 - availability-zone-name
57278 - ctag-pool-purpose
57282 description: The Target provider edge router
57283 availability-zone-name:
57285 description: Name of the availability zone
57288 description: Describes what the intended purpose of this pool is.
57291 description: Comma separated list of ctags
57294 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57298 $ref: "#/getDefinitions/relationship"
57304 $ref: "#/getDefinitions/ctag-pool"
57307 customer identifiers to provide linkage back to BSS information.
57308 ###### Related Nodes
57309 - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
57310 - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
57312 - global-customer-id
57316 global-customer-id:
57318 description: Global customer id used across ECOMP to uniquely identify customer.
57321 description: Subscriber name, an alternate way to retrieve a customer.
57324 description: Subscriber type, a way to provide VID with only the INFRA customers.
57327 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57328 service-subscriptions:
57331 $ref: "#/getDefinitions/service-subscription"
57335 $ref: "#/getDefinitions/relationship"
57338 Collection of customer identifiers to provide linkage back to BSS information.
57343 $ref: "#/getDefinitions/customer"
57351 description: See mis-na-virtualization-platform.yang
57354 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57358 $ref: "#/getDefinitions/relationship"
57364 $ref: "#/getDefinitions/cvlan-tag-entry"
57367 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.
57368 ###### Related Nodes
57369 - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57370 - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
57377 description: DVS switch name
57380 description: URL used to reach the vcenter
57383 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57387 $ref: "#/getDefinitions/relationship"
57390 Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
57395 $ref: "#/getDefinitions/dvs-switch"
57398 Internal map to define the properties of an edge and interpret the map EdgeRules
57416 edge-tag-query-request:
57427 $ref: "#/getDefinitions/start-node-filter"
57428 include-node-filter:
57431 $ref: "#/getDefinitions/include-node-filter"
57435 $ref: "#/getDefinitions/secondary-filter"
57436 edge-tag-query-result:
57438 tagged-inventory-item-list:
57441 $ref: "#/getDefinitions/tagged-inventory-item-list"
57442 element-choice-set:
57444 This is how we would capture constraints defining allowed sets of elements.
57445 ###### Related Nodes
57446 - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
57447 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
57448 - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
57450 - element-choice-set-uuid
57451 - element-choice-set-name
57453 element-choice-set-uuid:
57455 element-choice-set-name:
57464 $ref: "#/getDefinitions/model-element"
57468 $ref: "#/getDefinitions/relationship"
57469 element-choice-sets:
57471 element-choice-set:
57474 $ref: "#/getDefinitions/element-choice-set"
57477 Metadata for entitlement group.
57478 ###### Related Nodes
57479 - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
57480 - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
57487 description: Unique ID for the entitlement group the resource comes from, should be uuid.
57490 description: Unique ID of an entitlement resource.
57493 description: Concurrency value
57497 $ref: "#/getDefinitions/relationship"
57500 Entitlements, keyed by group-uuid and resource-uuid, related to license management
57505 $ref: "#/getDefinitions/entitlement"
57508 Persist EMS address information used by EMS driver.
57509 ###### Related Nodes
57510 - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
57511 - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
57517 description: Unique ID of EMS.
57520 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57521 esr-system-info-list:
57523 $ref: "#/getDefinitions/esr-system-info-list"
57526 $ref: "#/getDefinitions/relationship-list"
57532 $ref: "#/getDefinitions/esr-ems"
57535 Persist common address information of external systems.
57536 ###### Related Nodes
57537 - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
57538 - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
57539 - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
57540 - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
57542 - esr-system-info-id
57547 esr-system-info-id:
57549 description: Unique ID of esr system info.
57552 description: name of external system.
57555 description: type of external systems.
57558 description: vendor of external systems.
57561 description: version of external systems.
57564 description: url used to access external systems.
57567 description: username used to access external systems.
57570 description: password used to access external systems.
57573 description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
57576 description: protocol of third party SDNC, for example netconf/snmp.
57579 description: ca file content if enabled ssl on auth-url.
57582 description: Whether to verify VIM's certificate.
57585 description: service IP of ftp server.
57588 description: service port of ftp server.
57591 description: domain info for authentication.
57594 description: default tenant of VIM.
57597 description: ftp passive mode or not.
57600 description: resource or performance data file path.
57603 description: the status of external system.
57606 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57610 $ref: "#/getDefinitions/relationship"
57611 esr-system-info-list:
57613 Collection of persistent block-level external system auth info.
57618 $ref: "#/getDefinitions/esr-system-info"
57619 esr-thirdparty-sdnc:
57621 Persist SDNC address information used by ONAP SDNC.
57622 ###### Related Nodes
57623 - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
57624 - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
57625 - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
57627 - thirdparty-sdnc-id
57629 thirdparty-sdnc-id:
57631 description: Unique ID of SDNC.
57634 description: used for DC type to indicate the location of SDNC, such as Core or Edge.
57637 description: password used to access SDNC server.
57640 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57641 esr-system-info-list:
57643 $ref: "#/getDefinitions/esr-system-info-list"
57646 $ref: "#/getDefinitions/relationship-list"
57647 esr-thirdparty-sdnc-list:
57649 esr-thirdparty-sdnc:
57652 $ref: "#/getDefinitions/esr-thirdparty-sdnc"
57655 Persist VNFM address information used by VF-C.
57656 ###### Related Nodes
57657 - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
57658 - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
57664 description: Unique ID of VNFM.
57667 description: indecate the VIM to deploy VNF.
57670 description: certificate url of VNFM.
57673 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57674 esr-system-info-list:
57676 $ref: "#/getDefinitions/esr-system-info-list"
57679 $ref: "#/getDefinitions/relationship-list"
57685 $ref: "#/getDefinitions/esr-vnfm"
57688 evc object is an optional child object of the Configuration object.
57689 ###### Related Nodes
57690 - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
57696 description: Unique/key field for the evc object
57697 forwarding-path-topology:
57699 description: Point-to-Point, Multi-Point
57702 description: Commited Information Rate
57705 description: CIR units
57706 connection-diversity-group-id:
57708 description: Diversity Group ID
57711 description: formerly Performance Group
57712 esp-evc-circuit-id:
57714 description: EVC Circuit ID of ESP EVC
57717 description: Committed Information Rate (For ESP)
57720 description: CIR units (For ESP)
57723 description: Identifies ESP
57724 collector-pop-clli:
57726 description: Collector POP CLLI (from the hostname of the access pnf)
57727 inter-connect-type-ingress:
57729 description: Interconnect type on ingress side of EVC.
57730 tagmode-access-ingress:
57732 description: tagode for collector side of EVC
57733 tagmode-access-egress:
57735 description: tagMode for network side of EVC
57739 $ref: "#/getDefinitions/relationship"
57742 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57748 $ref: "#/getDefinitions/evc"
57751 Namespace for external system.
57755 $ref: "#/getDefinitions/esr-ems-list"
57758 $ref: "#/getDefinitions/esr-vnfm-list"
57759 esr-thirdparty-sdnc-list:
57761 $ref: "#/getDefinitions/esr-thirdparty-sdnc-list"
57764 Extra properties for inventory item for response list
57772 ###### Related Nodes
57773 - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57774 - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
57775 - FLAVOR cannot be deleted if linked to VSERVER
57783 description: Flavor id, expected to be unique across cloud-region.
57786 description: Flavor name
57790 description: Number of CPUs
57794 description: Amount of memory
57798 description: Disk space
57802 description: Amount of ephemeral disk space
57805 description: amount of swap space allocation
57808 description: whether flavor is available to all users or private to the tenant it was created in.
57811 description: URL to endpoint where AAI can get more details
57814 description: Boolean as to whether this flavor is no longer enabled
57817 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57821 $ref: "#/getDefinitions/relationship"
57824 Collection of openstack flavors.
57829 $ref: "#/getDefinitions/flavor"
57832 Entity describing a sequenced segment of forwarding path
57833 ###### Related Nodes
57834 - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
57835 - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
57836 - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
57837 - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
57838 - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
57839 - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
57846 description: Unique ID of this segmentation
57849 description: ingress, intermediate, egress
57853 $ref: "#/getDefinitions/relationship"
57856 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57859 forwarder object is an optional child object of the Configuration object.
57860 ###### Related Nodes
57861 - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
57867 description: Key for forwarder-evc object
57870 description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
57873 description: Internal VLAN.
57876 description: SVLAN value for ingress of egress forwarder.
57879 description: CVLAN value for ingress of egress forwarder.
57883 $ref: "#/getDefinitions/relationship"
57886 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57892 $ref: "#/getDefinitions/forwarder-evc"
57898 $ref: "#/getDefinitions/forwarder"
57901 Entity that describes the sequenced forwarding path between interfaces of services or resources
57902 ###### Related Nodes
57903 - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
57904 - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
57905 - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
57906 - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
57907 - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
57909 - forwarding-path-id
57910 - forwarding-path-name
57912 forwarding-path-id:
57914 description: Unique ID of this FP
57915 forwarding-path-name:
57917 description: Name of the FP
57921 $ref: "#/getDefinitions/relationship"
57924 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
57927 description: the self link for this FP
57931 $ref: "#/getDefinitions/forwarder"
57937 $ref: "#/getDefinitions/forwarding-path"
57940 General purpose VNF
57941 ###### Related Nodes
57942 - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
57943 - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
57944 - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
57945 - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
57946 - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
57947 - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
57948 - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
57949 - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
57950 - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
57951 - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
57952 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
57953 - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
57954 - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
57955 - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
57956 - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
57957 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
57958 - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
57959 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
57960 - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
57961 - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
57962 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
57963 - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
57969 - is-closed-loop-disabled
57973 description: Unique id of VNF. This is unique across the graph.
57976 description: Name of VNF.
57979 description: Alternate name of VNF.
57982 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
57985 description: Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
57986 regional-resource-zone:
57988 description: Regional way of organizing pservers, source of truth should define values
57991 description: Trigger for operational monitoring of this resource by Service Assurance systems.
57994 description: Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
57997 description: OBSOLETE - do not use
58000 description: Client should send valid enumerated value
58001 orchestration-status:
58003 description: Orchestration status of this VNF, used by MSO.
58006 description: Heat stack id corresponding to this instance, managed by MSO
58009 description: Corresponds to the SDN-C catalog id used to configure this VCE
58012 description: identifier of managed by company or customer
58015 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
58016 ipv4-loopback0-address:
58018 description: v4 Loopback0 address
58021 description: v6 Loopback address
58022 management-v6-address:
58024 description: v6 management address
58028 description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
58031 description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only in some usecases
58035 description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
58038 description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only in some usecases
58042 description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
58045 description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases
58048 is-closed-loop-disabled:
58052 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58055 description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
58056 encrypted-access-flag:
58058 description: indicates whether generic-vnf access uses SSH
58061 description: the ASDC model id for this resource or service model.
58062 persona-model-version:
58064 description: the ASDC model version for this resource or service model.
58067 description: the ASDC model version for this resource or service model.
58068 persona-model-customization-id:
58070 description: captures the id of all the configuration used to customize the resource for the service.
58073 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
58074 widget-model-version:
58076 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
58079 description: as-number of the VNF
58080 regional-resource-subzone:
58082 description: represents sub zone of the rr plane
58085 description: Path to the controller object.
58089 $ref: "#/getDefinitions/relationship"
58093 $ref: "#/getDefinitions/l-interface"
58097 $ref: "#/getDefinitions/lag-interface"
58101 $ref: "#/getDefinitions/vf-module"
58105 $ref: "#/getDefinitions/license"
58109 $ref: "#/getDefinitions/entitlement"
58117 $ref: "#/getDefinitions/generic-vnf"
58120 Openstack group-assignment used to store exclusivity groups (EG).
58121 ###### Related Nodes
58122 - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58123 - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
58124 - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
58132 description: Group id, expected to be unique across cloud-region.
58135 description: Group type - the type of group this instance refers to
58138 description: Group name - name assigned to the group
58141 description: Group description - description of the group
58144 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58148 $ref: "#/getDefinitions/relationship"
58151 Collection of openstack group assignments
58156 $ref: "#/getDefinitions/group-assignment"
58159 ###### Related Nodes
58160 - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
58168 description: host-route id
58171 description: subnet prefix
58174 description: Could be ip-address, hostname, or service-instance
58177 description: Should be ip-address, hostname, or service-instance to match next-hop
58180 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58184 $ref: "#/getDefinitions/relationship"
58190 $ref: "#/getDefinitions/host-route"
58194 ###### Related Nodes
58195 - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58196 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
58197 - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
58198 - IMAGE cannot be deleted if linked to VSERVER
58199 - IMAGE is DELETED when these are DELETED METADATUM
58209 description: Image id, expected to be unique across cloud region
58212 description: Image name
58213 image-architecture:
58215 description: Operating system architecture.
58218 description: The common name of the operating system distribution in lowercase
58221 description: The operating system version as specified by the distributor.
58224 description: The application that the image instantiates.
58225 application-vendor:
58227 description: The vendor of the application.
58228 application-version:
58230 description: The version of the application.
58233 description: URL to endpoint where AAI can get more details
58236 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58240 $ref: "#/getDefinitions/relationship"
58244 $ref: "#/getDefinitions/metadatum"
58247 Collectio of Openstack images.
58252 $ref: "#/getDefinitions/image"
58253 include-node-filter:
58259 InstanceFilter for performing a named-query or model query
58262 InstanceFilters for performing a named-query or model query
58267 $ref: "#/getDefinitions/instance-filter"
58270 General mechanism for grouping instances
58271 ###### Related Nodes
58272 - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
58273 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
58274 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
58275 - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
58276 - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
58284 description: Instance Group ID, UUID assigned to this instance.
58287 description: Descriptive text to help identify the usage of this instance-group
58290 description: Only valid value today is lower case ha for high availability
58293 description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
58296 description: Concurrency value
58300 $ref: "#/getDefinitions/relationship"
58303 Collection of openstack route table references
58308 $ref: "#/getDefinitions/instance-group"
58313 $ref: "#/getDefinitions/search"
58316 $ref: "#/getDefinitions/actions"
58317 cloud-infrastructure:
58319 $ref: "#/getDefinitions/cloud-infrastructure"
58322 $ref: "#/getDefinitions/business"
58323 service-design-and-creation:
58325 $ref: "#/getDefinitions/service-design-and-creation"
58328 $ref: "#/getDefinitions/network"
58331 $ref: "#/getDefinitions/aai-internal"
58335 $ref: "#/getDefinitions/aai-internal"
58338 inventory-item-type:
58340 inventory-item-link:
58342 inventory-item-data:
58345 $ref: "#/getDefinitions/inventory-item-data"
58346 tagged-inventory-item-list:
58349 $ref: "#/getDefinitions/tagged-inventory-item-list"
58350 inventory-item-data:
58356 inventory-response-item:
58358 Inventory item for response list
58364 $ref: "#/getDefinitions/extra-properties"
58365 inventory-response-items:
58367 $ref: "#/getDefinitions/inventory-response-items"
58368 inventory-response-items:
58370 Container for inventory items in response list
58372 inventory-response-item:
58375 $ref: "#/getDefinitions/inventory-response-item"
58376 ipsec-configuration:
58378 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
58379 ###### Related Nodes
58380 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
58381 - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
58382 - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
58384 - ipsec-configuration-id
58386 ipsec-configuration-id:
58388 description: UUID of this configuration
58389 requested-vig-address-type:
58391 description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
58392 requested-encryption-strength:
58394 description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
58395 requested-dmz-type:
58397 description: can offer a shared DMZ or a DMZ specific to a customer
58398 shared-dmz-network-address:
58400 description: Network address of shared DMZ
58401 requested-customer-name:
58403 description: If the DMZ is a custom DMZ, this field will indicate the customer information
58406 description: can be 1 or 2
58407 ikev1-authentication:
58409 description: Contains values like md5, sha1, sha256, sha384
58412 description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
58415 description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
58418 description: Group name defined in VIG for clients using aggressive mode
58421 description: pre-shared key for the above group name
58424 description: Lifetime for IKEv1 SA
58425 ipsec-authentication:
58427 description: md5, sha1, sha256, sha384
58430 description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
58433 description: Life time for IPSec SA
58436 description: enable PFS or not
58439 description: user ID for xAuth, sm-user, ,nmteHostName
58440 xauth-user-password:
58442 description: Encrypted using the Juniper $9$ algorithm
58445 description: The time between DPD probe
58448 description: Maximum number of DPD before claiming the tunnel is down
58451 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58455 $ref: "#/getDefinitions/relationship"
58459 $ref: "#/getDefinitions/vig-server"
58460 ipsec-configurations:
58462 ipsec-configuration:
58465 $ref: "#/getDefinitions/ipsec-configuration"
58474 Logical interfaces, e.g., a vnic.
58475 ###### Related Nodes
58476 - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58477 - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
58478 - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
58479 - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
58480 - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
58481 - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
58482 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
58483 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
58484 - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
58485 - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
58486 - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
58487 - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
58493 description: Name given to the interface
58496 description: E.g., CUSTOMER, UPLINK, etc.
58499 description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
58502 description: URL to endpoint where AAI can get more details
58505 description: ID of interface
58508 description: MAC address for the interface
58511 description: Name of the network
58514 description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
58515 interface-description:
58517 description: Human friendly text regarding this interface.
58520 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58524 $ref: "#/getDefinitions/vlan"
58528 $ref: "#/getDefinitions/sriov-vf"
58532 $ref: "#/getDefinitions/relationship"
58533 l3-interface-ipv4-address-list:
58536 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
58537 l3-interface-ipv6-address-list:
58540 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
58543 Collection of logical interfaces.
58548 $ref: "#/getDefinitions/l-interface"
58549 l3-interface-ipv4-address-list:
58552 ###### Related Nodes
58553 - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
58554 - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
58555 - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
58556 - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
58558 - l3-interface-ipv4-address
58560 l3-interface-ipv4-address:
58562 description: IP address
58563 l3-interface-ipv4-prefix-length:
58566 description: Prefix length, 32 for single address
58570 description: Inner VLAN tag
58574 description: Outer VLAN tag
58577 description: Indicator of fixed or floating address
58580 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58581 neutron-network-id:
58583 description: Neutron network id of the interface that address belongs to
58586 description: Neutron id of subnet that address belongs to
58590 $ref: "#/getDefinitions/relationship"
58591 l3-interface-ipv6-address-list:
58594 ###### Related Nodes
58595 - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
58596 - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
58597 - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
58598 - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
58600 - l3-interface-ipv6-address
58602 l3-interface-ipv6-address:
58604 description: IP address
58605 l3-interface-ipv6-prefix-length:
58608 description: Prefix length, 128 for single address
58612 description: Inner VLAN tag
58616 description: Outer VLAN tag
58619 description: Indicator of fixed or floating address
58622 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58623 neutron-network-id:
58625 description: Neutron network id of the interface that address belongs to
58628 description: Neutron id of subnet that address belongs to
58632 $ref: "#/getDefinitions/relationship"
58635 Generic network definition
58636 ###### Related Nodes
58637 - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
58638 - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
58639 - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
58640 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
58641 - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
58642 - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
58643 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
58644 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
58645 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
58646 - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
58647 - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
58648 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
58649 - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
58650 - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
58651 - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
58652 - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
58657 - is-provider-network
58658 - is-shared-network
58659 - is-external-network
58663 description: Network ID, should be uuid. Unique across A&AI.
58666 description: Name of the network, governed by some naming convention..
58669 description: Type of the network - who defines these values?
58672 description: Role the network plans - who defines these values?
58673 network-technology:
58675 description: Network technology - who defines these values?
58676 neutron-network-id:
58678 description: Neutron network id of this Interface
58683 description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
58684 network-role-instance:
58687 description: network role instance
58690 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58691 orchestration-status:
58693 description: Orchestration status of this VNF, mastered by MSO
58696 description: Heat stack id corresponding to this instance, managed by MSO
58699 description: Corresponds to the SDN-C catalog id used to configure this VCE
58700 contrail-network-fqdn:
58702 description: Contrail FQDN for the network
58705 description: the ASDC model id for this resource or service model.
58706 persona-model-version:
58708 description: the ASDC model version for this resource or service model.
58711 description: the ASDC model version for this resource or service model.
58712 persona-model-customization-id:
58714 description: captures the id of all the configuration used to customize the resource for the service.
58717 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
58718 widget-model-version:
58720 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
58721 physical-network-name:
58723 description: Name associated with the physical network.
58724 is-provider-network:
58728 is-external-network:
58732 description: Path to the controller object.
58736 $ref: "#/getDefinitions/subnet"
58740 $ref: "#/getDefinitions/ctag-assignment"
58741 segmentation-assignments:
58744 $ref: "#/getDefinitions/segmentation-assignment"
58748 $ref: "#/getDefinitions/relationship"
58749 description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
58755 $ref: "#/getDefinitions/l3-network"
58758 Link aggregate interface
58759 ###### Related Nodes
58760 - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58761 - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
58762 - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
58763 - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
58764 - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
58765 - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
58766 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
58767 - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
58768 - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK
58774 description: Name that identifies the link aggregate interface
58775 interface-description:
58777 description: Human friendly text regarding this interface.
58780 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58783 description: Captures the numeric part of the speed
58786 description: Captures the units corresponding to the speed
58789 description: ID of interface
58792 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
58795 description: Trigger for operational monitoring of this resource by Service Assurance systems.
58799 $ref: "#/getDefinitions/relationship"
58803 $ref: "#/getDefinitions/l-interface"
58806 Collection of link aggregate interfaces.
58811 $ref: "#/getDefinitions/lag-interface"
58814 LAG links can connect lag-interfaces
58815 ###### Related Nodes
58816 - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
58817 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
58823 description: Alphabetical concatenation of lag-interface names
58826 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58830 $ref: "#/getDefinitions/relationship"
58833 Collection of link aggregation connections
58838 $ref: "#/getDefinitions/lag-link"
58841 Metadata for license group.
58842 ###### Related Nodes
58843 - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58844 - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
58851 description: Unique ID for the license group the resource belongs to, should be uuid.
58854 description: Unique ID of a license resource.
58857 description: Concurrency value
58861 $ref: "#/getDefinitions/relationship"
58864 Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
58869 $ref: "#/getDefinitions/license"
58872 describes a line-of-business
58873 ###### Related Nodes
58874 - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
58876 - line-of-business-name
58878 line-of-business-name:
58880 description: Name of the line-of-business (product)
58883 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58887 $ref: "#/getDefinitions/relationship"
58890 Collection of lines-of-business
58895 $ref: "#/getDefinitions/line-of-business"
58898 Logical links generally connect l-interfaces but are used to express logical connectivity between two points
58899 ###### Related Nodes
58900 - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
58901 - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
58902 - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
58903 - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
58904 - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
58905 - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
58906 - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
58907 - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
58908 - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
58909 - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
58910 - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
58911 - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
58912 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
58919 description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
58922 description: Type of logical link, e.g., evc
58925 description: Captures the numeric part of the speed
58928 description: Captures the units corresponding to the speed
58931 description: v4, v6, or ds for dual stack
58934 description: For example, static or BGP
58937 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58940 description: the ASDC model id for this resource or service model.
58941 persona-model-version:
58943 description: the ASDC model version for this resource or service model.
58946 description: the ASDC model version for this resource or service model.
58949 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
58950 widget-model-version:
58952 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
58953 operational-status:
58955 description: Indication of operational status of the logical link.
58958 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
58961 description: Indication of the network use of the logical link.
58964 description: Alias or alternate name (CLCI or D1 name).
58967 description: UUID of the logical-link, SDNC generates this.
58970 description: Circuit id
58973 description: Reason for this entity, role it is playing
58977 $ref: "#/getDefinitions/relationship"
58980 Collection of logical connections
58985 $ref: "#/getDefinitions/logical-link"
58988 Collection of metadatum (key/value pairs)
58993 $ref: "#/getDefinitions/metadatum"
58997 ###### Related Nodes
58998 - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
58999 - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
59000 - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
59001 - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
59012 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59015 Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
59016 ###### Related Nodes
59017 - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
59018 - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
59019 - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
59020 - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
59021 - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
59022 - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
59023 - MODEL is DELETED when these are DELETED MODEL-VER
59025 - model-invariant-id
59028 model-invariant-id:
59030 description: Unique identifier corresponding to the main definition of a model in ASDC
59033 description: Type of the model, e.g., service, resource, widget, etc.
59036 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59040 $ref: "#/getDefinitions/model-ver"
59044 $ref: "#/getDefinitions/relationship"
59045 model-and-named-query-search:
59047 ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
59051 $ref: "#/getDefinitions/query-parameters"
59054 $ref: "#/getDefinitions/instance-filters"
59057 $ref: "#/getDefinitions/secondary-filts"
59060 secondary-filter-cut-point:
59064 This is how we would capture constraints defining allowed sets of elements.
59065 ###### Related Nodes
59066 - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
59067 - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
59068 - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
59070 - model-constraint-uuid
59071 - constrained-element-set-uuid-to-replace
59073 model-constraint-uuid:
59075 constrained-element-set-uuid-to-replace:
59077 constrained-element-sets:
59080 $ref: "#/getDefinitions/constrained-element-set"
59083 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59089 $ref: "#/getDefinitions/model-constraint"
59092 Defines how other models combine to make up a higher-level model.
59093 ###### Related Nodes
59094 - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
59095 - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
59096 - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
59097 - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
59098 - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
59099 - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
59100 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
59101 - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
59103 - model-element-uuid
59104 - new-data-del-flag
59107 model-element-uuid:
59111 description: Indicates whether this element was created as part of instantiation from this model
59114 description: How many of this type of element are required/allowed
59119 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59123 $ref: "#/getDefinitions/model-element"
59124 description: Defines how other models combine to make up a higher-level model
59128 $ref: "#/getDefinitions/model-constraint"
59129 description: Describes new constraints on this model element that are not part of that model's definition
59133 $ref: "#/getDefinitions/relationship"
59139 $ref: "#/getDefinitions/model-element"
59142 Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
59143 ###### Related Nodes
59144 - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
59145 - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
59146 - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
59147 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
59148 - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
59149 - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
59157 description: Unique identifier corresponding to one version of a model in ASDC
59160 description: Name of the model, which can change from version to version.
59163 description: Version
59166 description: Description
59169 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59173 $ref: "#/getDefinitions/model-element"
59177 $ref: "#/getDefinitions/metadatum"
59181 $ref: "#/getDefinitions/relationship"
59187 $ref: "#/getDefinitions/model-ver"
59190 Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
59195 $ref: "#/getDefinitions/model"
59196 multicast-configuration:
59198 ###### Related Nodes
59199 - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
59201 - multicast-configuration-id
59202 - multicast-protocol
59205 multicast-configuration-id:
59207 description: Unique id of multicast configuration.
59208 multicast-protocol:
59210 description: protocol of multicast configuration
59213 description: rp type of multicast configuration
59216 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59220 $ref: "#/getDefinitions/relationship"
59221 multicast-configurations:
59223 multicast configuration of generic-vnf ip-address
59225 multicast-configuration:
59228 $ref: "#/getDefinitions/multicast-configuration"
59234 $ref: "#/getDefinitions/named-query"
59238 ###### Related Nodes
59239 - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
59240 - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
59241 - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
59242 - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
59246 - named-query-version
59252 named-query-version:
59254 required-input-param:
59260 named-query-elements:
59263 $ref: "#/getDefinitions/named-query-element"
59267 $ref: "#/getDefinitions/relationship"
59268 named-query-element:
59271 ###### Related Nodes
59272 - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
59273 - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
59274 - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
59275 - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
59276 - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
59277 - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
59278 - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
59280 - named-query-element-uuid
59282 named-query-element-uuid:
59284 property-collect-list:
59288 property-limit-desc:
59292 named-query-elements:
59295 $ref: "#/getDefinitions/named-query-element"
59299 $ref: "#/getDefinitions/related-lookup"
59300 property-constraints:
59303 $ref: "#/getDefinitions/property-constraint"
59307 $ref: "#/getDefinitions/relationship"
59308 named-query-elements:
59310 named-query-element:
59313 $ref: "#/getDefinitions/named-query-element"
59316 Namespace for network inventory resources.
59321 $ref: "#/getDefinitions/logical-link"
59325 $ref: "#/getDefinitions/site-pair-set"
59329 $ref: "#/getDefinitions/vpn-binding"
59333 $ref: "#/getDefinitions/vpls-pe"
59334 multicast-configurations:
59337 $ref: "#/getDefinitions/multicast-configuration"
59341 $ref: "#/getDefinitions/vce"
59345 $ref: "#/getDefinitions/vnfc"
59349 $ref: "#/getDefinitions/l3-network"
59353 $ref: "#/getDefinitions/network-policy"
59357 $ref: "#/getDefinitions/generic-vnf"
59361 $ref: "#/getDefinitions/lag-link"
59365 $ref: "#/getDefinitions/newvce"
59369 $ref: "#/getDefinitions/pnf"
59373 $ref: "#/getDefinitions/physical-link"
59374 ipsec-configurations:
59377 $ref: "#/getDefinitions/ipsec-configuration"
59378 route-table-references:
59381 $ref: "#/getDefinitions/route-table-reference"
59385 $ref: "#/getDefinitions/instance-group"
59389 $ref: "#/getDefinitions/zone"
59395 $ref: "#/getDefinitions/network-policy"
59398 ###### Related Nodes
59399 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
59401 - network-policy-id
59405 description: UUID representing unique key to this instance
59406 network-policy-fqdn:
59408 description: Contrail FQDN for the policy
59411 description: ID for the openStack Heat instance
59414 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59418 $ref: "#/getDefinitions/relationship"
59421 Network profile populated by SDN-GP for SNMP
59422 ###### Related Nodes
59423 - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
59429 description: Unique name of network profile.
59432 description: Encrypted SNMP community string
59435 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59439 $ref: "#/getDefinitions/relationship"
59442 Collection of network profiles
59447 $ref: "#/getDefinitions/network-profile"
59450 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
59451 ###### Related Nodes
59452 - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
59453 - NEWVCE is DELETED when these are DELETED L-INTERFACE
59461 description: Unique id of VNF, can't use same attribute name right now until we promote this new object
59464 description: Name of VNF.
59467 description: Alternate name of VNF.
59470 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
59473 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
59476 description: Indicator for whether the resource is considered operational
59479 description: OBSOLETE - do not use
59482 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
59485 description: Client should send valid enumerated value.
59488 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59489 ipv4-loopback0-address:
59491 description: v4 Loopback0 address
59492 orchestration-status:
59494 description: Orchestration status of this VNF, mastered by MSO.
59497 description: Heat stack id corresponding to this instance, managed by MSO
59500 description: Corresponds to the SDN-C catalog id used to configure this VCE
59504 $ref: "#/getDefinitions/relationship"
59508 $ref: "#/getDefinitions/l-interface"
59511 This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
59516 $ref: "#/getDefinitions/newvce"
59517 notification-event:
59521 notification-event-header:
59523 $ref: "#/getDefinitions/notification-event-header"
59524 notification-event-header:
59565 $ref: "#/getDefinitions/key-data"
59570 OAM network, to be deprecated shortly. Do not use for new purposes.
59571 ###### Related Nodes
59572 - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59573 - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
59574 - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
59582 description: UUID of the network. Unique across a cloud-region
59585 description: Name of the network.
59589 description: cvlan-id
59590 ipv4-oam-gateway-address:
59592 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
59593 ipv4-oam-gateway-address-prefix-length:
59596 description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
59599 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59603 $ref: "#/getDefinitions/relationship"
59606 Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
59611 $ref: "#/getDefinitions/oam-network"
59612 operational-environment:
59614 It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
59615 ###### Related Nodes
59616 - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
59617 - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
59619 - operational-environment-id
59620 - operational-environment-name
59621 - operational-environment-type
59622 - operational-environment-status
59626 operational-environment-id:
59628 description: UUID of an operational environment
59629 operational-environment-name:
59631 description: Operational Environment name
59632 operational-environment-type:
59634 description: Operational Environment Type.
59635 operational-environment-status:
59637 description: Status
59640 description: Tenant Context.
59643 description: Workload Context.
59646 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59650 $ref: "#/getDefinitions/relationship"
59651 operational-environments:
59653 a logical partition of the cloud which allows to have multiple environments in the production AIC.
59655 operational-environment:
59658 $ref: "#/getDefinitions/operational-environment"
59661 Allows for legacy POST of old-style and new-style models
59663 - model-invariant-id
59664 - model-name-version-id
59670 model-invariant-id:
59672 description: Unique identifier corresponding to the main definition of a model in ASDC
59673 model-name-version-id:
59675 description: Unique identifier corresponding to one version of a model in ASDC
59678 description: Type of the model, e.g., service, resource, widget, etc.
59681 description: Name of the model, which can change from version to version.
59684 description: Invariant unique ID which does not change from version to version
59687 description: Version
59690 description: Description
59693 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59696 $ref: "#/getDefinitions/model-vers"
59699 $ref: "#/getDefinitions/relationship-list"
59702 Collection of owning-entities
59707 $ref: "#/getDefinitions/owning-entity"
59710 describes an owning-entity
59711 ###### Related Nodes
59712 - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
59715 - owning-entity-name
59719 description: UUID of an owning entity
59720 owning-entity-name:
59722 description: Owning entity name
59725 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59729 $ref: "#/getDefinitions/relationship"
59732 Physical interface (e.g., nic)
59733 ###### Related Nodes
59734 - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
59735 - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
59736 - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
59737 - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
59738 - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
59739 - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
59740 - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
59741 - P-INTERFACE is DELETED when these are DELETED L-INTERFACE
59742 - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
59748 description: Name that identifies the physical interface
59751 description: Captures the numeric part of the speed
59754 description: Captures the units corresponding to the speed
59757 description: Nature of the services and connectivity on this port.
59758 equipment-identifier:
59760 description: CLEI or other specification for p-interface hardware.
59763 description: Role specification for p-interface hardware.
59766 description: Indicates the physical properties of the interface.
59769 description: Trigger for operational monitoring of this resource by Service Assurance systems.
59772 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59776 $ref: "#/getDefinitions/relationship"
59780 $ref: "#/getDefinitions/l-interface"
59783 Collection of physical interfaces.
59788 $ref: "#/getDefinitions/p-interface"
59791 Collection of physical connections, typically between p-interfaces
59792 ###### Related Nodes
59793 - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
59799 description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
59802 description: Captures the numeric part of the speed
59805 description: Captures the units corresponding to the speed
59808 description: Circuit it
59811 description: Dual access mode (e.g., primary, secondary
59814 description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
59815 service-provider-name:
59817 description: Name of the service Provider on this link.
59820 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59824 $ref: "#/getDefinitions/relationship"
59827 Collection of physical connections, typically between p-interfaces
59832 $ref: "#/getDefinitions/physical-link"
59835 describes a platform
59836 ###### Related Nodes
59837 - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
59843 description: Name of the platform
59846 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59850 $ref: "#/getDefinitions/relationship"
59853 Collection of platforms
59858 $ref: "#/getDefinitions/platform"
59861 PNF represents a physical network function. typically equipment used in the D1 world.
59862 ###### Related Nodes
59863 - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
59864 - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59865 - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
59866 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
59867 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
59868 - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
59869 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
59870 - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
59877 description: unique name of Physical Network Function.
59880 description: name of Physical Network Function.
59883 description: source of name2
59886 description: id of pnf
59889 description: Equipment type. Source of truth should define valid values.
59892 description: Equipment vendor. Source of truth should define valid values.
59895 description: Equipment model. Source of truth should define valid values.
59898 description: identifier of managed by company or customer
59901 description: ipv4-oam-address with new naming convention for IP addresses
59904 description: sw-version is the version of SW for the hosted application on the PNF.
59909 description: ID of the physical frame (relay rack) where pnf is installed.
59912 description: Serial number of the device
59913 ipaddress-v4-loopback-0:
59915 description: IPV4 Loopback 0 address
59916 ipaddress-v6-loopback-0:
59918 description: IPV6 Loopback 0 address
59921 description: IPV4 AIM address
59924 description: IPV6 AIM address
59927 description: IPV6 OAM address
59930 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
59933 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59936 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
59939 description: Nf Role is the role performed by this instance in the network.
59943 $ref: "#/getDefinitions/relationship"
59947 $ref: "#/getDefinitions/p-interface"
59951 $ref: "#/getDefinitions/lag-interface"
59954 Collection of Physical Network Functions.
59959 $ref: "#/getDefinitions/pnf"
59962 Used to capture the network interfaces of this VCE
59963 ###### Related Nodes
59964 - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
59965 - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
59966 - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
59969 - orchestration-status
59973 description: Unique ID of the interface
59974 neutron-network-id:
59976 description: Neutron network id of this Interface
59977 neutron-network-name:
59979 description: Neutron network name of this Interface
59982 description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
59985 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
59988 description: Unique ID for port group in vmware
59991 description: Likely to duplicate value of neutron network name
59994 description: DVS or standard switch name (should be non-null for port groups associated with DVS)
59995 orchestration-status:
59997 description: Orchestration status of this VNF, mastered by MSO
60000 description: Heat stack id corresponding to this instance, managed by MSO
60003 description: Corresponds to the SDN-C catalog id used to configure this VCE
60007 $ref: "#/getDefinitions/cvlan-tag-entry"
60011 $ref: "#/getDefinitions/relationship"
60017 $ref: "#/getDefinitions/port-group"
60020 describes the project
60021 ###### Related Nodes
60022 - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
60028 description: Name of the project deploying a service
60031 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60035 $ref: "#/getDefinitions/relationship"
60038 Collection of projects
60043 $ref: "#/getDefinitions/project"
60046 Property holder for query properties or instance properties
60052 property-constraint:
60055 ###### Related Nodes
60056 - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
60058 - property-constraint-uuid
60063 property-constraint-uuid:
60073 property-constraints:
60075 property-constraint:
60078 $ref: "#/getDefinitions/property-constraint"
60081 Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
60082 ###### Related Nodes
60083 - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
60084 - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
60085 - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
60086 - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
60087 - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
60088 - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
60089 - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
60090 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
60091 - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
60092 - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
60093 - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
60094 - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
60095 - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
60102 description: Value from executing hostname on the compute node.
60105 description: PTNII name
60109 description: Number of cpus
60113 description: Disk size, in GBs
60117 description: RAM size, in MBs
60120 description: Equipment type. Source of truth should define valid values.
60123 description: Equipment vendor. Source of truth should define valid values.
60126 description: Equipment model. Source of truth should define valid values.
60129 description: Fully-qualified domain name
60132 description: URL to endpoint where AAI can get more details
60135 description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
60138 description: Serial number, may be queried
60139 ipaddress-v4-loopback-0:
60141 description: IPV4 Loopback 0 address
60142 ipaddress-v6-loopback-0:
60144 description: IPV6 Loopback 0 address
60147 description: IPV4 AIM address
60150 description: IPV6 AIM address
60153 description: IPV6 OAM address
60156 description: CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
60159 description: ID of Pserver
60162 description: internet topology of Pserver
60167 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60170 description: alternative pserver name
60173 description: purpose of pserver
60176 description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
60180 $ref: "#/getDefinitions/relationship"
60184 $ref: "#/getDefinitions/p-interface"
60188 $ref: "#/getDefinitions/lag-interface"
60191 Collection of compute hosts.
60196 $ref: "#/getDefinitions/pserver"
60199 QueryParameters for performing a named-query or model query
60203 $ref: "#/getDefinitions/named-query"
60206 $ref: "#/getDefinitions/overloaded-model"
60210 ###### Related Nodes
60211 - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
60213 - related-lookup-uuid
60215 - source-node-property
60217 - target-node-property
60219 related-lookup-uuid:
60223 source-node-property:
60227 target-node-property:
60229 property-collect-list:
60236 $ref: "#/getDefinitions/relationship"
60242 $ref: "#/getDefinitions/related-lookup"
60243 related-to-property:
60247 description: Key part of a key/value pair
60250 description: Value part of a key/value pair
60255 description: A keyword provided by A&AI to indicate type of node.
60258 description: URL to the object in A&AI.
60262 $ref: "#/getDefinitions/relationship-data"
60263 related-to-property:
60266 $ref: "#/getDefinitions/related-to-property"
60270 - relationship-value
60274 description: A keyword provided by A&AI to indicate an attribute.
60275 relationship-value:
60277 description: Value of the attribute.
60283 $ref: "#/getDefinitions/relationship"
60284 reserved-prop-names:
60286 Internal map to define some reserved properties of a vertex
60288 last-mod-source-of-truth:
60306 Response container for the results of a named-query or model query
60308 inventory-response-items:
60310 $ref: "#/getDefinitions/inventory-response-items"
60315 description: The specific type of node in the A&AI graph
60318 description: The URL to the specific resource
60319 route-table-reference:
60321 Openstack route table reference.
60322 ###### Related Nodes
60323 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
60325 - route-table-reference-id
60326 - route-table-reference-fqdn
60328 route-table-reference-id:
60330 description: Route Table Reference id, UUID assigned to this instance.
60331 route-table-reference-fqdn:
60333 description: FQDN entry in the route table.
60336 description: Concurrency value
60340 $ref: "#/getDefinitions/relationship"
60341 route-table-references:
60343 Collection of openstack route table references
60345 route-table-reference:
60348 $ref: "#/getDefinitions/route-table-reference"
60351 Route target information
60352 ###### Related Nodes
60353 - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
60355 - global-route-target
60356 - route-target-role
60358 global-route-target:
60360 description: Number used to identify an RT, globally unique in the network
60363 description: Role assigned to this route target
60366 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60370 $ref: "#/getDefinitions/relationship"
60373 Collection of route target information
60378 $ref: "#/getDefinitions/route-target"
60381 ###### Related Nodes
60382 - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
60383 - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
60384 - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
60386 - routing-instance-id
60388 routing-instance-id:
60390 description: Unique id of routing instance
60393 description: rpm owner
60396 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60400 $ref: "#/getDefinitions/site-pair"
60404 $ref: "#/getDefinitions/relationship"
60407 set of probes related to generic-vnf routing instance
60412 $ref: "#/getDefinitions/routing-instance"
60417 $ref: "#/getDefinitions/oam-networks"
60418 az-and-dvs-switches:
60421 $ref: "#/getDefinitions/az-and-dvs-switches"
60424 edge-tag-query-result:
60426 $ref: "#/getDefinitions/edge-tag-query-result"
60427 edge-tag-query-request:
60429 $ref: "#/getDefinitions/edge-tag-query-request"
60432 $ref: "#/getDefinitions/search-results"
60435 $ref: "#/getDefinitions/sdn-zone-response"
60441 $ref: "#/getDefinitions/result-data"
60444 SecondaryFilt for performing a named-query or model query
60455 SecondaryFilts for performing a named-query or model query
60460 $ref: "#/getDefinitions/secondary-filt"
60461 segmentation-assignment:
60463 Openstack segmentation assignment.
60464 ###### Related Nodes
60465 - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
60471 description: Route Table Reference id, UUID assigned to this instance.
60474 description: Concurrency value
60478 $ref: "#/getDefinitions/relationship"
60479 segmentation-assignments:
60481 Collection of openstack segmentation assignments
60483 segmentation-assignment:
60486 $ref: "#/getDefinitions/segmentation-assignment"
60489 Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
60492 - service-description
60496 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
60497 service-description:
60499 description: Description of the service
60502 description: URL to endpoint where AAI can get more details
60505 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60508 description: service version
60512 $ref: "#/getDefinitions/relationship"
60513 service-capabilities:
60515 Collection of service capabilities.
60517 service-capability:
60520 $ref: "#/getDefinitions/service-capability"
60521 service-capability:
60523 Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
60524 ###### Related Nodes
60525 - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
60526 - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
60527 - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
60534 description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
60537 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
60540 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60544 $ref: "#/getDefinitions/relationship"
60545 service-design-and-creation:
60547 Namespace for objects managed by ASDC
60552 $ref: "#/getDefinitions/vnf-image"
60556 $ref: "#/getDefinitions/service"
60557 service-capabilities:
60560 $ref: "#/getDefinitions/service-capability"
60564 $ref: "#/getDefinitions/model"
60568 $ref: "#/getDefinitions/named-query"
60571 Instance of a service
60572 ###### Related Nodes
60573 - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
60574 - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
60575 - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
60576 - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
60577 - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
60578 - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
60579 - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
60580 - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
60581 - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
60582 - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
60583 - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
60584 - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
60585 - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
60586 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
60587 - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
60588 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
60589 - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM
60590 - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
60592 - service-instance-id
60594 service-instance-id:
60596 description: Uniquely identifies this instance of a service
60597 service-instance-name:
60599 description: This field will store a name assigned to the service-instance.
60602 description: the ASDC model id for this resource or service model.
60603 persona-model-version:
60605 description: the ASDC model version for this resource or service model.
60608 description: the ASDC model version for this resource or service model.
60611 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
60612 widget-model-version:
60614 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
60617 description: Indicates the total bandwidth to be used for this service.
60620 description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
60621 bandwidth-down-wan1:
60623 description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
60626 description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
60627 bandwidth-down-wan2:
60629 description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
60632 description: URL customers will use to access the vHN Portal.
60633 service-instance-location-id:
60635 description: An identifier that customers assign to the location where this service is being used.
60638 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60641 description: Path to the controller object.
60642 orchestration-status:
60644 description: Orchestration status of this service.
60648 $ref: "#/getDefinitions/relationship"
60652 $ref: "#/getDefinitions/metadatum"
60653 allotted-resources:
60656 $ref: "#/getDefinitions/allotted-resource"
60659 Collection of service instances
60664 $ref: "#/getDefinitions/service-instance"
60665 service-subscription:
60667 Object that group service instances.
60668 ###### Related Nodes
60669 - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
60670 - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
60671 - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
60672 - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
60678 description: Value defined by orchestration to identify this service across ECOMP.
60679 temp-ub-sub-account-id:
60681 description: This property will be deleted from A&AI in the near future. Only stop gap solution.
60684 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60688 $ref: "#/getDefinitions/service-instance"
60692 $ref: "#/getDefinitions/relationship"
60693 service-subscriptions:
60695 Collection of objects that group service instances.
60697 service-subscription:
60700 $ref: "#/getDefinitions/service-subscription"
60703 Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
60708 $ref: "#/getDefinitions/service"
60711 ###### Related Nodes
60712 - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
60713 - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
60714 - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
60720 description: unique identifier of probe
60723 description: Prefix address
60726 description: Prefix address
60729 description: ip version, v4, v6
60730 destination-hostname:
60732 description: Hostname of the destination equipment to which SLAs are measured against.
60733 destination-equip-type:
60735 description: The type of destinatination equipment. Could be Router, etc.
60738 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60739 classes-of-service:
60742 $ref: "#/getDefinitions/class-of-service"
60746 $ref: "#/getDefinitions/relationship"
60749 Set of instances for probes used to measure service level agreements
60750 ###### Related Nodes
60751 - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
60752 - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
60753 - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
60759 description: Unique id of site pair set.
60762 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60766 $ref: "#/getDefinitions/routing-instance"
60770 $ref: "#/getDefinitions/relationship"
60773 Collection of sets of instances for probes related to generic-vnf
60778 $ref: "#/getDefinitions/site-pair-set"
60786 $ref: "#/getDefinitions/site-pair"
60790 ###### Related Nodes
60791 - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60792 - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
60798 description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
60801 description: Snapshot name
60802 snapshot-architecture:
60804 description: Operating system architecture
60805 snapshot-os-distro:
60807 description: The common name of the operating system distribution in lowercase
60808 snapshot-os-version:
60810 description: The operating system version as specified by the distributor.
60813 description: The application that the image instantiates.
60814 application-vendor:
60816 description: The vendor of the application.
60817 application-version:
60819 description: The version of the application.
60822 description: URL to endpoint where AAI can get more details
60825 description: This field contains the UUID of the previous snapshot (if any).
60828 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60832 $ref: "#/getDefinitions/relationship"
60835 Collection of openstack snapshots
60840 $ref: "#/getDefinitions/snapshot"
60843 SR-IOV Physical Function
60844 ###### Related Nodes
60845 - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
60846 - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
60852 description: Identifier for the sriov-pf
60855 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60859 $ref: "#/getDefinitions/relationship"
60862 Collection of SR-IOV Physical Functions.
60867 $ref: "#/getDefinitions/sriov-pf"
60870 SR-IOV Virtual Function (not to be confused with virtual network function)
60871 ###### Related Nodes
60872 - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
60878 description: PCI ID used to identify the sriov-vf
60881 description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
60884 description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
60887 description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
60888 vf-vlan-anti-spoof-check:
60890 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.
60891 vf-mac-anti-spoof-check:
60893 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.
60896 description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
60897 vf-broadcast-allow:
60899 description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
60900 vf-unknown-multicast-allow:
60902 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
60903 vf-unknown-unicast-allow:
60905 description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
60908 description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
60911 description: This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
60914 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60915 neutron-network-id:
60917 description: Neutron network id of the interface
60921 $ref: "#/getDefinitions/relationship"
60924 Collection of SR-IOV Virtual Functions.
60929 $ref: "#/getDefinitions/sriov-vf"
60938 ###### Related Nodes
60939 - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
60940 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
60941 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
60942 - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
60949 description: Subnet ID, should be UUID.
60952 description: Name associated with the subnet.
60955 description: Neutron id of this subnet
60958 description: gateway ip address
60959 network-start-address:
60961 description: network start address
60964 description: cidr mask
60967 description: ip version
60968 orchestration-status:
60970 description: Orchestration status of this VNF, mastered by MSO
60975 description: the start address reserved for use by dhcp
60978 description: the last address reserved for use by dhcp
60981 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
60985 $ref: "#/getDefinitions/relationship"
60991 $ref: "#/getDefinitions/subnet"
60992 tagged-inventory-item-list:
60997 $ref: "#/getDefinitions/inventory-item"
61001 ###### Related Nodes
61002 - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
61003 - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
61004 - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
61005 - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
61006 - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
61007 - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
61008 - TENANT cannot be deleted if linked to VSERVER
61015 description: Unique id relative to the cloud-region.
61018 description: Readable name of tenant
61021 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61025 $ref: "#/getDefinitions/vserver"
61029 $ref: "#/getDefinitions/relationship"
61032 Collection of openstack tenants.
61037 $ref: "#/getDefinitions/tenant"
61040 Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
61041 ###### Related Nodes
61042 - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
61045 - bandwidth-up-wan1
61046 - bandwidth-down-wan1
61047 - bandwidth-up-wan2
61048 - bandwidth-down-wan2
61052 description: Allotted Resource id UUID assigned to this instance.
61055 description: The WAN uplink bandwidth for WAN1
61056 bandwidth-down-wan1:
61058 description: The WAN downlink bandwidth for WAN1
61061 description: The WAN uplink bandwidth for WAN2
61062 bandwidth-down-wan2:
61064 description: The WAN downlink bandwidth for WAN2
61067 description: Concurrency value
61071 $ref: "#/getDefinitions/relationship"
61074 This object is used to store the specific tunnel cross connect aspects of an allotted resource
61079 $ref: "#/getDefinitions/tunnel-xconnect"
61082 Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
61091 $ref: "#/getDefinitions/update-node-key"
61097 $ref: "#/getDefinitions/action"
61106 Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
61107 ###### Related Nodes
61108 - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
61109 - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
61110 - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
61111 - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
61112 - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
61113 - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
61114 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
61115 - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
61123 description: Unique id of VNF. This is unique across the graph.
61126 description: Name of VNF.
61129 description: Alternate name of VNF.
61132 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
61135 description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
61136 regional-resource-zone:
61138 description: Regional way of organizing pservers, source of truth should define values
61141 description: Trigger for operational monitoring of this resource by Service Assurance systems.
61144 description: Indicator for whether the resource is considered operational
61147 description: OBSOLETE - do not use
61150 description: Network role being played by this VNF
61151 orchestration-status:
61153 description: Orchestration status of this VNF, mastered by MSO
61156 description: Heat stack id corresponding to this instance, managed by MSO
61159 description: Corresponds to the SDN-C catalog id used to configure this VCE
61162 description: Unique ID of VPE connected to this VCE.
61163 v6-vce-wan-address:
61165 description: Valid v6 IP address for the WAN Link on this router. Implied length of /64.
61168 description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
61171 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61172 ipv4-loopback0-address:
61174 description: Loopback0 address
61175 entitlement-resource-uuid:
61177 description: OBSOLETE - see child relationships
61181 $ref: "#/getDefinitions/port-group"
61185 $ref: "#/getDefinitions/license"
61189 $ref: "#/getDefinitions/entitlement"
61193 $ref: "#/getDefinitions/relationship"
61196 Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
61201 $ref: "#/getDefinitions/vce"
61204 a deployment unit of VNFCs
61205 ###### Related Nodes
61206 - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
61207 - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
61208 - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
61209 - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
61210 - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
61211 - VF-MODULE cannot be deleted if linked to VNFC
61214 - is-base-vf-module
61218 description: Unique ID of vf-module.
61221 description: Name of vf-module
61224 description: Heat stack id corresponding to this instance.
61225 orchestration-status:
61227 description: orchestration status of this vf-module, mastered by MSO
61232 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61235 description: the ASDC model id for this resource or service model.
61236 persona-model-version:
61238 description: the ASDC model version for this resource or service model.
61241 description: the ASDC model version for this resource or service model.
61242 persona-model-customization-id:
61244 description: captures the id of all the configuration used to customize the resource for the service.
61247 description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
61248 widget-model-version:
61250 description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
61251 contrail-service-instance-fqdn:
61253 description: the Contrail unique ID for a service-instance
61257 description: the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit
61260 description: Path to the controller object.
61264 $ref: "#/getDefinitions/relationship"
61267 Collection of vf-modules, a deployment unit of VNFCs
61272 $ref: "#/getDefinitions/vf-module"
61275 vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
61276 ###### Related Nodes
61277 - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
61283 description: indicates whether the VIG is for AVPN or INTERNET
61286 description: v4 IP of the vig server
61289 description: v6 IP of the vig server
61292 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61296 $ref: "#/getDefinitions/relationship"
61302 $ref: "#/getDefinitions/vig-server"
61303 vip-ipv4-address-list:
61306 ###### Related Nodes
61307 - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
61308 - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61309 - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
61310 - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
61316 description: IP address
61317 vip-ipv4-prefix-length:
61320 description: Prefix length, 32 for single address
61324 description: Inner VLAN tag
61328 description: Outer VLAN tag
61331 description: Indicator of fixed or floating address
61334 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61335 neutron-network-id:
61337 description: Neutron network id of the interface that address belongs to
61340 description: Neutron id of subnet that address belongs to
61344 $ref: "#/getDefinitions/relationship"
61345 vip-ipv6-address-list:
61348 ###### Related Nodes
61349 - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
61350 - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61351 - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
61352 - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
61358 description: IP address
61359 vip-ipv6-prefix-length:
61362 description: Prefix length, 128 for single address
61366 description: Inner VLAN tag
61370 description: Outer VLAN tag
61373 description: Indicator of fixed or floating address
61376 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61377 neutron-network-id:
61379 description: Neutron network id of the interface that address belongs to
61382 description: Neutron id of subnet that address belongs to
61386 $ref: "#/getDefinitions/relationship"
61387 virtual-data-center:
61389 Virtual organization of cloud infrastructure elements in a data center context
61390 ###### Related Nodes
61391 - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
61392 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
61393 - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
61400 description: Unique ID of the vdc
61403 description: Name of the virtual data center
61406 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61410 $ref: "#/getDefinitions/relationship"
61411 virtual-data-centers:
61413 Virtual organization of cloud infrastructure elements in a data center context
61415 virtual-data-center:
61418 $ref: "#/getDefinitions/virtual-data-center"
61422 ###### Related Nodes
61423 - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
61424 - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
61425 - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
61426 - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
61427 - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
61428 - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
61429 - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
61430 - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
61431 - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
61437 description: String that identifies the interface
61441 description: Inner VLAN tag
61445 description: Outer VLAN tag
61448 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61451 description: Captures the numeric part of the speed
61454 description: Captures the units corresponding to the speed
61457 description: Used to describe (the service associated with) the vlan
61458 backdoor-connection:
61460 description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
61463 description: This indicates the customers VPN ID associated with this vlan
61464 orchestration-status:
61466 description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
61470 $ref: "#/getDefinitions/relationship"
61471 l3-interface-ipv4-address-list:
61474 $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
61475 l3-interface-ipv6-address-list:
61478 $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
61484 $ref: "#/getDefinitions/vlan"
61493 description: Unique id of VNF. This is unique across the graph.
61496 Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
61497 ###### Related Nodes
61498 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
61499 - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
61503 - application-vendor
61507 description: Unique ID of this asset
61510 description: The application that the image instantiates.
61511 application-vendor:
61513 description: The vendor of the application.
61514 application-version:
61516 description: The version of the application.
61519 description: URL to endpoint where AAI can get more details
61522 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61526 $ref: "#/getDefinitions/relationship"
61529 Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
61534 $ref: "#/getDefinitions/vnf-image"
61537 ###### Related Nodes
61538 - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
61539 - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
61540 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
61543 - vnfc-function-code
61546 - is-closed-loop-disabled
61550 description: Unique ID of vnfc.
61551 vnfc-function-code:
61553 description: function code
61559 description: prov status of this vnfc
61560 orchestration-status:
61562 description: Orchestration status of this VNF, mastered by APP-C
61563 ipaddress-v4-oam-vip:
61565 description: Oam V4 vip address of this vnfc
61568 is-closed-loop-disabled:
61572 description: Group notation of VNFC
61575 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61579 $ref: "#/getDefinitions/relationship"
61582 virtual network components associated with a vserver from application controller.
61587 $ref: "#/getDefinitions/vnfc"
61590 Ephemeral Block storage volume.
61591 ###### Related Nodes
61592 - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
61599 description: Unique ID of block storage volume relative to the vserver.
61602 description: URL to endpoint where AAI can get more details
61605 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61609 $ref: "#/getDefinitions/relationship"
61612 Persistent block-level storage.
61613 ###### Related Nodes
61614 - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
61615 - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
61616 - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
61617 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
61618 - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
61621 - volume-group-name
61626 description: Unique ID of volume-group.
61629 description: Name of the volume group.
61632 description: Heat stack id corresponding to this volume-group
61635 description: String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
61636 orchestration-status:
61638 description: Orchestration status of this volume-group
61639 persona-model-customization-id:
61641 description: captures the id of all the configuration used to customize the resource for the service.
61642 vf-module-persona-model-customization-id:
61644 description: helps relate the volume group to the vf-module whose components will require the volume group
61647 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61651 $ref: "#/getDefinitions/relationship"
61654 Collection of persistent block-level storage.
61659 $ref: "#/getDefinitions/volume-group"
61662 Collection of ephemeral Block storage volumes.
61667 $ref: "#/getDefinitions/volume"
61670 VPLS Provider Edge routers.
61671 ###### Related Nodes
61672 - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
61673 - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
61674 - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
61675 - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
61676 - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
61684 description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
61687 description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
61690 description: Client should send valid enumerated value, e.g., VPLS-PE.
61694 description: Temporary location for stag to get to VCE
61697 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61701 $ref: "#/getDefinitions/relationship"
61705 $ref: "#/getDefinitions/p-interface"
61709 $ref: "#/getDefinitions/lag-interface"
61712 Collection of VPLS Provider Edge routers
61717 $ref: "#/getDefinitions/vpls-pe"
61721 ###### Related Nodes
61722 - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
61723 - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
61724 - VPN-BINDING cannot be deleted if linked to L3-NETWORK,LOGICAL-LINK
61728 - global-route-target
61729 - route-target-role
61733 description: VPN ID, globally unique within A&AI
61736 description: VPN Name
61737 global-route-target:
61739 description: Number used to identify a VPN, globally unique in the network
61742 description: the platform associated with the VPN example AVPN, Mobility
61745 description: Type of the vpn, should be taken from enumerated/valid values
61746 route-distinguisher:
61748 description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
61751 description: Role assigned to this route target
61754 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61758 $ref: "#/getDefinitions/relationship"
61759 description: l3-networks relate to vpn-bindings
61765 $ref: "#/getDefinitions/vpn-binding"
61768 Virtual Servers, aka virtual machine or VM.
61769 ###### Related Nodes
61770 - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
61771 - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
61772 - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
61773 - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
61774 - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
61775 - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
61776 - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
61777 - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
61778 - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
61779 - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
61780 - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
61781 - VSERVER is DELETED when these are DELETED L-INTERFACE
61782 - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
61788 - is-closed-loop-disabled
61792 description: Unique identifier for this vserver relative to its tenant
61795 description: Name of vserver
61798 description: Alternative name of vserver
61801 description: Trigger for operational monitoring of this resource by Service Assurance systems.
61804 description: URL to endpoint where AAI can get more details
61807 is-closed-loop-disabled:
61811 description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
61815 $ref: "#/getDefinitions/volume"
61819 $ref: "#/getDefinitions/relationship"
61823 $ref: "#/getDefinitions/l-interface"
61826 Collection of virtual Servers, aka virtual machines or VMs.
61831 $ref: "#/getDefinitions/vserver"
61834 A zone is a grouping of assets in a location homing to the same connections into the CBB
61835 ###### Related Nodes
61836 - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
61837 - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
61838 - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
61839 - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
61848 description: Code assigned by AIC to the zone
61851 description: English name associated with the zone
61854 description: Design of zone [Medium/Large?]
61857 description: Context of zone [production/test]
61860 description: Status of a zone.
61863 description: Concurrency value
61867 $ref: "#/getDefinitions/relationship"
61870 Collection of zones
61875 $ref: "#/getDefinitions/zone"